Open CASCADE Technology  7.5.0
Public Member Functions

Message_Alert Class Reference

Base class of the hierarchy of classes describing various situations occurring during execution of some algorithm or procedure. More...

#include <Message_Alert.hxx>

Inheritance diagram for Message_Alert:
Inheritance graph
[legend]

Public Member Functions

virtual Standard_CString GetMessageKey () const
 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...
 
virtual Standard_Boolean SupportsMerge () const
 Return true if this type of alert can be merged with other of the same type to avoid duplication. Basis implementation returns true. More...
 
virtual Standard_Boolean Merge (const Handle< Message_Alert > &theTarget)
 If possible, merge data contained in this alert to theTarget. More...
 
virtual 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...
 

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

Base class of the hierarchy of classes describing various situations occurring during execution of some algorithm or procedure.

Alert should provide unique text identifier that can be used to distinguish particular type of alerts, e.g. to get text message string describing it. See method GetMessageKey(); by default, dynamic type name is used.

Alert can contain some data. To avoid duplication of data, new alert can be merged with another one of the same type. Method SupportsMerge() should return true if merge is supported; method Merge() should do the merge if possible and return true in that case and false otherwise.

Member Function Documentation

◆ DumpJson()

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

Dumps the content of me into the stream.

Reimplemented in Message_AlertExtended.

◆ GetMessageKey()

virtual Standard_CString Message_Alert::GetMessageKey ( ) const
virtual

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 in Message_AlertExtended.

◆ Merge()

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

If possible, merge data contained in this alert to theTarget.

Returns
True if merged. Base implementation always returns true.

Reimplemented in Message_AlertExtended, and TopoDS_AlertWithShape.

◆ SupportsMerge()

virtual Standard_Boolean Message_Alert::SupportsMerge ( ) const
virtual

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

Reimplemented in Message_AlertExtended, and TopoDS_AlertWithShape.


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