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. More... | |
| void | Add (const Handle< CDM_Document > &aDocument) |
| adds a document into the directory. More... | |
| void | Remove (const Handle< CDM_Document > &aDocument) |
| removes the document. More... | |
| Standard_Boolean | Contains (const Handle< CDM_Document > &aDocument) const |
| Returns true if the document aDocument is in the directory. More... | |
| Handle< CDM_Document > | Last () |
| returns the last document (if any) which has been added in the directory. More... | |
| Standard_Integer | Length () const |
| returns the number of documents of the directory. More... | |
| Standard_Boolean | IsEmpty () const |
| returns true if the directory is empty. More... | |
 Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. More... | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. More... | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. More... | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. More... | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. More... | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. More... | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. More... | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. More... | |
| Standard_Boolean | 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. More... | |
| Standard_Boolean | IsKind (const Standard_CString 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. More... | |
| 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. More... | |
| Standard_Integer | GetRefCount () const |
| Get the reference counter of this object. More... | |
| void | IncrementRefCounter () const |
| Increments the reference counter of this object. More... | |
| Standard_Integer | DecrementRefCounter () const |
| Decrements the reference counter of this object; returns the decremented value. More... | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. More... | |
| Static Public Member Functions inherited from Standard_Transient | |
| static const char * | get_type_name () |
| Returns a type descriptor about this object. More... | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. More... | |
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 Handle< CDM_Document > & | aDocument | ) |
adds a document into the directory.
◆ Contains()
| Standard_Boolean CDF_Directory::Contains | ( | const Handle< CDM_Document > & | aDocument | ) | const |
Returns true if the document aDocument is in the directory.
◆ IsEmpty()
| Standard_Boolean CDF_Directory::IsEmpty | ( | ) | const |
returns true if the directory is empty.
◆ Last()
| Handle< CDM_Document > CDF_Directory::Last | ( | ) |
returns the last document (if any) which has been added in the directory.
◆ Length()
| Standard_Integer CDF_Directory::Length | ( | ) | const |
returns the number of documents of the directory.
◆ Remove()
| void CDF_Directory::Remove | ( | const Handle< CDM_Document > & | aDocument | ) |
removes the document.
The documentation for this class was generated from the following file:
