Open CASCADE Technology  7.5.0.beta
Public Member Functions | Static Public Member Functions | Protected 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_OStreamGetStream () const
 Returns reference to the output stream. More...
 
Standard_Boolean ToColorize () const
 Returns TRUE if text output into console should be colorized depending on message gravity; TRUE by default. More...
 
void SetToColorize (Standard_Boolean theToColorize)
 Set if text output into console should be colorized depending on message gravity. 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...
 
virtual void Send (const TCollection_ExtendedString &theString, const Message_Gravity theGravity) const
 Send a string message with specified trace level. The last Boolean argument is deprecated and unused. Default implementation redirects to send(). More...
 
virtual void Send (const Standard_CString theString, const Message_Gravity theGravity) const
 Send a string message with specified trace level. The last Boolean argument is deprecated and unused. Default implementation redirects to send(). More...
 
virtual void Send (const TCollection_AsciiString &theString, const Message_Gravity theGravity) const
 Send a string message with specified trace level. The last Boolean argument is deprecated and unused. Default implementation redirects to send(). More...
 
virtual void SendStringStream (const Standard_SStream &theStream, const Message_Gravity theGravity) const
 Send a string message with specified trace level. Stream is converted to string value. Default implementation calls first method Send(). More...
 
virtual void SendObject (const Handle< Standard_Transient > &theObject, const Message_Gravity theGravity) const
 Send a string message with specified trace level. The object is converted to string in format: <object kind>=""> : <object pointer>="">. Default implementation calls first method Send(). 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...
 

Static Public Member Functions

static void SetConsoleTextColor (Standard_OStream *theOStream, Message_ConsoleColor theTextColor, bool theIsIntenseText=false)
 Setup console text color. 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

virtual void send (const TCollection_AsciiString &theString, const Message_Gravity theGravity) const override
 Puts a message to the current stream if its gravity is equal or greater to the trace level set by SetTraceLevel() More...
 
- Protected Member Functions inherited from Message_Printer
 Message_Printer ()
 Empty constructor with Message_Info trace level. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. 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.

◆ send()

virtual void Message_PrinterOStream::send ( const TCollection_AsciiString theString,
const Message_Gravity  theGravity 
) const
overrideprotectedvirtual

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

Implements Message_Printer.

◆ SetConsoleTextColor()

static void Message_PrinterOStream::SetConsoleTextColor ( Standard_OStream theOStream,
Message_ConsoleColor  theTextColor,
bool  theIsIntenseText = false 
)
static

Setup console text color.

On Windows, this would affect active terminal color output. On other systems, this would put special terminal codes; the terminal should support these codes or them will appear in text otherwise. The same will happen when stream is redirected into text file.

Beware that within multi-threaded environment inducing console colors might lead to colored text mixture due to concurrency.

◆ SetToColorize()

void Message_PrinterOStream::SetToColorize ( Standard_Boolean  theToColorize)
inline

Set if text output into console should be colorized depending on message gravity.

◆ ToColorize()

Standard_Boolean Message_PrinterOStream::ToColorize ( ) const
inline

Returns TRUE if text output into console should be colorized depending on message gravity; TRUE by default.


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