Open CASCADE Technology  7.7.0.dev
Public Member Functions | Static Public Member Functions | Protected Attributes

Message_AlertExtended Class Reference

Inherited class of Message_Alert with some additional information. It has Message_Attributes to provide the alert name, and other custom information It has a container of composite alerts, if the alert might provide sub-alerts collecting. More...

#include <Message_AlertExtended.hxx>

Inheritance diagram for Message_AlertExtended:
Inheritance graph
[legend]

Public Member Functions

 Message_AlertExtended ()
 Empty constructor. More...
 
virtual Standard_CString GetMessageKey () const override
 Return a C string to be used as a key for generating text user messages describing this alert. The messages are generated with help of Message_Msg class, in Message_Report::Dump(). Base implementation returns dynamic type name of the instance. More...
 
const Handle< Message_Attribute > & Attribute () const
 Returns container of the alert attributes. More...
 
void SetAttribute (const Handle< Message_Attribute > &theAttribute)
 Sets container of the alert attributes. More...
 
Handle< Message_CompositeAlertsCompositeAlerts (const Standard_Boolean theToCreate=Standard_False)
 Returns class provided hierarchy of alerts if created or create if the parameter is true. More...
 
virtual Standard_Boolean SupportsMerge () const override
 Return true if this type of alert can be merged with other of the same type to avoid duplication. Hierarchical alerts can not be merged Basis implementation returns true. More...
 
virtual Standard_Boolean Merge (const Handle< Message_Alert > &theTarget) override
 If possible, merge data contained in this alert to theTarget. Base implementation always returns false. More...
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
 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...
 

Static Public Member Functions

static Handle< Message_AlertAddAlert (const Handle< Message_Report > &theReport, const Handle< Message_Attribute > &theAttribute, const Message_Gravity theGravity)
 Creates new instance of the alert and put it into report with Message_Info gravity. It does nothing if such kind of gravity is not active in the report. 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...
 

Protected Attributes

Handle< Message_CompositeAlertsmyCompositAlerts
 class provided hierarchical structure of alerts More...
 
Handle< Message_AttributemyAttribute
 container of the alert attributes More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 

Detailed Description

Inherited class of Message_Alert with some additional information. It has Message_Attributes to provide the alert name, and other custom information It has a container of composite alerts, if the alert might provide sub-alerts collecting.

Constructor & Destructor Documentation

◆ Message_AlertExtended()

Message_AlertExtended::Message_AlertExtended ( )
inline

Empty constructor.

Member Function Documentation

◆ AddAlert()

static Handle< Message_Alert > Message_AlertExtended::AddAlert ( const Handle< Message_Report > &  theReport,
const Handle< Message_Attribute > &  theAttribute,
const Message_Gravity  theGravity 
)
static

Creates new instance of the alert and put it into report with Message_Info gravity. It does nothing if such kind of gravity is not active in the report.

Parameters
theReportthe message report where new alert is placed
theAttributecontainer of additional values of the alert
Returns
created alert or NULL if Message_Info is not active in report

◆ Attribute()

const Handle< Message_Attribute >& Message_AlertExtended::Attribute ( ) const
inline

Returns container of the alert attributes.

◆ CompositeAlerts()

Handle< Message_CompositeAlerts > Message_AlertExtended::CompositeAlerts ( const Standard_Boolean  theToCreate = Standard_False)

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

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

◆ DumpJson()

virtual void Message_AlertExtended::DumpJson ( Standard_OStream theOStream,
Standard_Integer  theDepth = -1 
) const
overridevirtual

Dumps the content of me into the stream.

Reimplemented from Message_Alert.

◆ GetMessageKey()

virtual Standard_CString Message_AlertExtended::GetMessageKey ( ) const
overridevirtual

Return a C string to be used as a key for generating text user messages describing this alert. The messages are generated with help of Message_Msg class, in Message_Report::Dump(). Base implementation returns dynamic type name of the instance.

Reimplemented from Message_Alert.

◆ Merge()

virtual Standard_Boolean Message_AlertExtended::Merge ( const Handle< Message_Alert > &  theTarget)
overridevirtual

If possible, merge data contained in this alert to theTarget. Base implementation always returns false.

Returns
True if merged

Reimplemented from Message_Alert.

◆ SetAttribute()

void Message_AlertExtended::SetAttribute ( const Handle< Message_Attribute > &  theAttribute)
inline

Sets container of the alert attributes.

Parameters
theAttributesan attribute values

◆ SupportsMerge()

virtual Standard_Boolean Message_AlertExtended::SupportsMerge ( ) const
overridevirtual

Return true if this type of alert can be merged with other of the same type to avoid duplication. Hierarchical alerts can not be merged Basis implementation returns true.

Reimplemented from Message_Alert.

Field Documentation

◆ myAttribute

Handle< Message_Attribute > Message_AlertExtended::myAttribute
protected

container of the alert attributes

◆ myCompositAlerts

Handle< Message_CompositeAlerts > Message_AlertExtended::myCompositAlerts
protected

class provided hierarchical structure of alerts


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