Open CASCADE Technology  7.5.0
Public Member Functions | Static Public Member Functions

TopoDS_AlertAttribute Class Reference

Alert attribute object storing TopoDS shape in its field. More...

#include <TopoDS_AlertAttribute.hxx>

Inheritance diagram for TopoDS_AlertAttribute:
Inheritance graph
[legend]

Public Member Functions

 TopoDS_AlertAttribute (const TopoDS_Shape &theShape, const TCollection_AsciiString &theName=TCollection_AsciiString())
 Constructor with shape argument. More...
 
const TopoDS_ShapeGetShape () const
 Returns contained shape. More...
 
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 Message_AttributeStream
 Message_AttributeStream (const Standard_SStream &theStream, const TCollection_AsciiString &theName=TCollection_AsciiString())
 Constructor with string argument. More...
 
const Standard_SStreamStream () const
 Returns stream value. More...
 
void SetStream (const Standard_SStream &theStream)
 Sets stream value. More...
 
- Public Member Functions inherited from Message_Attribute
 Message_Attribute (const TCollection_AsciiString &theName=TCollection_AsciiString())
 Empty constructor. More...
 
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...
 
const TCollection_AsciiStringGetName () const
 Returns custom name of alert if it is set. More...
 
void SetName (const TCollection_AsciiString &theName)
 Sets the custom name of alert. 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 void Send (const Handle< Message_Messenger > &theMessenger, const TopoDS_Shape &theShape)
 Push shape information into messenger. 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...
 

Additional Inherited Members

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

Detailed Description

Alert attribute object storing TopoDS shape in its field.

Constructor & Destructor Documentation

◆ TopoDS_AlertAttribute()

TopoDS_AlertAttribute::TopoDS_AlertAttribute ( const TopoDS_Shape theShape,
const TCollection_AsciiString theName = TCollection_AsciiString() 
)

Constructor with shape argument.

Member Function Documentation

◆ DumpJson()

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

Dumps the content of me into the stream.

Reimplemented from Message_AttributeStream.

◆ GetShape()

const TopoDS_Shape& TopoDS_AlertAttribute::GetShape ( ) const
inline

Returns contained shape.

◆ Send()

static void TopoDS_AlertAttribute::Send ( const Handle< Message_Messenger > &  theMessenger,
const TopoDS_Shape theShape 
)
static

Push shape information into messenger.


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