Open CASCADE Technology  7.4.0
Public Member Functions

Message_PrinterOStream Class Reference

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

#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. More...
 
 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. More...
 
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) More...
 
 ~Message_PrinterOStream ()
 
Standard_Boolean GetUseUtf8 () const
 Returns option to convert non-Ascii symbols to UTF8 encoding. More...
 
void SetUseUtf8 (const Standard_Boolean useUtf8)
 Sets option to convert non-Ascii symbols to UTF8 encoding. More...
 
Standard_OStreamGetStream () const
 Returns reference to the output stream. More...
 
virtual void Send (const Standard_CString theString, const Message_Gravity theGravity, const Standard_Boolean putEndl=Standard_True) const override
 Puts a message to the current stream if its gravity is equal or greater to the trace level set by SetTraceLevel() More...
 
virtual void Send (const TCollection_AsciiString &theString, const Message_Gravity theGravity, const Standard_Boolean putEndl=Standard_True) const override
 Puts a message to the current stream if its gravity is equal or greater to the trace level set by SetTraceLevel() More...
 
virtual void Send (const TCollection_ExtendedString &theString, const Message_Gravity theGravity, const Standard_Boolean putEndl=Standard_True) const override
 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 '?'. More...
 
- Public Member Functions inherited from Message_Printer
Message_Gravity GetTraceLevel () const
 Return trace level used for filtering messages; messages with lover gravity will be ignored. More...
 
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. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 
- Protected Member Functions inherited from Message_Printer
 Message_Printer ()
 Empty constructor with Message_Info trace level. More...
 
- Protected Attributes inherited from Message_Printer
Message_Gravity myTraceLevel
 

Detailed Description

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

Constructor & Destructor Documentation

◆ Message_PrinterOStream() [1/2]

Message_PrinterOStream::Message_PrinterOStream ( const Message_Gravity  theTraceLevel = Message_Info)

Empty constructor, defaulting to cout.

◆ Message_PrinterOStream() [2/2]

Message_PrinterOStream::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.

◆ ~Message_PrinterOStream()

Message_PrinterOStream::~Message_PrinterOStream ( )
inline

Member Function Documentation

◆ Close()

void Message_PrinterOStream::Close ( )

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

◆ GetStream()

Standard_OStream& Message_PrinterOStream::GetStream ( ) const
inline

Returns reference to the output stream.

◆ GetUseUtf8()

Standard_Boolean Message_PrinterOStream::GetUseUtf8 ( ) const
inline

Returns option to convert non-Ascii symbols to UTF8 encoding.

◆ Send() [1/3]

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

Puts a message to the current stream if its gravity is equal or greater to the trace level set by SetTraceLevel()

Reimplemented from Message_Printer.

◆ Send() [2/3]

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

Puts a message to the current stream if its gravity is equal or greater to the trace level set by SetTraceLevel()

Reimplemented from Message_Printer.

◆ Send() [3/3]

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

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 '?'.

Implements Message_Printer.

◆ SetUseUtf8()

void Message_PrinterOStream::SetUseUtf8 ( const Standard_Boolean  useUtf8)
inline

Sets option to convert non-Ascii symbols to UTF8 encoding.


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