#include <CDF_FWOSDriver.hxx>

Inheritance diagram for CDF_FWOSDriver:

[legend]

Public Member Functions
	CDF_FWOSDriver (CDM_MetaDataLookUpTable &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.

Standard_Boolean	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

Standard_Boolean	HasReadPermission (const TCollection_ExtendedString &aFolder, const TCollection_ExtendedString &aName, const TCollection_ExtendedString &aVersion) override

Standard_Boolean	FindFolder (const TCollection_ExtendedString &aFolder) override

TCollection_ExtendedString	DefaultFolder () override

TCollection_ExtendedString	BuildFileName (const Handle< CDM_Document > &aDocument) override

virtual TCollection_ExtendedString	SetName (const 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 CDF_MetaDataDriver
virtual Standard_Boolean	HasVersionCapability ()
	returns true if the MetaDataDriver can manage different versions of a Data. By default, returns Standard_False.

virtual void	CreateDependsOn (const Handle< CDM_MetaData > &aFirstData, const Handle< CDM_MetaData > &aSecondData)
	Creates a "Depends On" relation between two Datas. By default does nothing.

virtual void	CreateReference (const Handle< CDM_MetaData > &aFrom, const Handle< CDM_MetaData > &aTo, const Standard_Integer aReferenceIdentifier, const Standard_Integer aToDocumentVersion)

virtual Standard_Boolean	HasVersion (const TCollection_ExtendedString &aFolder, const TCollection_ExtendedString &aName)
	by default return Standard_True.

virtual Handle< CDM_MetaData >	LastVersion (const Handle< CDM_MetaData > &aMetaData)
	by default returns aMetaDATA should return the MetaData stored in the DBMS with the meta-data corresponding to the path. If the MetaDataDriver has version management capabilities the version has to be set in the returned MetaData. MetaData is called by GetMetaData If the version is not included in the path , MetaData should return the last version of the metadata is deferred;

virtual Handle< PCDM_ReferenceIterator >	ReferenceIterator (const Handle< Message_Messenger > &theMessageDriver)

Standard_Boolean	Find (const TCollection_ExtendedString &aFolder, const TCollection_ExtendedString &aName)
	calls Find with an empty version

Handle< CDM_MetaData >	MetaData (const TCollection_ExtendedString &aFolder, const TCollection_ExtendedString &aName)
	calls MetaData with an empty version

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 ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

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.

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.

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.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

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 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.

Protected Member Functions inherited from CDF_MetaDataDriver
	CDF_MetaDataDriver ()

Constructor & Destructor Documentation

◆ CDF_FWOSDriver()

CDF_FWOSDriver::CDF_FWOSDriver ( CDM_MetaDataLookUpTable & 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 Handle< CDM_Document > & aDocument )

overridevirtual

Implements CDF_MetaDataDriver.

◆ DefaultFolder()

TCollection_ExtendedString CDF_FWOSDriver::DefaultFolder ( )

overridevirtual

Implements CDF_MetaDataDriver.

◆ Find()

Standard_Boolean 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()

Standard_Boolean CDF_FWOSDriver::FindFolder ( const TCollection_ExtendedString & aFolder )

overridevirtual

Implements CDF_MetaDataDriver.

◆ HasReadPermission()

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

overridevirtual

Implements CDF_MetaDataDriver.

◆ SetName()

virtual TCollection_ExtendedString CDF_FWOSDriver::SetName	(	const 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:

CDF_FWOSDriver.hxx

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ CDF_FWOSDriver()

Member Function Documentation

◆ BuildFileName()

◆ DefaultFolder()

◆ Find()

◆ FindFolder()

◆ HasReadPermission()

◆ SetName()