Class Message_Algorithm is intended to be the base class for classes implementing algorithms or any operations that need to provide extended information on its execution to the caller / user. More...

#include <Message_Algorithm.hxx>

Inheritance diagram for Message_Algorithm:

[legend]

Public Member Functions
	Message_Algorithm ()
	Empty constructor.

void	SetStatus (const Message_Status &theStat)
	Sets status with no parameter.

void	SetStatus (const Message_Status &theStat, const Standard_Integer theInt)
	Sets status with integer parameter.

void	SetStatus (const Message_Status &theStat, const Standard_CString theStr, const Standard_Boolean noRepetitions=Standard_True)
	Sets status with string parameter. If noRepetitions is True, the parameter will be added only if it has not been yet recorded for the same status flag.

void	SetStatus (const Message_Status &theStat, const TCollection_AsciiString &theStr, const Standard_Boolean noRepetitions=Standard_True)
	Sets status with string parameter If noRepetitions is True, the parameter will be added only if it has not been yet recorded for the same status flag.

void	SetStatus (const Message_Status &theStat, const Handle< TCollection_HAsciiString > &theStr, const Standard_Boolean noRepetitions=Standard_True)
	Sets status with string parameter If noRepetitions is True, the parameter will be added only if it has not been yet recorded for the same status flag.

void	SetStatus (const Message_Status &theStat, const TCollection_ExtendedString &theStr, const Standard_Boolean noRepetitions=Standard_True)
	Sets status with string parameter If noRepetitions is True, the parameter will be added only if it has not been yet recorded for the same status flag.

void	SetStatus (const Message_Status &theStat, const Handle< TCollection_HExtendedString > &theStr, const Standard_Boolean noRepetitions=Standard_True)
	Sets status with string parameter If noRepetitions is True, the parameter will be added only if it has not been yet recorded for the same status flag.

void	SetStatus (const Message_Status &theStat, const Message_Msg &theMsg)
	Sets status with preformatted message. This message will be used directly to report the status; automatic generation of status messages will be disabled for it.

const Message_ExecStatus &	GetStatus () const
	Returns copy of exec status of algorithm.

Message_ExecStatus &	ChangeStatus ()
	Returns exec status of algorithm.

void	ClearStatus ()
	Clear exec status of algorithm.

void	SetMessenger (const Handle< Message_Messenger > &theMsgr)
	Sets messenger to algorithm.

Handle< Message_Messenger >	GetMessenger () const
	Returns messenger of algorithm. The returned handle is always non-null and can be used for sending messages.

virtual void	SendStatusMessages (const Message_ExecStatus &theFilter, const Message_Gravity theTraceLevel=Message_Warning, const Standard_Integer theMaxCount=20) const
	Print messages for all status flags that have been set during algorithm execution, excluding statuses that are NOT set in theFilter.

void	SendMessages (const Message_Gravity theTraceLevel=Message_Warning, const Standard_Integer theMaxCount=20) const
	Convenient variant of SendStatusMessages() with theFilter having defined all WARN, ALARM, and FAIL (but not DONE) status flags.

void	AddStatus (const Handle< Message_Algorithm > &theOther)
	Add statuses to this algorithm from other algorithm (including messages)

void	AddStatus (const Message_ExecStatus &theStatus, const Handle< Message_Algorithm > &theOther)
	Add statuses to this algorithm from other algorithm, but only those items are moved that correspond to statuses set in theStatus.

Handle< TColStd_HPackedMapOfInteger >	GetMessageNumbers (const Message_Status &theStatus) const
	Return the numbers associated with the indicated status; Null handle if no such status or no numbers associated with it.

Handle< TColStd_HSequenceOfHExtendedString >	GetMessageStrings (const Message_Status &theStatus) const
	Return the strings associated with the indicated status; Null handle if no such status or no strings associated with it.

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.

Static Public Member Functions
static TCollection_ExtendedString	PrepareReport (const Handle< TColStd_HPackedMapOfInteger > &theError, const Standard_Integer theMaxCount)
	Prepares a string containing a list of integers contained in theError map, but not more than theMaxCount.

static TCollection_ExtendedString	PrepareReport (const TColStd_SequenceOfHExtendedString &theReportSeq, const Standard_Integer theMaxCount)
	Prepares a string containing a list of names contained in theReportSeq sequence, but not more than theMaxCount.

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
Message_ExecStatus	myStatus

Handle< Message_Messenger >	myMessenger

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Detailed Description

Class Message_Algorithm is intended to be the base class for classes implementing algorithms or any operations that need to provide extended information on its execution to the caller / user.

It provides generic mechanism for management of the execution status, collection and output of messages.

The algorithm uses methods SetStatus() to set an execution status. It is possible to associate a status with a number or a string (second argument of SetStatus() methods) to indicate precisely the item (object, element etc.) in the input data which caused the problem.

Each execution status generated by the algorithm has associated text message that should be defined in the resource file loaded with call to Message_MsgFile::LoadFile().

The messages corresponding to the statuses generated during the algorithm execution are output to Message_Messenger using methods SendMessages(). If status have associated numbers or strings, they are included in the message body in place of "%s" placeholder which should be present in the message text.

The name of the message text in the resource file is constructed from name of the class and name of the status, separated by dot, for instance:

.TObj_CheckModel.Alarm2 Error: Some objects (s) have references to dead object(s)

If message for the status is not found with prefix of the current class type, the same message is searched for the base class(es) recursively.

Message can be set explicitly for the status; in this case the above procedure is not used and supplied message is used as is.

The messages are output to the messenger, stored in the field; though messenger can be changed, it is guaranteed to be non-null. By default, Message::DefaultMessenger() is used.

Constructor & Destructor Documentation

◆ Message_Algorithm()

Message_Algorithm::Message_Algorithm ( )

Empty constructor.

Member Function Documentation

◆ AddStatus() [1/2]

void Message_Algorithm::AddStatus ( const Handle< Message_Algorithm > & theOther )

Add statuses to this algorithm from other algorithm (including messages)

◆ AddStatus() [2/2]

void Message_Algorithm::AddStatus	(	const Message_ExecStatus &	theStatus,
		const Handle< Message_Algorithm > &	theOther
	)

Add statuses to this algorithm from other algorithm, but only those items are moved that correspond to statuses set in theStatus.

◆ ChangeStatus()

Message_ExecStatus & Message_Algorithm::ChangeStatus ( )

Returns exec status of algorithm.

◆ ClearStatus()

void Message_Algorithm::ClearStatus ( )

Clear exec status of algorithm.

◆ GetMessageNumbers()

Handle< TColStd_HPackedMapOfInteger > Message_Algorithm::GetMessageNumbers ( const Message_Status & theStatus ) const

Return the numbers associated with the indicated status; Null handle if no such status or no numbers associated with it.

◆ GetMessageStrings()

Handle< TColStd_HSequenceOfHExtendedString > Message_Algorithm::GetMessageStrings ( const Message_Status & theStatus ) const

Return the strings associated with the indicated status; Null handle if no such status or no strings associated with it.

◆ GetMessenger()

Handle< Message_Messenger > Message_Algorithm::GetMessenger ( ) const

Returns messenger of algorithm. The returned handle is always non-null and can be used for sending messages.

◆ GetStatus()

const Message_ExecStatus & Message_Algorithm::GetStatus ( ) const

Returns copy of exec status of algorithm.

◆ PrepareReport() [1/2]

static TCollection_ExtendedString Message_Algorithm::PrepareReport	(	const Handle< TColStd_HPackedMapOfInteger > &	theError,
		const Standard_Integer	theMaxCount
	)

static

Prepares a string containing a list of integers contained in theError map, but not more than theMaxCount.

◆ PrepareReport() [2/2]

static TCollection_ExtendedString Message_Algorithm::PrepareReport	(	const TColStd_SequenceOfHExtendedString &	theReportSeq,
		const Standard_Integer	theMaxCount
	)

static

Prepares a string containing a list of names contained in theReportSeq sequence, but not more than theMaxCount.

◆ SendMessages()

void Message_Algorithm::SendMessages	(	const Message_Gravity	theTraceLevel = `Message_Warning`,
		const Standard_Integer	theMaxCount = `20`
	)		const

Convenient variant of SendStatusMessages() with theFilter having defined all WARN, ALARM, and FAIL (but not DONE) status flags.

◆ SendStatusMessages()

virtual void Message_Algorithm::SendStatusMessages	(	const Message_ExecStatus &	theFilter,
		const Message_Gravity	theTraceLevel = `Message_Warning`,
		const Standard_Integer	theMaxCount = `20`
	)		const

virtual

Print messages for all status flags that have been set during algorithm execution, excluding statuses that are NOT set in theFilter.

The messages are taken from resource file, names being constructed as {dynamic class type}.{status name}, for instance, "Message_Algorithm.Fail5". If message is not found in resources for this class and all its base types, surrogate text is printed.

For the statuses having number or string parameters, theMaxCount defines maximal number of numbers or strings to be included in the message

Note that this method is virtual; this allows descendant classes to customize message output (e.g. by adding messages from other sub-algorithms)

◆ SetMessenger()

void Message_Algorithm::SetMessenger ( const Handle< Message_Messenger > & theMsgr )

Sets messenger to algorithm.

◆ SetStatus() [1/8]

void Message_Algorithm::SetStatus ( const Message_Status & theStat )

Sets status with no parameter.

◆ SetStatus() [2/8]

void Message_Algorithm::SetStatus	(	const Message_Status &	theStat,
		const Handle< TCollection_HAsciiString > &	theStr,
		const Standard_Boolean	noRepetitions = `Standard_True`
	)

Sets status with string parameter If noRepetitions is True, the parameter will be added only if it has not been yet recorded for the same status flag.

◆ SetStatus() [3/8]

void Message_Algorithm::SetStatus	(	const Message_Status &	theStat,
		const Handle< TCollection_HExtendedString > &	theStr,
		const Standard_Boolean	noRepetitions = `Standard_True`
	)

Sets status with string parameter If noRepetitions is True, the parameter will be added only if it has not been yet recorded for the same status flag.

◆ SetStatus() [4/8]

void Message_Algorithm::SetStatus	(	const Message_Status &	theStat,
		const Message_Msg &	theMsg
	)

Sets status with preformatted message. This message will be used directly to report the status; automatic generation of status messages will be disabled for it.

◆ SetStatus() [5/8]

void Message_Algorithm::SetStatus	(	const Message_Status &	theStat,
		const Standard_CString	theStr,
		const Standard_Boolean	noRepetitions = `Standard_True`
	)

Sets status with string parameter. If noRepetitions is True, the parameter will be added only if it has not been yet recorded for the same status flag.

◆ SetStatus() [6/8]

void Message_Algorithm::SetStatus	(	const Message_Status &	theStat,
		const Standard_Integer	theInt
	)

Sets status with integer parameter.

◆ SetStatus() [7/8]

void Message_Algorithm::SetStatus	(	const Message_Status &	theStat,
		const TCollection_AsciiString &	theStr,
		const Standard_Boolean	noRepetitions = `Standard_True`
	)

Sets status with string parameter If noRepetitions is True, the parameter will be added only if it has not been yet recorded for the same status flag.

◆ SetStatus() [8/8]

void Message_Algorithm::SetStatus	(	const Message_Status &	theStat,
		const TCollection_ExtendedString &	theStr,
		const Standard_Boolean	noRepetitions = `Standard_True`
	)

Sets status with string parameter If noRepetitions is True, the parameter will be added only if it has not been yet recorded for the same status flag.

Field Documentation

◆ myMessenger

Handle< Message_Messenger > Message_Algorithm::myMessenger

protected

◆ myStatus

Message_ExecStatus Message_Algorithm::myStatus

protected

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

Message_Algorithm.hxx

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Message_Algorithm()

Member Function Documentation

◆ AddStatus() [1/2]

◆ AddStatus() [2/2]

◆ ChangeStatus()

◆ ClearStatus()

◆ GetMessageNumbers()

◆ GetMessageStrings()

◆ GetMessenger()

◆ GetStatus()

◆ PrepareReport() [1/2]

◆ PrepareReport() [2/2]

◆ SendMessages()

◆ SendStatusMessages()

◆ SetMessenger()

◆ SetStatus() [1/8]

◆ SetStatus() [2/8]

◆ SetStatus() [3/8]

◆ SetStatus() [4/8]

◆ SetStatus() [5/8]

◆ SetStatus() [6/8]

◆ SetStatus() [7/8]

◆ SetStatus() [8/8]

Field Documentation

◆ myMessenger

◆ myStatus