Message_Printer Class Reference

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

#include <Message_Printer.hxx>

Inheritance diagram for Message_Printer:

Public Member Functions
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.
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().
virtual void	Send (const char *const 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().
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().
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().
virtual void	SendObject (const occ::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().
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()=default
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.
bool	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.
bool	IsKind (const char *const 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.
Standard_Transient *	This () 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.
int	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
virtual void	Delete () const
	Memory deallocator for transient classes.

Protected Member Functions
	Message_Printer ()
	Empty constructor with Message_Info trace level.
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.

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.
Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.
static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

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 char *const 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 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 Draw_Printer, Message_PrinterOStream, Message_PrinterSystemLog, and Message_PrinterToReport.

Send() [3/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().

SendObject()

virtual void Message_Printer::SendObject ( const occ::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:

• Message_Printer.hxx