# FoundationClasses
TKernel
Message

# 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

void * | operator new (size_t, void *anAddress)
void * | operator new (size_t size)
void | operator delete (void *anAddress)
Standard_EXPORT | Message_Msg ()
| Empty constructor .
Standard_EXPORT | Message_Msg (const Message_Msg &theMsg)
| Copy constructor .
Standard_EXPORT | Message_Msg (const Standard_CString theKey)
| Create a message using a corresponding entry in Message_MsgFile .
Standard_EXPORT | Message_Msg (const TCollection_AsciiString &theKey)
| Create a message using a corresponding entry in Message_MsgFile .
Standard_EXPORT void | Set (const Standard_CString theMsg)
| Set a message body text -- can be used as alternative to using messages from resource file .
Standard_EXPORT void | Set (const TCollection_AsciiString &theMsg)
| Set a message body text -- can be used as alternative to using messages from resource file .
Standard_EXPORT Message_Msg & | Arg (const Standard_CString theString)
| Set a value for ..s conversion .
Message_Msg & | operator<< (const Standard_CString theString)
Message_Msg & | Arg (const TCollection_AsciiString &theString)
| Set a value for ..s conversion .
Message_Msg & | operator<< (const TCollection_AsciiString &theString)
Message_Msg & | Arg (const Handle(TCollection_HAsciiString)&theString)
| Set a value for ..s conversion .
Message_Msg & | operator<< (const Handle(TCollection_HAsciiString)&theString)
Standard_EXPORT Message_Msg & | Arg (const TCollection_ExtendedString &theString)
| Set a value for ..s conversion .
Message_Msg & | operator<< (const TCollection_ExtendedString &theString)
Message_Msg & | Arg (const Handle(TCollection_HExtendedString)&theString)
| Set a value for ..s conversion .
Message_Msg & | operator<< (const Handle(TCollection_HExtendedString)&theString)
Standard_EXPORT Message_Msg & | Arg (const Standard_Integer theInt)
| Set a value for ..d, ..i, ..o, ..u, ..x or ..X conversion .
Message_Msg & | operator<< (const Standard_Integer theInt)
Standard_EXPORT Message_Msg & | Arg (const Standard_Real theReal)
| Set a value for ..f, ..e, ..E, ..g or ..G conversion .
Message_Msg & | operator<< (const Standard_Real theReal)
const TCollection_ExtendedString & | Original () const
| Returns the original message text .
const TCollection_ExtendedString & | Value () const
| Returns current state of the message text with parameters to the moment .
Standard_Boolean | IsEdited () const
| Tells if Value differs from Original .
Standard_EXPORT const TCollection_ExtendedString & | Get ()
| 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 & ()

## Private Member Functions

Standard_EXPORT Standard_Integer | getFormat (const Standard_Integer theType, TCollection_AsciiString &theFormat)
Standard_EXPORT void | replaceText (const Standard_Integer theFirst, const Standard_Integer theNb, const TCollection_ExtendedString &theStr)

## Private Attributes

TCollection_ExtendedString | myOriginal
TCollection_ExtendedString | myMessageBody
TColStd_SequenceOfInteger | mySeqOfFormats

## Constructor & Destructor Documentation

Standard_EXPORT Message_Msg::Message_Msg | ( |  | ) |

Standard_EXPORT Message_Msg::Message_Msg | ( | const Message_Msg & | theMsg | ) |

Standard_EXPORT Message_Msg::Message_Msg | ( | const Standard_CString | theKey | ) |

Standard_EXPORT Message_Msg::Message_Msg | ( | const TCollection_AsciiString & | theKey | ) |

## Member Function Documentation

Standard_EXPORT Message_Msg& Message_Msg::Arg | ( | const Standard_Real | theReal | ) |

Standard_EXPORT Message_Msg& Message_Msg::Arg | ( | const Standard_Integer | theInt | ) |

Message_Msg & Message_Msg::Arg | ( | const Handle(TCollection_HExtendedString)& | theString | ) | `[inline]`

Standard_EXPORT Message_Msg& Message_Msg::Arg | ( | const TCollection_ExtendedString & | theString | ) |

Message_Msg & Message_Msg::Arg | ( | const Handle(TCollection_HAsciiString)& | theString | ) | `[inline]`

Message_Msg & Message_Msg::Arg | ( | const TCollection_AsciiString & | theString | ) | `[inline]`

Standard_EXPORT Message_Msg& Message_Msg::Arg | ( | const Standard_CString | theString | ) |

Standard_EXPORT const TCollection_ExtendedString& Message_Msg::Get | ( |  | ) |

Standard_EXPORT Standard_Integer Message_Msg::getFormat | ( | const Standard_Integer | theType,
|  | TCollection_AsciiString & | theFormat
| ) | `[private]`

Standard_Boolean Message_Msg::IsEdited | ( |  | ) | const`[inline]`

Message_Msg::operator const TCollection_ExtendedString & | ( |  | ) | `[inline]`

void Message_Msg::operator delete | ( | void * | anAddress | ) | `[inline]`

void* Message_Msg::operator new | ( | size_t | size | ) | `[inline]`

void* Message_Msg::operator new | ( | size_t | ,
|  | void * | anAddress
| ) | `[inline]`

Message_Msg& Message_Msg::operator<< | ( | const Standard_Real | theReal | ) | `[inline]`

Message_Msg& Message_Msg::operator<< | ( | const Standard_Integer | theInt | ) | `[inline]`

Message_Msg& Message_Msg::operator<< | ( | const Handle(TCollection_HExtendedString)& | theString | ) | `[inline]`

Message_Msg& Message_Msg::operator<< | ( | const TCollection_ExtendedString & | theString | ) | `[inline]`

Message_Msg& Message_Msg::operator<< | ( | const Handle(TCollection_HAsciiString)& | theString | ) | `[inline]`

Message_Msg& Message_Msg::operator<< | ( | const TCollection_AsciiString & | theString | ) | `[inline]`

Message_Msg& Message_Msg::operator<< | ( | const Standard_CString | theString | ) | `[inline]`

const TCollection_ExtendedString & Message_Msg::Original | ( |  | ) | const`[inline]`

Standard_EXPORT void Message_Msg::replaceText | ( | const Standard_Integer | theFirst,
|  | const Standard_Integer | theNb,
|  | const TCollection_ExtendedString & | theStr
| ) | `[private]`

Standard_EXPORT void Message_Msg::Set | ( | const TCollection_AsciiString & | theMsg | ) |

Standard_EXPORT void Message_Msg::Set | ( | const Standard_CString | theMsg | ) |

const TCollection_ExtendedString & Message_Msg::Value | ( |  | ) | const`[inline]`

## Field Documentation

TCollection_ExtendedString Message_Msg::myMessageBody `[private]`

TCollection_ExtendedString Message_Msg::myOriginal `[private]`

TColStd_SequenceOfInteger Message_Msg::mySeqOfFormats `[private]`

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

- Message_Msg.hxx
- Message_Msg.lxx