Open CASCADE Technology  7.5.0
Public Member Functions | Protected Member Functions | Protected Attributes

Message_Printer Class Referenceabstract

Abstract interface class defining printer as output context for text messages. More...

#include <Message_Printer.hxx>

Inheritance diagram for Message_Printer:
Inheritance graph
[legend]

Public Member Functions

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

Protected Member Functions

 Message_Printer ()
 Empty constructor with Message_Info trace level. More...
 
virtual void send (const TCollection_AsciiString &theString, const Message_Gravity theGravity) const =0
 Send a string message with specified trace level. This method must be redefined in descendant. More...
 

Protected Attributes

Message_Gravity myTraceLevel
 

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

Detailed Description

Abstract interface class defining printer as output context for text messages.

The message, besides being text string, has associated gravity level, which can be used by printer to decide either to process a message or ignore it.

Constructor & Destructor Documentation

◆ Message_Printer()

Message_Printer::Message_Printer ( )
protected

Empty constructor with Message_Info trace level.

Member Function Documentation

◆ GetTraceLevel()

Message_Gravity Message_Printer::GetTraceLevel ( ) const
inline

Return trace level used for filtering messages; messages with lover gravity will be ignored.

◆ Send() [1/3]

virtual void Message_Printer::Send ( const TCollection_ExtendedString theString,
const Message_Gravity  theGravity 
) const
virtual

Send a string message with specified trace level. The last Boolean argument is deprecated and unused. Default implementation redirects to send().

◆ Send() [2/3]

virtual void Message_Printer::Send ( const Standard_CString  theString,
const Message_Gravity  theGravity 
) const
virtual

Send a string message with specified trace level. The last Boolean argument is deprecated and unused. Default implementation redirects to send().

◆ Send() [3/3]

virtual void Message_Printer::Send ( const TCollection_AsciiString theString,
const Message_Gravity  theGravity 
) const
virtual

Send a string message with specified trace level. The last Boolean argument is deprecated and unused. Default implementation redirects to send().

◆ send()

virtual void Message_Printer::send ( const TCollection_AsciiString theString,
const Message_Gravity  theGravity 
) const
protectedpure virtual

Send a string message with specified trace level. This method must be redefined in descendant.

Implemented in Message_PrinterOStream, Message_PrinterToReport, Message_PrinterSystemLog, and Draw_Printer.

◆ SendObject()

virtual void Message_Printer::SendObject ( const Handle< Standard_Transient > &  theObject,
const Message_Gravity  theGravity 
) const
virtual

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().

Reimplemented in Message_PrinterToReport.

◆ SendStringStream()

virtual void Message_Printer::SendStringStream ( const Standard_SStream theStream,
const Message_Gravity  theGravity 
) const
virtual

Send a string message with specified trace level. Stream is converted to string value. Default implementation calls first method Send().

Reimplemented in Message_PrinterToReport.

◆ SetTraceLevel()

void Message_Printer::SetTraceLevel ( const Message_Gravity  theTraceLevel)
inline

Set trace level used for filtering messages. By default, trace level is Message_Info, so that all messages are output.

Field Documentation

◆ myTraceLevel

Message_Gravity Message_Printer::myTraceLevel
protected

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