#include <PCDM_RetrievalDriver.hxx>

Inheritance diagram for PCDM_RetrievalDriver:

[legend]

Public Member Functions
virtual void	Read (const TCollection_ExtendedString &aFileName, const Handle< CDM_Document > &aNewDocument, const Handle< CDM_Application > &anApplication)
	Warning - raises DriverError if an error occurs during inside the Make method. retrieves the content of the file into a new Document. More...

virtual void	Make (const Handle< PCDM_Document > &aPCDM, const Handle< CDM_Document > &aNewDocument)=0

virtual TCollection_ExtendedString	SchemaName () const =0

virtual void	LoadExtensions (const Handle< Storage_Schema > &aSchema, const TColStd_SequenceOfExtendedString &Extensions, const Handle< CDM_MessageDriver > &theMsgDriver)

void	SetFormat (const TCollection_ExtendedString &aformat)

TCollection_ExtendedString	GetFormat () const

Public Member Functions inherited from PCDM_Reader
virtual Handle< CDM_Document >	CreateDocument ()=0
	this method is called by the framework before the read method. More...

PCDM_ReaderStatus	GetStatus () const

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 Handle_Standard_Type &	DynamicType () const
	Returns a type information object about this object. More...

Standard_Boolean	IsInstance (const 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 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...

virtual Handle_Standard_Transient	This () const
	Returns a Handle which references this object. Must never be called to objects created in stack. More...

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

Static Public Member Functions
static void	RaiseIfUnknownTypes (const Handle< Storage_Schema > &aSchema, const TCollection_ExtendedString &aFileName)

static Standard_Integer	DocumentVersion (const TCollection_ExtendedString &aFileName, const Handle< CDM_MessageDriver > &theMsgDriver)

static Standard_Integer	ReferenceCounter (const TCollection_ExtendedString &aFileName, const Handle< CDM_MessageDriver > &theMsgDriver)

Friends
void	PCDM_ReferenceIterator::Init (const Handle< CDM_MetaData > &aMetaData)

Additional Inherited Members
Protected Attributes inherited from PCDM_Reader
PCDM_ReaderStatus	myReaderStatus

Member Function Documentation

static Standard_Integer PCDM_RetrievalDriver::DocumentVersion	(	const TCollection_ExtendedString &	aFileName,
		const Handle< CDM_MessageDriver > &	theMsgDriver
	)

static

TCollection_ExtendedString PCDM_RetrievalDriver::GetFormat ( ) const

virtual void PCDM_RetrievalDriver::LoadExtensions	(	const Handle< Storage_Schema > &	aSchema,
		const TColStd_SequenceOfExtendedString &	Extensions,
		const Handle< CDM_MessageDriver > &	theMsgDriver
	)

virtual

virtual void PCDM_RetrievalDriver::Make	(	const Handle< PCDM_Document > &	aPCDM,
		const Handle< CDM_Document > &	aNewDocument
	)

pure virtual

Implemented in BinLDrivers_DocumentRetrievalDriver, MDocStd_DocumentRetrievalDriver, and XmlLDrivers_DocumentRetrievalDriver.

static void PCDM_RetrievalDriver::RaiseIfUnknownTypes	(	const Handle< Storage_Schema > &	aSchema,
		const TCollection_ExtendedString &	aFileName
	)

static

virtual void PCDM_RetrievalDriver::Read	(	const TCollection_ExtendedString &	aFileName,
		const Handle< CDM_Document > &	aNewDocument,
		const Handle< CDM_Application > &	anApplication
	)

virtual

Warning - raises DriverError if an error occurs during inside the Make method. retrieves the content of the file into a new Document.

by default Read will use the Schema method to read the file into a persistent document. and the Make method to build a transient document.

Implements PCDM_Reader.

Reimplemented in BinLDrivers_DocumentRetrievalDriver, and XmlLDrivers_DocumentRetrievalDriver.

static Standard_Integer PCDM_RetrievalDriver::ReferenceCounter	(	const TCollection_ExtendedString &	aFileName,
		const Handle< CDM_MessageDriver > &	theMsgDriver
	)

static

virtual TCollection_ExtendedString PCDM_RetrievalDriver::SchemaName ( ) const

pure virtual

Implemented in BinLDrivers_DocumentRetrievalDriver, MDocStd_DocumentRetrievalDriver, and XmlLDrivers_DocumentRetrievalDriver.

void PCDM_RetrievalDriver::SetFormat ( const TCollection_ExtendedString & aformat )

Friends And Related Function Documentation

void PCDM_ReferenceIterator::Init ( const Handle< CDM_MetaData > & aMetaData )

friend

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

PCDM_RetrievalDriver.hxx

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Member Function Documentation

Friends And Related Function Documentation