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 ()
	Create printer for redirecting messages into report.

virtual	~Message_PrinterToReport ()
	Destructor.

const Handle< Message_Report > &	Report () const
	Returns the current or default report.

void	SetReport (const Handle< Message_Report > &theReport)
	Sets the printer report.

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

virtual void	SendObject (const 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 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().

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 ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

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.

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.

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.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

virtual void	Delete () const
	Memory deallocator for transient classes.

Protected Member Functions
virtual 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
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.

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

inline

Create printer for redirecting messages into report.

◆ ~Message_PrinterToReport()

virtual Message_PrinterToReport::~Message_PrinterToReport ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ Report()

const Handle< Message_Report > & Message_PrinterToReport::Report ( ) const

Returns the current or default report.

◆ send()

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

virtual void Message_PrinterToReport::SendObject	(	const 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()

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