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

#include <Message_Algorithm.hxx>

Inheritance diagram for Message_Algorithm:

[legend]

Public Member Functions
	Message_Algorithm ()
	Empty constructor More...

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

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

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

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

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

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

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

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

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

Message_ExecStatus &	ChangeStatus ()
	Returns exec status of algorithm More...

void	ClearStatus ()
	Clear exec status of algorithm More...

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

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

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 <br> algorithm execution, excluding statuses that are NOT set <br> in theFilter. <br> 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) More...

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

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

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

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

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

Public Member Functions inherited from MMgt_TShared
virtual void	Delete () const
	Memory deallocator for transient classes. More...

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor. More...

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing. More...

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter. More...

virtual	~Standard_Transient ()
	Destructor must be virtual. More...

virtual void	ShallowDump (Standard_OStream &) const

virtual const Handle_Standard_Type &	DynamicType () const
	Returns a type information object about this object. More...

Standard_Boolean	IsInstance (const 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 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...

virtual Handle_Standard_Transient	This () const
	Returns a Handle which references this object. Must never be called to objects created in stack. More...

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

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

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

Protected Attributes
Message_ExecStatus	myStatus

Handle_Message_Messenger	myMessenger

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

Empty constructor

Member Function Documentation

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

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

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

Message_ExecStatus& Message_Algorithm::ChangeStatus ( )

Returns exec status of algorithm

void Message_Algorithm::ClearStatus ( )

Clear exec status of algorithm

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

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

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.

const Message_ExecStatus& Message_Algorithm::GetStatus ( ) const

Returns copy of exec status of algorithm

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

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

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

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 <br>
     algorithm execution, excluding statuses that are NOT set <br>
     in theFilter. <br>

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)

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

Sets messenger to algorithm

void Message_Algorithm::SetStatus ( const Message_Status & theStat )

Sets status with no parameter

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

Sets status with integer parameter

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

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

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

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

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

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.

Field Documentation

Handle_Message_Messenger Message_Algorithm::myMessenger

protected

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

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation