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

    Representation of STEP entity ProductDefinitionRelationship. More...

    #include <StepBasic_ProductDefinitionRelationship.hxx>

    Inheritance diagram for StepBasic_ProductDefinitionRelationship:

    Public Member Functions

     StepBasic_ProductDefinitionRelationship ()
     Empty constructor.
    void Init (const occ::handle< TCollection_HAsciiString > &aId, const occ::handle< TCollection_HAsciiString > &aName, const bool hasDescription, const occ::handle< TCollection_HAsciiString > &aDescription, const occ::handle< StepBasic_ProductDefinition > &aRelatingProductDefinition, const occ::handle< StepBasic_ProductDefinition > &aRelatedProductDefinition)
     Initialize all fields (own and inherited).
    void Init (const occ::handle< TCollection_HAsciiString > &aId, const occ::handle< TCollection_HAsciiString > &aName, const bool hasDescription, const occ::handle< TCollection_HAsciiString > &aDescription, const StepBasic_ProductDefinitionOrReference &aRelatingProductDefinition, const StepBasic_ProductDefinitionOrReference &aRelatedProductDefinition)
     Initialize all fields (own and inherited).
    occ::handle< TCollection_HAsciiStringId () const
     Returns field Id.
    void SetId (const occ::handle< TCollection_HAsciiString > &Id)
     Set field Id.
    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< StepBasic_ProductDefinitionRelatingProductDefinition () const
     Returns field RelatingProductDefinition.
    StepBasic_ProductDefinitionOrReference RelatingProductDefinitionAP242 () const
     Returns field RelatingProductDefinition in AP242.
    void SetRelatingProductDefinition (const occ::handle< StepBasic_ProductDefinition > &RelatingProductDefinition)
     Set field RelatingProductDefinition.
    void SetRelatingProductDefinition (const StepBasic_ProductDefinitionOrReference &RelatingProductDefinition)
     Set field RelatingProductDefinition in AP242.
    occ::handle< StepBasic_ProductDefinitionRelatedProductDefinition () const
     Returns field RelatedProductDefinition.
    StepBasic_ProductDefinitionOrReference RelatedProductDefinitionAP242 () const
     Returns field RelatedProductDefinition in AP242.
    void SetRelatedProductDefinition (const occ::handle< StepBasic_ProductDefinition > &RelatedProductDefinition)
     Set field RelatedProductDefinition.
    void SetRelatedProductDefinition (const StepBasic_ProductDefinitionOrReference &RelatedProductDefinition)
     Set field RelatedProductDefinition in AP242.
    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 ProductDefinitionRelationship.

    Constructor & Destructor Documentation

    ◆ StepBasic_ProductDefinitionRelationship()

    StepBasic_ProductDefinitionRelationship::StepBasic_ProductDefinitionRelationship ( )

    Empty constructor.

    Member Function Documentation

    ◆ Description()

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

    Returns field Description.

    ◆ HasDescription()

    bool StepBasic_ProductDefinitionRelationship::HasDescription ( ) const

    Returns True if optional field Description is defined.

    ◆ Id()

    occ::handle< TCollection_HAsciiString > StepBasic_ProductDefinitionRelationship::Id ( ) const

    Returns field Id.

    ◆ Init() [1/2]

    void StepBasic_ProductDefinitionRelationship::Init ( const occ::handle< TCollection_HAsciiString > & aId,
    const occ::handle< TCollection_HAsciiString > & aName,
    const bool hasDescription,
    const occ::handle< TCollection_HAsciiString > & aDescription,
    const occ::handle< StepBasic_ProductDefinition > & aRelatingProductDefinition,
    const occ::handle< StepBasic_ProductDefinition > & aRelatedProductDefinition )

    Initialize all fields (own and inherited).

    ◆ Init() [2/2]

    void StepBasic_ProductDefinitionRelationship::Init ( const occ::handle< TCollection_HAsciiString > & aId,
    const occ::handle< TCollection_HAsciiString > & aName,
    const bool hasDescription,
    const occ::handle< TCollection_HAsciiString > & aDescription,
    const StepBasic_ProductDefinitionOrReference & aRelatingProductDefinition,
    const StepBasic_ProductDefinitionOrReference & aRelatedProductDefinition )

    Initialize all fields (own and inherited).

    ◆ Name()

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

    Returns field Name.

    ◆ RelatedProductDefinition()

    occ::handle< StepBasic_ProductDefinition > StepBasic_ProductDefinitionRelationship::RelatedProductDefinition ( ) const

    Returns field RelatedProductDefinition.

    ◆ RelatedProductDefinitionAP242()

    StepBasic_ProductDefinitionOrReference StepBasic_ProductDefinitionRelationship::RelatedProductDefinitionAP242 ( ) const

    Returns field RelatedProductDefinition in AP242.

    ◆ RelatingProductDefinition()

    occ::handle< StepBasic_ProductDefinition > StepBasic_ProductDefinitionRelationship::RelatingProductDefinition ( ) const

    Returns field RelatingProductDefinition.

    ◆ RelatingProductDefinitionAP242()

    StepBasic_ProductDefinitionOrReference StepBasic_ProductDefinitionRelationship::RelatingProductDefinitionAP242 ( ) const

    Returns field RelatingProductDefinition in AP242.

    ◆ SetDescription()

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

    Set field Description.

    ◆ SetId()

    void StepBasic_ProductDefinitionRelationship::SetId ( const occ::handle< TCollection_HAsciiString > & Id)

    Set field Id.

    ◆ SetName()

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

    Set field Name.

    ◆ SetRelatedProductDefinition() [1/2]

    void StepBasic_ProductDefinitionRelationship::SetRelatedProductDefinition ( const occ::handle< StepBasic_ProductDefinition > & RelatedProductDefinition)

    Set field RelatedProductDefinition.

    ◆ SetRelatedProductDefinition() [2/2]

    void StepBasic_ProductDefinitionRelationship::SetRelatedProductDefinition ( const StepBasic_ProductDefinitionOrReference & RelatedProductDefinition)

    Set field RelatedProductDefinition in AP242.

    ◆ SetRelatingProductDefinition() [1/2]

    void StepBasic_ProductDefinitionRelationship::SetRelatingProductDefinition ( const occ::handle< StepBasic_ProductDefinition > & RelatingProductDefinition)

    Set field RelatingProductDefinition.

    ◆ SetRelatingProductDefinition() [2/2]

    void StepBasic_ProductDefinitionRelationship::SetRelatingProductDefinition ( const StepBasic_ProductDefinitionOrReference & RelatingProductDefinition)

    Set field RelatingProductDefinition in AP242.


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