Message_Algorithm Class Reference

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.

#include <Message_Algorithm.hxx>

Inheritance diagram for Message_Algorithm:

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
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
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
Protected Attributes
Message_ExecStatus	myStatus
Handle_Message_Messenger	myMessenger

---

Constructor & Destructor Documentation

Message_Algorithm::Message_Algorithm

(

)

---

Member Function Documentation

void Message_Algorithm::AddStatus

(

const Handle< Message_Algorithm > &

theOther

)

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

Message_ExecStatus& Message_Algorithm::ChangeStatus

(

)

void Message_Algorithm::ClearStatus

(

)

Handle_TColStd_HPackedMapOfInteger Message_Algorithm::GetMessageNumbers

(

const Message_Status &

theStatus

)

const

Handle_TColStd_HSequenceOfHExtendedString Message_Algorithm::GetMessageStrings

(

const Message_Status &

theStatus

)

const

Handle_Message_Messenger Message_Algorithm::GetMessenger

(

)

const

const Message_ExecStatus& Message_Algorithm::GetStatus

(

)

const

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

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

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

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

void Message_Algorithm::SetMessenger

(

const Handle< Message_Messenger > &

theMsgr

)

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

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

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

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

void Message_Algorithm::SetStatus

(

const Message_Status &

theStat

)

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

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

---

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