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

    This class is a set of TDF information like labels and attributes. More...

    #include <TDF_DataSet.hxx>

    Inheritance diagram for TDF_DataSet:

    Public Member Functions

     TDF_DataSet ()
     Creates an empty DataSet object.
    void Clear ()
     Clears all information.
    bool IsEmpty () const
     Returns true if there is at least one label or one attribute.
    void AddLabel (const TDF_Label &aLabel)
     Adds <aLabel> in the current data set.
    bool ContainsLabel (const TDF_Label &aLabel) const
     Returns true if the label <alabel> is in the data set.
    NCollection_Map< TDF_Label > & Labels ()
     Returns the map of labels in this data set. This map can be used directly, or updated.
    void AddAttribute (const occ::handle< TDF_Attribute > &anAttribute)
     Adds <anAttribute> into the current data set.
    bool ContainsAttribute (const occ::handle< TDF_Attribute > &anAttribute) const
     Returns true if <anAttribute> is in the data set.
    NCollection_Map< occ::handle< TDF_Attribute > > & Attributes ()
     Returns the map of attributes in the current data set. This map can be used directly, or updated.
    void AddRoot (const TDF_Label &aLabel)
     Adds a root label to <myRootLabels>.
    NCollection_List< TDF_Label > & Roots ()
     Returns <myRootLabels> to be used or updated.
    Standard_OStreamDump (Standard_OStream &anOS) const
     Dumps the minimum information about <me> on <aStream>.
    Standard_OStreamoperator<< (Standard_OStream &anOS) const
    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

    This class is a set of TDF information like labels and attributes.

    Constructor & Destructor Documentation

    ◆ TDF_DataSet()

    TDF_DataSet::TDF_DataSet ( )

    Creates an empty DataSet object.

    Member Function Documentation

    ◆ AddAttribute()

    void TDF_DataSet::AddAttribute ( const occ::handle< TDF_Attribute > & anAttribute)

    Adds <anAttribute> into the current data set.

    ◆ AddLabel()

    void TDF_DataSet::AddLabel ( const TDF_Label & aLabel)

    Adds <aLabel> in the current data set.

    ◆ AddRoot()

    void TDF_DataSet::AddRoot ( const TDF_Label & aLabel)

    Adds a root label to <myRootLabels>.

    ◆ Attributes()

    NCollection_Map< occ::handle< TDF_Attribute > > & TDF_DataSet::Attributes ( )

    Returns the map of attributes in the current data set. This map can be used directly, or updated.

    ◆ Clear()

    void TDF_DataSet::Clear ( )

    Clears all information.

    ◆ ContainsAttribute()

    bool TDF_DataSet::ContainsAttribute ( const occ::handle< TDF_Attribute > & anAttribute) const

    Returns true if <anAttribute> is in the data set.

    ◆ ContainsLabel()

    bool TDF_DataSet::ContainsLabel ( const TDF_Label & aLabel) const

    Returns true if the label <alabel> is in the data set.

    ◆ Dump()

    Standard_OStream & TDF_DataSet::Dump ( Standard_OStream & anOS) const

    Dumps the minimum information about <me> on <aStream>.

    ◆ IsEmpty()

    bool TDF_DataSet::IsEmpty ( ) const

    Returns true if there is at least one label or one attribute.

    ◆ Labels()

    NCollection_Map< TDF_Label > & TDF_DataSet::Labels ( )

    Returns the map of labels in this data set. This map can be used directly, or updated.

    ◆ operator<<()

    Standard_OStream & TDF_DataSet::operator<< ( Standard_OStream & anOS) const
    inline

    ◆ Roots()

    NCollection_List< TDF_Label > & TDF_DataSet::Roots ( )

    Returns <myRootLabels> to be used or updated.


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