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

Implementation of a message printer associated with an ostream
The ostream may be either externally defined one (e.g. cout),
or file stream maintained internally (depending on constructor).

#include <Message_PrinterOStream.hxx>

Inheritance diagram for Message_PrinterOStream:
Inheritance graph
[legend]

Public Member Functions

 Message_PrinterOStream (const Message_Gravity theTraceLevel=Message_Info)
 Empty constructor, defaulting to cout

 Message_PrinterOStream (const Standard_CString theFileName, const Standard_Boolean theDoAppend, const Message_Gravity theTraceLevel=Message_Info)
 Create printer for output to a specified file.
The option theDoAppend specifies whether file should be
appended or rewritten.
For specific file names (cout, cerr) standard streams are used

void Close ()
 Flushes the output stream and destroys it if it has been
specified externally with option doFree (or if it is internal
file stream)

 ~Message_PrinterOStream ()
Message_Gravity GetTraceLevel () const
 Return trace level used for filtering messages;
messages with lover gravity will be ignored.

void SetTraceLevel (const Message_Gravity theTraceLevel)
 Set trace level used for filtering messages.
By default, trace level is Message_Info, so that
all messages are output

Standard_Boolean GetUseUtf8 () const
 Returns option to convert non-Ascii symbols to UTF8 encoding

void SetUseUtf8 (const Standard_Boolean useUtf8)
 Sets option to convert non-Ascii symbols to UTF8 encoding

Standard_OStreamGetStream () const
 Returns reference to the output stream

virtual void Send (const Standard_CString theString, const Message_Gravity theGravity, const Standard_Boolean putEndl=Standard_True) const
 Puts a message to the current stream
if its gravity is equal or greater
to the trace level set by SetTraceLevel()

virtual void Send (const TCollection_AsciiString &theString, const Message_Gravity theGravity, const Standard_Boolean putEndl=Standard_True) const
 Puts a message to the current stream
if its gravity is equal or greater
to the trace level set by SetTraceLevel()

virtual void Send (const TCollection_ExtendedString &theString, const Message_Gravity theGravity, const Standard_Boolean putEndl=Standard_True) const
 Puts a message to the current stream
if its gravity is equal or greater
to the trace level set by SetTraceLevel()
Non-Ascii symbols are converted to UTF-8 if UseUtf8
option is set, else replaced by symbols '?'


Constructor & Destructor Documentation


Member Function Documentation

virtual void Message_PrinterOStream::Send ( const Standard_CString  theString,
const Message_Gravity  theGravity,
const Standard_Boolean  putEndl = Standard_True 
) const [virtual]

Reimplemented from Message_Printer.

virtual void Message_PrinterOStream::Send ( const TCollection_AsciiString theString,
const Message_Gravity  theGravity,
const Standard_Boolean  putEndl = Standard_True 
) const [virtual]

Reimplemented from Message_Printer.

virtual void Message_PrinterOStream::Send ( const TCollection_ExtendedString theString,
const Message_Gravity  theGravity,
const Standard_Boolean  putEndl = Standard_True 
) const [virtual]

Implements Message_Printer.


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