Open CASCADE Technology Reference Manual 8.0.0
Loading...
Searching...
No Matches
Public Member Functions
CDF_FWOSDriver Class Reference

#include <CDF_FWOSDriver.hxx>

Inheritance diagram for CDF_FWOSDriver:
Inheritance graph
[legend]

Public Member Functions

 CDF_FWOSDriver (NCollection_DataMap< TCollection_ExtendedString, occ::handle< CDM_MetaData > > &theLookUpTable)
 Initializes the MetaDatadriver connected to specified look-up table. Note that the created driver will keep reference to the table, thus it must have life time longer than this object.
 
bool Find (const TCollection_ExtendedString &aFolder, const TCollection_ExtendedString &aName, const TCollection_ExtendedString &aVersion) override
 indicate whether a file exists corresponding to the folder and the name
 
bool HasReadPermission (const TCollection_ExtendedString &aFolder, const TCollection_ExtendedString &aName, const TCollection_ExtendedString &aVersion) override
 
bool FindFolder (const TCollection_ExtendedString &aFolder) override
 
TCollection_ExtendedString DefaultFolder () override
 
TCollection_ExtendedString BuildFileName (const occ::handle< CDM_Document > &aDocument) override
 
TCollection_ExtendedString SetName (const occ::handle< CDM_Document > &aDocument, const TCollection_ExtendedString &aName) override
 this method is useful if the name of an object depends on the metadatadriver. For example a Driver based on the operating system can choose to add the extension of file to create to the object.
 
- 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

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object.
 
- Static Public Member Functions inherited from Standard_Transient
static constexpr const charget_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.
 

Constructor & Destructor Documentation

◆ CDF_FWOSDriver()

CDF_FWOSDriver::CDF_FWOSDriver ( NCollection_DataMap< TCollection_ExtendedString, occ::handle< CDM_MetaData > > & theLookUpTable)

Initializes the MetaDatadriver connected to specified look-up table. Note that the created driver will keep reference to the table, thus it must have life time longer than this object.

Member Function Documentation

◆ BuildFileName()

TCollection_ExtendedString CDF_FWOSDriver::BuildFileName ( const occ::handle< CDM_Document > & aDocument)
overridevirtual

Implements CDF_MetaDataDriver.

◆ DefaultFolder()

TCollection_ExtendedString CDF_FWOSDriver::DefaultFolder ( )
overridevirtual

Implements CDF_MetaDataDriver.

◆ Find()

bool CDF_FWOSDriver::Find ( const TCollection_ExtendedString & aFolder,
const TCollection_ExtendedString & aName,
const TCollection_ExtendedString & aVersion )
overridevirtual

indicate whether a file exists corresponding to the folder and the name

Implements CDF_MetaDataDriver.

◆ FindFolder()

bool CDF_FWOSDriver::FindFolder ( const TCollection_ExtendedString & aFolder)
overridevirtual

Implements CDF_MetaDataDriver.

◆ HasReadPermission()

bool CDF_FWOSDriver::HasReadPermission ( const TCollection_ExtendedString & aFolder,
const TCollection_ExtendedString & aName,
const TCollection_ExtendedString & aVersion )
overridevirtual

Implements CDF_MetaDataDriver.

◆ SetName()

TCollection_ExtendedString CDF_FWOSDriver::SetName ( const occ::handle< CDM_Document > & aDocument,
const TCollection_ExtendedString & aName )
overridevirtual

this method is useful if the name of an object depends on the metadatadriver. For example a Driver based on the operating system can choose to add the extension of file to create to the object.

Reimplemented from CDF_MetaDataDriver.


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