Open CASCADE Technology  7.3.1.dev
Public Member Functions | Protected Attributes
Message_Report Class Reference

Container for alert messages, sorted according to their gravity. More...

#include <Message_Report.hxx>

Inheritance diagram for Message_Report:
Inheritance graph
[legend]

Public Member Functions

 Message_Report ()
 Empty constructor. More...
 
void AddAlert (Message_Gravity theGravity, const Handle< Message_Alert > &theAlert)
 Add alert with specified gravity. This method is thread-safe, i.e. alerts can be added from parallel threads safely. More...
 
const Message_ListOfAlertGetAlerts (Message_Gravity theGravity) const
 Returns list of collected alerts with specified gravity. More...
 
Standard_Boolean HasAlert (const Handle< Standard_Type > &theType)
 Returns true if specific type of alert is recorded. More...
 
Standard_Boolean HasAlert (const Handle< Standard_Type > &theType, Message_Gravity theGravity)
 Returns true if specific type of alert is recorded with specified gravity. More...
 
void Clear ()
 Clears all collected alerts. More...
 
void Clear (Message_Gravity theGravity)
 Clears collected alerts with specified gravity. More...
 
void Clear (const Handle< Standard_Type > &theType)
 Clears collected alerts with specified type. More...
 
void Dump (Standard_OStream &theOS)
 Dumps all collected alerts to stream. More...
 
void Dump (Standard_OStream &theOS, Message_Gravity theGravity)
 Dumps collected alerts with specified gravity to stream. More...
 
void SendMessages (const Handle< Message_Messenger > &theMessenger)
 Sends all collected alerts to messenger. More...
 
void SendMessages (const Handle< Message_Messenger > &theMessenger, Message_Gravity theGravity)
 Dumps collected alerts with specified gravity to messenger. More...
 
void Merge (const Handle< Message_Report > &theOther)
 Merges data from theOther report into this. More...
 
void Merge (const Handle< Message_Report > &theOther, Message_Gravity theGravity)
 Merges alerts with specified gravity from theOther report into this. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::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 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. 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...
 
Standard_TransientThis () 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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Protected Attributes

Standard_Mutex myMutex
 
Message_ListOfAlert myAlerts [Message_Fail+1]
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Detailed Description

Container for alert messages, sorted according to their gravity.

For each gravity level, alerts are stored in simple list. If alert being added can be merged with another alert of the same type already in the list, it is merged and not added to the list.

This class is intended to be used as follows:

Constructor & Destructor Documentation

◆ Message_Report()

Message_Report::Message_Report ( )

Empty constructor.

Member Function Documentation

◆ AddAlert()

void Message_Report::AddAlert ( Message_Gravity  theGravity,
const Handle< Message_Alert > &  theAlert 
)

Add alert with specified gravity. This method is thread-safe, i.e. alerts can be added from parallel threads safely.

◆ Clear() [1/3]

void Message_Report::Clear ( )

Clears all collected alerts.

◆ Clear() [2/3]

void Message_Report::Clear ( Message_Gravity  theGravity)

Clears collected alerts with specified gravity.

◆ Clear() [3/3]

void Message_Report::Clear ( const Handle< Standard_Type > &  theType)

Clears collected alerts with specified type.

◆ Dump() [1/2]

void Message_Report::Dump ( Standard_OStream theOS)

Dumps all collected alerts to stream.

◆ Dump() [2/2]

void Message_Report::Dump ( Standard_OStream theOS,
Message_Gravity  theGravity 
)

Dumps collected alerts with specified gravity to stream.

◆ GetAlerts()

const Message_ListOfAlert& Message_Report::GetAlerts ( Message_Gravity  theGravity) const

Returns list of collected alerts with specified gravity.

◆ HasAlert() [1/2]

Standard_Boolean Message_Report::HasAlert ( const Handle< Standard_Type > &  theType)

Returns true if specific type of alert is recorded.

◆ HasAlert() [2/2]

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

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

◆ Merge() [1/2]

void Message_Report::Merge ( const Handle< Message_Report > &  theOther)

Merges data from theOther report into this.

◆ Merge() [2/2]

void Message_Report::Merge ( const Handle< Message_Report > &  theOther,
Message_Gravity  theGravity 
)

Merges alerts with specified gravity from theOther report into this.

◆ SendMessages() [1/2]

void Message_Report::SendMessages ( const Handle< Message_Messenger > &  theMessenger)

Sends all collected alerts to messenger.

◆ SendMessages() [2/2]

void Message_Report::SendMessages ( const Handle< Message_Messenger > &  theMessenger,
Message_Gravity  theGravity 
)

Dumps collected alerts with specified gravity to messenger.

Field Documentation

◆ myAlerts

Message_ListOfAlert Message_Report::myAlerts[Message_Fail+1]
protected

◆ myMutex

Standard_Mutex Message_Report::myMutex
protected

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