Alert attribute object storing TopoDS shape in its field. More...
#include <TopoDS_AlertAttribute.hxx>
Inheritance diagram for TopoDS_AlertAttribute:
Public Member Functions | |
| TopoDS_AlertAttribute (const TopoDS_Shape &theShape, const TCollection_AsciiString &theName=TCollection_AsciiString()) | |
| Constructor with shape argument. | |
| const TopoDS_Shape & | GetShape () const |
| Returns contained shape. | |
| void | DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override |
| Dumps the content of me into the stream. | |
 Public Member Functions inherited from Message_AttributeStream | |
| Message_AttributeStream (const Standard_SStream &theStream, const TCollection_AsciiString &theName=TCollection_AsciiString()) | |
| Constructor with string argument. | |
| const Standard_SStream & | Stream () const |
| Returns stream value. | |
| void | SetStream (const Standard_SStream &theStream) |
| Sets stream value. | |
| Public Member Functions inherited from Message_Attribute | |
| Message_Attribute (const TCollection_AsciiString &theName=TCollection_AsciiString()) | |
| Empty constructor. | |
| 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. | |
| const TCollection_AsciiString & | GetName () const |
| Returns custom name of alert if it is set. | |
| void | SetName (const TCollection_AsciiString &theName) |
| Sets the custom name of alert. | |
| Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. | |
| 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. | |
| 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. | |
| Standard_Transient * | This () 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. | |
| Standard_Integer | GetRefCount () const noexcept |
| Get the reference counter of this object. | |
| void | IncrementRefCounter () noexcept |
| Increments the reference counter of this object. | |
| Standard_Integer | DecrementRefCounter () noexcept |
| Decrements the reference counter of this object; returns the decremented value. | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. | |
Static Public Member Functions | |
| static void | Send (const Handle< Message_Messenger > &theMessenger, const TopoDS_Shape &theShape) |
| Push shape information into messenger. | |
| Static Public Member Functions inherited from Standard_Transient | |
| static constexpr const char * | get_type_name () |
| Returns a type descriptor about this object. | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. | |
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()
|
overridevirtual |
Dumps the content of me into the stream.
Reimplemented from Message_AttributeStream.
◆ GetShape()
|
inline |
Returns contained shape.
◆ Send()
|
static |
Push shape information into messenger.
The documentation for this class was generated from the following file:
