OCCT3D OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    IGESDimen_Protocol Class Reference

    Description of Protocol for IGESDimen. More...

    #include <IGESDimen_Protocol.hxx>

    Inheritance diagram for IGESDimen_Protocol:

    Public Member Functions

     IGESDimen_Protocol ()
    int NbResources () const override
     Gives the count of Resource Protocol. Here, two (Protocols from IGESGraph and IGESGeom).
    occ::handle< Interface_ProtocolResource (const int numnum) const override
     Returns a Resource, given a rank.
    int TypeNumber (const occ::handle< Standard_Type > &atype) const override
     Returns a Case Number, specific of each recognized Type This Case Number is then used in Libraries : the various Modules attached to this class of Protocol must use them in accordance (for a given value of TypeNumber, they must consider the same Type as the Protocol defines).
    Public Member Functions inherited from IGESData_Protocol
     IGESData_Protocol ()
    occ::handle< Interface_InterfaceModelNewModel () const override
     Creates an empty Model for IGES Norm.
    bool IsSuitableModel (const occ::handle< Interface_InterfaceModel > &model) const override
     Returns True if <model> is a Model of IGES Norm.
    occ::handle< Standard_TransientUnknownEntity () const override
     Creates a new Unknown Entity for IGES (UndefinedEntity).
    bool IsUnknownEntity (const occ::handle< Standard_Transient > &ent) const override
     Returns True if <ent> is an Unknown Entity for the Norm, i.e. Type UndefinedEntity, status Unknown.
    Public Member Functions inherited from Interface_Protocol
    virtual int CaseNumber (const occ::handle< Standard_Transient > &objobj) const
     Returns a unique positive CaseNumber for each Recognized Object. By default, recognition is based on Type(1) By default, calls the following one which is deferred.
    virtual bool IsDynamicType (const occ::handle< Standard_Transient > &objobj) const
     Returns True if type of <obj> is that defined from CDL This is the default but it may change according implementation.
    virtual int NbTypes (const occ::handle< Standard_Transient > &objobj) const
     Returns the count of DISTINCT types under which an entity may be processed. Each one is candidate to be recognized by TypeNumber, <obj> is then processed according it By default, returns 1 (the DynamicType).
    occ::handle< Standard_TypeType (const occ::handle< Standard_Transient > &objobj, const int nt=1) const
     Returns a type under which <obj> can be recognized and processed, according its rank in its definition list (see NbTypes). By default, returns DynamicType.
    virtual bool GlobalCheck (const Interface_Graph &G, occ::handle< Interface_Check > &ach) const
     Evaluates a Global Check for a model (with its Graph) Returns True when done, False if data in model do not apply.
    Public Member Functions inherited from Standard_Transient
     Standard_Transient ()
     Empty constructor.
     Standard_Transient (const Standard_Transient &)
     Copy constructor – does nothing.
    Standard_Transientoperator= (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_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.
    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.

    Additional Inherited Members

    typedef void base_type
     Returns a type descriptor about this object.
    Static Public Member Functions inherited from Interface_Protocol
    static occ::handle< Interface_ProtocolActive ()
     Returns the Active Protocol, if defined (else, returns a Null Handle, which means "no defined active protocol").
    static void SetActive (const occ::handle< Interface_Protocol > &aprotocol)
     Sets a given Protocol to be the Active one (for the users of Active, see just above). Applies to every sub-type of Protocol.
    static void ClearActive ()
     Erases the Active Protocol (hence it becomes undefined).
    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.

    Detailed Description

    Description of Protocol for IGESDimen.

    Constructor & Destructor Documentation

    ◆ IGESDimen_Protocol()

    IGESDimen_Protocol::IGESDimen_Protocol ( )

    Member Function Documentation

    ◆ NbResources()

    int IGESDimen_Protocol::NbResources ( ) const
    overridevirtual

    Gives the count of Resource Protocol. Here, two (Protocols from IGESGraph and IGESGeom).

    Reimplemented from IGESData_Protocol.

    ◆ Resource()

    occ::handle< Interface_Protocol > IGESDimen_Protocol::Resource ( const int num) const
    overridevirtual

    Returns a Resource, given a rank.

    Reimplemented from IGESData_Protocol.

    ◆ TypeNumber()

    int IGESDimen_Protocol::TypeNumber ( const occ::handle< Standard_Type > & atype) const
    overridevirtual

    Returns a Case Number, specific of each recognized Type This Case Number is then used in Libraries : the various Modules attached to this class of Protocol must use them in accordance (for a given value of TypeNumber, they must consider the same Type as the Protocol defines).

    Reimplemented from IGESData_Protocol.


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