Implementation of a message printer associated with Message_Report Send will create a new alert of the report. If string is sent, an alert is created by Eol only. The alerts are sent into set report or default report of Message. More...

#include <Message_PrinterToReport.hxx>

Inheritance diagram for Message_PrinterToReport:

[legend]

Public Member Functions
	Message_PrinterToReport ()=default
	Create printer for redirecting messages into report.
	~Message_PrinterToReport () override=default
	Destructor.
const occ::handle< Message_Report > &	Report () const
	Returns the current or default report.
void	SetReport (const occ::handle< Message_Report > &theReport)
	Sets the printer report.
void	SendStringStream (const Standard_SStream &theStream, const Message_Gravity theGravity) const override
	Send a string message with specified trace level. Stream is converted to string value. Default implementation calls first method Send().
void	SendObject (const occ::handle< Standard_Transient > &theObject, const Message_Gravity theGravity) const override
	Send a string message with specified trace level. The object is converted to string in format: <object kind> : <object pointer>. The parameter theToPutEol specified whether end-of-line should be added to the end of the message. Default implementation calls first method Send().
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.
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().
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
void	send (const TCollection_AsciiString &theString, const Message_Gravity theGravity) const override
	Send a string message with specified trace level. This method must be redefined in descendant.
void	sendMetricAlert (const TCollection_AsciiString &theValue, const Message_Gravity theGravity) const
	Send an alert with metrics active in the current report.
Protected Member Functions inherited from Message_Printer
	Message_Printer ()
	Empty constructor with Message_Info trace level.

Additional Inherited Members
typedef void	base_type
	Returns a type descriptor about this object.
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.
Protected Attributes inherited from Message_Printer
Message_Gravity	myTraceLevel

Detailed Description

Implementation of a message printer associated with Message_Report Send will create a new alert of the report. If string is sent, an alert is created by Eol only. The alerts are sent into set report or default report of Message.

Constructor & Destructor Documentation

◆ Message_PrinterToReport()

Message_PrinterToReport::Message_PrinterToReport ( )

default

Create printer for redirecting messages into report.

◆ ~Message_PrinterToReport()

Message_PrinterToReport::~Message_PrinterToReport ( )

overridedefault

Destructor.

Member Function Documentation

◆ Report()

const occ::handle< Message_Report > & Message_PrinterToReport::Report ( ) const

Returns the current or default report.

◆ send()

void Message_PrinterToReport::send	(	const TCollection_AsciiString &	theString,
		const Message_Gravity	theGravity ) const

overrideprotectedvirtual

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

Implements Message_Printer.

◆ sendMetricAlert()

void Message_PrinterToReport::sendMetricAlert	(	const TCollection_AsciiString &	theValue,
		const Message_Gravity	theGravity ) const

protected

Send an alert with metrics active in the current report.

◆ SendObject()

void Message_PrinterToReport::SendObject	(	const occ::handle< Standard_Transient > &	theObject,
		const Message_Gravity	theGravity ) const

overridevirtual

Send a string message with specified trace level. The object is converted to string in format: <object kind> : <object pointer>. The parameter theToPutEol specified whether end-of-line should be added to the end of the message. Default implementation calls first method Send().

Reimplemented from Message_Printer.

◆ SendStringStream()

void Message_PrinterToReport::SendStringStream	(	const Standard_SStream &	theStream,
		const Message_Gravity	theGravity ) const

overridevirtual

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

Reimplemented from Message_Printer.

◆ SetReport()

void Message_PrinterToReport::SetReport ( const occ::handle< Message_Report > & theReport )

inline

Sets the printer report.

Parameters

theReport report for messages processing, if NULL, the default report is used

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

Message_PrinterToReport.hxx

Public Member Functions

Protected Member Functions

Additional Inherited Members