Open CASCADE Technology  7.4.0.beta
Public Member Functions
MoniTool_SignText Class Referenceabstract

Provides the basic service to get a text which identifies an object in a context It can be used for other classes (general signatures ...) It can also be used to build a message in which an object is to be identified. More...

#include <MoniTool_SignText.hxx>

Inheritance diagram for MoniTool_SignText:
Inheritance graph
[legend]

Public Member Functions

virtual Standard_CString Name () const =0
 Returns an identification of the Signature (a word), given at initialization time. More...
 
virtual TCollection_AsciiString TextAlone (const Handle< Standard_Transient > &ent) const
 Gives a text as a signature for a transient object alone, i.e. without defined context. By default, calls Text with undefined context (Null Handle) and if empty, then returns DynamicType. More...
 
virtual TCollection_AsciiString Text (const Handle< Standard_Transient > &ent, const Handle< Standard_Transient > &context) const =0
 Gives a text as a signature for a transient object in a context If the context is senseless, it can be given as Null Handle empty result if nothing to give (at least the DynamicType could be sent ?) 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

Provides the basic service to get a text which identifies an object in a context It can be used for other classes (general signatures ...) It can also be used to build a message in which an object is to be identified.

Member Function Documentation

◆ Name()

virtual Standard_CString MoniTool_SignText::Name ( ) const
pure virtual

Returns an identification of the Signature (a word), given at initialization time.

Implemented in IFSelect_Signature, MoniTool_SignShape, and Interface_SignLabel.

◆ Text()

virtual TCollection_AsciiString MoniTool_SignText::Text ( const Handle< Standard_Transient > &  ent,
const Handle< Standard_Transient > &  context 
) const
pure virtual

Gives a text as a signature for a transient object in a context If the context is senseless, it can be given as Null Handle empty result if nothing to give (at least the DynamicType could be sent ?)

Implemented in MoniTool_SignShape, Interface_SignLabel, and Interface_SignType.

◆ TextAlone()

virtual TCollection_AsciiString MoniTool_SignText::TextAlone ( const Handle< Standard_Transient > &  ent) const
virtual

Gives a text as a signature for a transient object alone, i.e. without defined context. By default, calls Text with undefined context (Null Handle) and if empty, then returns DynamicType.


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