Open CASCADE Technology
6.5.4
|
Messenger is API class providing general-purpose interface for
libraries that may issue text messages without knowledge
of how these messages will be further processed.
The messenger contains a sequence of "printers" which can be
customized by the application, and dispatches every received
message to all the printers.
For convenience, a number of operators << are defined with left
argument being Handle(Message_Messenger); thus it can be used
with syntax similar to C++ streams.
Note that all these operators use trace level Warning.
#include <Message_Messenger.hxx>
Public Member Functions | |
Message_Messenger () | |
Empty constructor; initializes by single printer directed to cout. Note: the default messenger is not empty but directed to cout in order to protect against possibility to forget defining printers. If printing to cout is not needed, clear messenger by GetPrinters().Clear() | |
Message_Messenger (const Handle< Message_Printer > &thePrinter) | |
Create messenger with single printer | |
Standard_Boolean | AddPrinter (const Handle< Message_Printer > &thePrinter) |
Add a printer to the messenger. The printer will be added only if it is not yet in the list. Returns True if printer has been added. | |
Standard_Boolean | RemovePrinter (const Handle< Message_Printer > &thePrinter) |
Removes specified printer from the messenger. Returns True if this printer has been found in the list and removed. | |
Standard_Integer | RemovePrinters (const Handle< Standard_Type > &theType) |
Removes printers of specified type (including derived classes) from the messenger. Returns number of removed printers. | |
const Message_SequenceOfPrinters & | Printers () const |
Returns current sequence of printers | |
Message_SequenceOfPrinters & | ChangePrinters () |
Returns sequence of printers The sequence can be modified. | |
void | Send (const Standard_CString theString, const Message_Gravity theGravity=Message_Warning, const Standard_Boolean putEndl=Standard_True) const |
Dispatch a message to all the printers in the list. Three versions of string representations are accepted for convenience, by default all are converted to ExtendedString. The parameter putEndl specifies whether the new line should be started after this message (default) or not (may have sense in some conditions). | |
void | Send (const TCollection_AsciiString &theString, const Message_Gravity theGravity=Message_Warning, const Standard_Boolean putEndl=Standard_True) const |
See above | |
void | Send (const TCollection_ExtendedString &theString, const Message_Gravity theGravity=Message_Warning, const Standard_Boolean putEndl=Standard_True) const |
See above |
Message_Messenger::Message_Messenger | ( | const Handle< Message_Printer > & | thePrinter | ) |
Standard_Boolean Message_Messenger::AddPrinter | ( | const Handle< Message_Printer > & | thePrinter | ) |
Standard_Boolean Message_Messenger::RemovePrinter | ( | const Handle< Message_Printer > & | thePrinter | ) |
Standard_Integer Message_Messenger::RemovePrinters | ( | const Handle< Standard_Type > & | theType | ) |
void Message_Messenger::Send | ( | const Standard_CString | theString, |
const Message_Gravity | theGravity = Message_Warning , |
||
const Standard_Boolean | putEndl = Standard_True |
||
) | const |
void Message_Messenger::Send | ( | const TCollection_AsciiString & | theString, |
const Message_Gravity | theGravity = Message_Warning , |
||
const Standard_Boolean | putEndl = Standard_True |
||
) | const |
void Message_Messenger::Send | ( | const TCollection_ExtendedString & | theString, |
const Message_Gravity | theGravity = Message_Warning , |
||
const Standard_Boolean | putEndl = Standard_True |
||
) | const |