OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    Interface_SignType Class Referenceabstract

    Provides the basic service to get a type name, according to a norm It can be used for other classes (general signatures ...). More...

    #include <Interface_SignType.hxx>

    Inheritance diagram for Interface_SignType:

    Public Member Functions

    TCollection_AsciiString Text (const occ::handle< Standard_Transient > &ent, const occ::handle< Standard_Transient > &context) const override
     Returns an identification of the Signature (a word), given at initialization time Specialised to consider context as an InterfaceModel.
    virtual const char * Value (const occ::handle< Standard_Transient > &ent, const occ::handle< Interface_InterfaceModel > &model) const =0
     Returns the Signature for a Transient object. It is specific of each sub-class of Signature. For a Null Handle, it should provide "" It can work with the model which contains the entity.
    Public Member Functions inherited from MoniTool_SignText
    virtual const char * Name () const =0
     Returns an identification of the Signature (a word), given at initialization time.
    virtual TCollection_AsciiString TextAlone (const occ::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.
    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 ()=default
     Destructor must be virtual.
    virtual const opencascade::handle< Standard_Type > & DynamicType () const
     Returns a type descriptor about this object.
    bool IsInstance (const opencascade::handle< Standard_Type > &theType) const
     Returns a true value if this is an instance of Type.
    bool IsInstance (const char *const theTypeName) const
     Returns a true value if this is an instance of TypeName.
    bool 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.
    bool IsKind (const char *const 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.
    int GetRefCount () const noexcept
     Get the reference counter of this object.
    void IncrementRefCounter () noexcept
     Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
    int DecrementRefCounter () noexcept
     Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
    virtual void Delete () const
     Memory deallocator for transient classes.

    Static Public Member Functions

    static const char * ClassName (const char *const typnam)
     From a CDL Type Name, returns the Class part (package dropped) WARNING : buffered, to be immediately copied or printed.
    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

    typedef void base_type
     Returns a type descriptor about this object.

    Detailed Description

    Provides the basic service to get a type name, according to a norm It can be used for other classes (general signatures ...).

    Member Function Documentation

    ◆ ClassName()

    const char * Interface_SignType::ClassName ( const char *const typnam)
    static

    From a CDL Type Name, returns the Class part (package dropped) WARNING : buffered, to be immediately copied or printed.

    ◆ Text()

    TCollection_AsciiString Interface_SignType::Text ( const occ::handle< Standard_Transient > & ent,
    const occ::handle< Standard_Transient > & context ) const
    overridevirtual

    Returns an identification of the Signature (a word), given at initialization time Specialised to consider context as an InterfaceModel.

    Implements MoniTool_SignText.

    ◆ Value()

    virtual const char * Interface_SignType::Value ( const occ::handle< Standard_Transient > & ent,
    const occ::handle< Interface_InterfaceModel > & model ) const
    pure virtual

    Returns the Signature for a Transient object. It is specific of each sub-class of Signature. For a Null Handle, it should provide "" It can work with the model which contains the entity.

    Implemented in IFSelect_SignCategory, IFSelect_SignMultiple, IFSelect_SignType, IFSelect_SignValidity, IGESSelect_IGESName, IGESSelect_IGESTypeForm, IGESSelect_SignColor, IGESSelect_SignLevelNumber, IGESSelect_SignStatus, StepSelect_StepType, and XSControl_SignTransferStatus.


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