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
    StepBasic_ActionMethod Class Reference

    Representation of STEP entity ActionMethod. More...

    #include <StepBasic_ActionMethod.hxx>

    Inheritance diagram for StepBasic_ActionMethod:

    Public Member Functions

     StepBasic_ActionMethod ()
     Empty constructor.
    void Init (const occ::handle< TCollection_HAsciiString > &aName, const bool hasDescription, const occ::handle< TCollection_HAsciiString > &aDescription, const occ::handle< TCollection_HAsciiString > &aConsequence, const occ::handle< TCollection_HAsciiString > &aPurpose)
     Initialize all fields (own and inherited).
    occ::handle< TCollection_HAsciiStringName () const
     Returns field Name.
    void SetName (const occ::handle< TCollection_HAsciiString > &Name)
     Set field Name.
    occ::handle< TCollection_HAsciiStringDescription () const
     Returns field Description.
    void SetDescription (const occ::handle< TCollection_HAsciiString > &Description)
     Set field Description.
    bool HasDescription () const
     Returns True if optional field Description is defined.
    occ::handle< TCollection_HAsciiStringConsequence () const
     Returns field Consequence.
    void SetConsequence (const occ::handle< TCollection_HAsciiString > &Consequence)
     Set field Consequence.
    occ::handle< TCollection_HAsciiStringPurpose () const
     Returns field Purpose.
    void SetPurpose (const occ::handle< TCollection_HAsciiString > &Purpose)
     Set field Purpose.
    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 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

    Representation of STEP entity ActionMethod.

    Constructor & Destructor Documentation

    ◆ StepBasic_ActionMethod()

    StepBasic_ActionMethod::StepBasic_ActionMethod ( )

    Empty constructor.

    Member Function Documentation

    ◆ Consequence()

    occ::handle< TCollection_HAsciiString > StepBasic_ActionMethod::Consequence ( ) const

    Returns field Consequence.

    ◆ Description()

    occ::handle< TCollection_HAsciiString > StepBasic_ActionMethod::Description ( ) const

    Returns field Description.

    ◆ HasDescription()

    bool StepBasic_ActionMethod::HasDescription ( ) const

    Returns True if optional field Description is defined.

    ◆ Init()

    void StepBasic_ActionMethod::Init ( const occ::handle< TCollection_HAsciiString > & aName,
    const bool hasDescription,
    const occ::handle< TCollection_HAsciiString > & aDescription,
    const occ::handle< TCollection_HAsciiString > & aConsequence,
    const occ::handle< TCollection_HAsciiString > & aPurpose )

    Initialize all fields (own and inherited).

    ◆ Name()

    occ::handle< TCollection_HAsciiString > StepBasic_ActionMethod::Name ( ) const

    Returns field Name.

    ◆ Purpose()

    occ::handle< TCollection_HAsciiString > StepBasic_ActionMethod::Purpose ( ) const

    Returns field Purpose.

    ◆ SetConsequence()

    void StepBasic_ActionMethod::SetConsequence ( const occ::handle< TCollection_HAsciiString > & Consequence)

    Set field Consequence.

    ◆ SetDescription()

    void StepBasic_ActionMethod::SetDescription ( const occ::handle< TCollection_HAsciiString > & Description)

    Set field Description.

    ◆ SetName()

    void StepBasic_ActionMethod::SetName ( const occ::handle< TCollection_HAsciiString > & Name)

    Set field Name.

    ◆ SetPurpose()

    void StepBasic_ActionMethod::SetPurpose ( const occ::handle< TCollection_HAsciiString > & Purpose)

    Set field Purpose.


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