CDF_Directory Class Reference

A directory is a collection of documents. There is only one instance of a given document in a directory. put. More...

#include <CDF_Directory.hxx>

Inheritance diagram for CDF_Directory:

Public Member Functions
	CDF_Directory ()
	Creates an empty directory.
void	Add (const occ::handle< CDM_Document > &aDocument)
	adds a document into the directory.
void	Remove (const occ::handle< CDM_Document > &aDocument)
	removes the document.
bool	Contains (const occ::handle< CDM_Document > &aDocument) const
	Returns true if the document aDocument is in the directory.
occ::handle< CDM_Document >	Last ()
	returns the last document (if any) which has been added in the directory.
int	Length () const
	returns the number of documents of the directory.
bool	IsEmpty () const
	returns true if the directory is empty.
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.

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

A directory is a collection of documents. There is only one instance of a given document in a directory. put.

Constructor & Destructor Documentation

CDF_Directory()

CDF_Directory::CDF_Directory

(

)

Creates an empty directory.

Member Function Documentation

Add()

void CDF_Directory::Add

(

const occ::handle< CDM_Document > &

aDocument

)

adds a document into the directory.

Contains()

bool CDF_Directory::Contains

(

const occ::handle< CDM_Document > &

aDocument

)

const

Returns true if the document aDocument is in the directory.

IsEmpty()

bool CDF_Directory::IsEmpty

(

)

const

returns true if the directory is empty.

Last()

occ::handle< CDM_Document > CDF_Directory::Last

(

)

returns the last document (if any) which has been added in the directory.

Length()

int CDF_Directory::Length

(

)

const

returns the number of documents of the directory.

Remove()

void CDF_Directory::Remove

(

const occ::handle< CDM_Document > &

aDocument

)

removes the document.

---

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

• CDF_Directory.hxx