Message_CompositeAlerts Class Reference

Class providing container of alerts. More...

#include <Message_CompositeAlerts.hxx>

Inheritance diagram for Message_CompositeAlerts:

Public Member Functions
	Message_CompositeAlerts ()
	Empty constructor.
const Message_ListOfAlert &	Alerts (const Message_Gravity theGravity) const
	Returns list of collected alerts with specified gravity.
Standard_Boolean	AddAlert (Message_Gravity theGravity, const Handle< Message_Alert > &theAlert)
	Add alert with specified gravity. If the alert supports merge it will be merged.
Standard_Boolean	RemoveAlert (Message_Gravity theGravity, const Handle< Message_Alert > &theAlert)
	Removes alert with specified gravity.
Standard_Boolean	HasAlert (const Handle< Message_Alert > &theAlert)
	Returns true if the alert belong the list of the child alerts.
Standard_Boolean	HasAlert (const Handle< Standard_Type > &theType, Message_Gravity theGravity)
	Returns true if specific type of alert is recorded with specified gravity.
void	Clear ()
	Clears all collected alerts.
void	Clear (Message_Gravity theGravity)
	Clears collected alerts with specified gravity.
void	Clear (const Handle< Standard_Type > &theType)
	Clears collected alerts with specified type.
void	DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
	Dumps the content of me into the stream.
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 Attributes
Message_ListOfAlert	myAlerts [Message_Fail+1]
	container of child alert for each type of gravity

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.

Detailed Description

Class providing container of alerts.

Constructor & Destructor Documentation

Message_CompositeAlerts()

Message_CompositeAlerts::Message_CompositeAlerts ( )

inline

Empty constructor.

Member Function Documentation

AddAlert()

Standard_Boolean Message_CompositeAlerts::AddAlert	(	Message_Gravity	theGravity,
		const Handle< Message_Alert > &	theAlert
	)

Add alert with specified gravity. If the alert supports merge it will be merged.

Parameters

theGravity	an alert gravity
theAlert	an alert to be added as a child alert

Returns

true if the alert is added or merged

Alerts()

const Message_ListOfAlert & Message_CompositeAlerts::Alerts

(

const Message_Gravity

theGravity

)

const

Returns list of collected alerts with specified gravity.

Clear() [1/3]

void Message_CompositeAlerts::Clear

(

)

Clears all collected alerts.

Clear() [2/3]

void Message_CompositeAlerts::Clear

(

const Handle< Standard_Type > &

theType

)

Clears collected alerts with specified type.

Parameters

theType

an alert type

Clear() [3/3]

void Message_CompositeAlerts::Clear

(

Message_Gravity

theGravity

)

Clears collected alerts with specified gravity.

Parameters

theGravity

an alert gravity

DumpJson()

void Message_CompositeAlerts::DumpJson	(	Standard_OStream &	theOStream,
		Standard_Integer	theDepth = -1
	)		const

Dumps the content of me into the stream.

HasAlert() [1/2]

Standard_Boolean Message_CompositeAlerts::HasAlert

(

const Handle< Message_Alert > &

theAlert

)

Returns true if the alert belong the list of the child alerts.

Parameters

theAlert

an alert to be checked as a child alert

Returns

true if the alert is found in a container of children

HasAlert() [2/2]

Standard_Boolean Message_CompositeAlerts::HasAlert	(	const Handle< Standard_Type > &	theType,
		Message_Gravity	theGravity
	)

Returns true if specific type of alert is recorded with specified gravity.

Parameters

theType	an alert type
theGravity	an alert gravity

Returns

true if the alert is found in a container of children

RemoveAlert()

Standard_Boolean Message_CompositeAlerts::RemoveAlert	(	Message_Gravity	theGravity,
		const Handle< Message_Alert > &	theAlert
	)

Removes alert with specified gravity.

Parameters

theGravity	an alert gravity
theAlert	an alert to be removed from the children

Returns

true if the alert is removed

Field Documentation

myAlerts

Message_ListOfAlert Message_CompositeAlerts::myAlerts[Message_Fail+1]

protected

container of child alert for each type of gravity

---

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

• Message_CompositeAlerts.hxx