Open CASCADE Technology  7.7.0.dev
Public Member Functions | Protected 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...
 
Standard_Boolean IsActiveInMessenger (const Handle< Message_Messenger > &theMessenger=NULL) const
 Returns true if a report printer for the current report is registered in the messenger. More...
 
void ActivateInMessenger (const Standard_Boolean toActivate, const Handle< Message_Messenger > &theMessenger=NULL)
 Creates an instance of Message_PrinterToReport with the current report and register it in messenger. More...
 
void UpdateActiveInMessenger (const Handle< Message_Messenger > &theMessenger=NULL)
 Updates internal flag IsActiveInMessenger. It becomes true if messenger contains at least one instance of Message_PrinterToReport. More...
 
void AddLevel (Message_Level *theLevel, const TCollection_AsciiString &theName)
 Add new level of alerts. More...
 
void RemoveLevel (Message_Level *theLevel)
 Remove level of alerts. 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...
 
const NCollection_IndexedMap< Message_MetricType > & ActiveMetrics () const
 Returns computed metrics when alerts are performed. More...
 
void SetActiveMetric (const Message_MetricType theMetricType, const Standard_Boolean theActivate)
 Sets metrics to compute when alerts are performed. More...
 
void ClearMetrics ()
 Removes all activated metrics. More...
 
Standard_Integer Limit () const
 Returns maximum number of collecting alerts. If the limit is achieved, first alert is removed, the new alert is added in the container. More...
 
void SetLimit (const Standard_Integer theLimit)
 Sets maximum number of collecting alerts. 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...
 
virtual void SendMessages (const Handle< Message_Messenger > &theMessenger)
 Sends all collected alerts to messenger. More...
 
virtual void SendMessages (const Handle< Message_Messenger > &theMessenger, Message_Gravity theGravity)
 Dumps collected alerts with specified gravity to messenger. Default implementation creates Message_Msg object with a message key returned by alert, and sends it in the 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...
 
void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
 Dumps the content of me into the stream. 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 Member Functions

const Handle< Message_CompositeAlerts > & compositeAlerts (const Standard_Boolean isCreate=Standard_False)
 Returns class provided hierarchy of alerts if created or create if the parameter is true. More...
 
void sendMessages (const Handle< Message_Messenger > &theMessenger, Message_Gravity theGravity, const Handle< Message_CompositeAlerts > &theCompositeAlert)
 Sends alerts to messenger. More...
 
void dumpMessages (Standard_OStream &theOS, Message_Gravity theGravity, const Handle< Message_CompositeAlerts > &theCompositeAlert)
 Dumps collected alerts with specified gravity to stream. More...
 

Protected Attributes

Standard_Mutex myMutex
 
Handle< Message_CompositeAlertsmyCompositAlerts
 container of alerts More...
 
NCollection_Sequence< Message_Level * > myAlertLevels
 container of active levels, new alerts are added below the latest level More...
 
NCollection_IndexedMap< Message_MetricTypemyActiveMetrics
 metrics to compute on alerts More...
 
Standard_Integer myLimit
 Maximum number of collected alerts on the top level. More...
 
Standard_Boolean myIsActiveInMessenger
 

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:

Message_PrinterToReport is a printer in Messenger to convert data sent to messenger into report

Constructor & Destructor Documentation

◆ Message_Report()

Message_Report::Message_Report ( )

Empty constructor.

Member Function Documentation

◆ ActivateInMessenger()

void Message_Report::ActivateInMessenger ( const Standard_Boolean  toActivate,
const Handle< Message_Messenger > &  theMessenger = NULL 
)

Creates an instance of Message_PrinterToReport with the current report and register it in messenger.

Parameters
toActivateif true, activated else deactivated
theMessengerthe messenger. If it's NULL, the default messenger is used

◆ ActiveMetrics()

const NCollection_IndexedMap<Message_MetricType>& Message_Report::ActiveMetrics ( ) const
inline

Returns computed metrics when alerts are performed.

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

◆ AddLevel()

void Message_Report::AddLevel ( Message_Level theLevel,
const TCollection_AsciiString theName 
)

Add new level of alerts.

Parameters
theLevela level

◆ Clear() [1/3]

void Message_Report::Clear ( )

Clears all collected alerts.

◆ Clear() [2/3]

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

Clears collected alerts with specified type.

◆ Clear() [3/3]

void Message_Report::Clear ( Message_Gravity  theGravity)

Clears collected alerts with specified gravity.

◆ ClearMetrics()

void Message_Report::ClearMetrics ( )
inline

Removes all activated metrics.

◆ compositeAlerts()

const Handle< Message_CompositeAlerts >& Message_Report::compositeAlerts ( const Standard_Boolean  isCreate = Standard_False)
protected

Returns class provided hierarchy of alerts if created or create if the parameter is true.

Parameters
isCreateif composite alert has not been created for this alert, it should be created
Returns
instance or NULL

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

◆ DumpJson()

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

Dumps the content of me into the stream.

◆ dumpMessages()

void Message_Report::dumpMessages ( Standard_OStream theOS,
Message_Gravity  theGravity,
const Handle< Message_CompositeAlerts > &  theCompositeAlert 
)
protected

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.

◆ IsActiveInMessenger()

Standard_Boolean Message_Report::IsActiveInMessenger ( const Handle< Message_Messenger > &  theMessenger = NULL) const

Returns true if a report printer for the current report is registered in the messenger.

Parameters
theMessengerthe messenger. If it's NULL, the default messenger is used

◆ Limit()

Standard_Integer Message_Report::Limit ( ) const
inline

Returns maximum number of collecting alerts. If the limit is achieved, first alert is removed, the new alert is added in the container.

Returns
the limit value

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

◆ RemoveLevel()

void Message_Report::RemoveLevel ( Message_Level theLevel)

Remove level of alerts.

◆ SendMessages() [1/2]

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

Sends all collected alerts to messenger.

◆ SendMessages() [2/2]

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

Dumps collected alerts with specified gravity to messenger. Default implementation creates Message_Msg object with a message key returned by alert, and sends it in the messenger.

◆ sendMessages()

void Message_Report::sendMessages ( const Handle< Message_Messenger > &  theMessenger,
Message_Gravity  theGravity,
const Handle< Message_CompositeAlerts > &  theCompositeAlert 
)
protected

Sends alerts to messenger.

◆ SetActiveMetric()

void Message_Report::SetActiveMetric ( const Message_MetricType  theMetricType,
const Standard_Boolean  theActivate 
)

Sets metrics to compute when alerts are performed.

Parameters
theMetricscontainer of metrics

◆ SetLimit()

void Message_Report::SetLimit ( const Standard_Integer  theLimit)
inline

Sets maximum number of collecting alerts.

Parameters
theLimitlimit value

◆ UpdateActiveInMessenger()

void Message_Report::UpdateActiveInMessenger ( const Handle< Message_Messenger > &  theMessenger = NULL)

Updates internal flag IsActiveInMessenger. It becomes true if messenger contains at least one instance of Message_PrinterToReport.

Parameters
theMessengerthe messenger. If it's NULL, the default messenger is used

Field Documentation

◆ myActiveMetrics

NCollection_IndexedMap<Message_MetricType> Message_Report::myActiveMetrics
protected

metrics to compute on alerts

◆ myAlertLevels

NCollection_Sequence<Message_Level*> Message_Report::myAlertLevels
protected

container of active levels, new alerts are added below the latest level

◆ myCompositAlerts

Handle< Message_CompositeAlerts > Message_Report::myCompositAlerts
protected

container of alerts

◆ myIsActiveInMessenger

Standard_Boolean Message_Report::myIsActiveInMessenger
protected

◆ myLimit

Standard_Integer Message_Report::myLimit
protected

Maximum number of collected alerts on the top level.

◆ myMutex

Standard_Mutex Message_Report::myMutex
protected

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