Open CASCADE Technology  6.5.4
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions
Message_Msg Class Reference

This class provides a tool for constructing the parametrized message
basing on resources loaded by Message_MsgFile tool.

A Message is created from a keyword: this keyword identifies the
message in a message file that should be previously loaded by call
to Message_MsgFile::LoadFile().

The text of the message can contain placeholders for the parameters
which are to be filled by the proper values when the message
is prepared. Most of the format specifiers used in C can be used,
for instance, s for string, d for integer etc. In addition,
specifier f is supported for double numbers (for compatibility
with previous versions).

User fills the parameter fields in the text of the message by
calling corresponding methods Arg() or operators "<<".

The resulting message, filled with all parameters, can be obtained
by method Get(). If some parameters were not filled, the text
UNKNOWN is placed instead.

#include <Message_Msg.hxx>

Public Member Functions

DEFINE_STANDARD_ALLOC Message_Msg ()
 Empty constructor

 Message_Msg (const Message_Msg &theMsg)
 Copy constructor

 Message_Msg (const Standard_CString theKey)
 Create a message using a corresponding entry in Message_MsgFile

 Message_Msg (const TCollection_ExtendedString &theKey)
 Create a message using a corresponding entry in Message_MsgFile

void Set (const Standard_CString theMsg)
 Set a message body text -- can be used as alternative to
using messages from resource file

void Set (const TCollection_ExtendedString &theMsg)
 Set a message body text -- can be used as alternative to
using messages from resource file

Message_MsgArg (const Standard_CString theString)
 Set a value for %..s conversion

Message_Msgoperator<< (const Standard_CString theString)
Message_MsgArg (const TCollection_AsciiString &theString)
 Set a value for %..s conversion

Message_Msgoperator<< (const TCollection_AsciiString &theString)
Message_MsgArg (const Handle< TCollection_HAsciiString > &theString)
 Set a value for %..s conversion

Message_Msgoperator<< (const Handle< TCollection_HAsciiString > &theString)
Message_MsgArg (const TCollection_ExtendedString &theString)
 Set a value for %..s conversion

Message_Msgoperator<< (const TCollection_ExtendedString &theString)
Message_MsgArg (const Handle< TCollection_HExtendedString > &theString)
 Set a value for %..s conversion

Message_Msgoperator<< (const Handle< TCollection_HExtendedString > &theString)
Message_MsgArg (const Standard_Integer theInt)
 Set a value for %..d, %..i, %..o, %..u, %..x or %..X conversion

Message_Msgoperator<< (const Standard_Integer theInt)
Message_MsgArg (const Standard_Real theReal)
 Set a value for %..f, %..e, %..E, %..g or %..G conversion

Message_Msgoperator<< (const Standard_Real theReal)
const TCollection_ExtendedStringOriginal () const
 Returns the original message text

const TCollection_ExtendedStringValue () const
 Returns current state of the message text with
parameters to the moment

Standard_Boolean IsEdited () const
 Tells if Value differs from Original

const TCollection_ExtendedStringGet ()
 Return the resulting message string with all parameters
filled. If some parameters were not yet filled by calls
to methods Arg (or <<), these parameters are filled by
the word UNKNOWN

 operator const TCollection_ExtendedString & ()

Constructor & Destructor Documentation


Member Function Documentation

Message_Msg::operator const TCollection_ExtendedString & ( ) [inline]
Message_Msg& Message_Msg::operator<< ( const Standard_CString  theString) [inline]
Message_Msg& Message_Msg::operator<< ( const TCollection_AsciiString theString) [inline]
Message_Msg& Message_Msg::operator<< ( const Handle< TCollection_HAsciiString > &  theString) [inline]
Message_Msg& Message_Msg::operator<< ( const TCollection_ExtendedString theString) [inline]
Message_Msg& Message_Msg::operator<< ( const Handle< TCollection_HExtendedString > &  theString) [inline]
Message_Msg& Message_Msg::operator<< ( const Standard_Integer  theInt) [inline]
Message_Msg& Message_Msg::operator<< ( const Standard_Real  theReal) [inline]

The documentation for this class was generated from the following file: