OCC Main Page | ApplicationFramework | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

ApplicationFramework
TKCDF
PCDM


PCDM_RetrievalDriver Class Reference

#include <PCDM_RetrievalDriver.hxx>

Inheritance diagram for PCDM_RetrievalDriver:

Inheritance graph
[legend]

Public Member Functions

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

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.

.
virtual Standard_EXPORT void Make (const Handle(PCDM_Document)&aPCDM, const Handle(CDM_Document)&aNewDocument)=0
virtual Standard_EXPORT TCollection_ExtendedString SchemaName () const =0
virtual Standard_EXPORT void LoadExtensions (const Handle(Storage_Schema)&aSchema, const TColStd_SequenceOfExtendedString &Extensions, const Handle(CDM_MessageDriver)&theMsgDriver)
Standard_EXPORT void SetFormat (const TCollection_ExtendedString &aformat)
Standard_EXPORT TCollection_ExtendedString GetFormat () const
Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Static Public Member Functions

static Standard_EXPORT void RaiseIfUnknownTypes (const Handle(Storage_Schema)&aSchema, const TCollection_ExtendedString &aFileName)
static Standard_EXPORT Standard_Integer DocumentVersion (const TCollection_ExtendedString &aFileName, const Handle(CDM_MessageDriver)&theMsgDriver)
static Standard_EXPORT Standard_Integer ReferenceCounter (const TCollection_ExtendedString &aFileName, const Handle(CDM_MessageDriver)&theMsgDriver)

Static Private Member Functions

static Standard_EXPORT void References (const TCollection_ExtendedString &aFileName, PCDM_SequenceOfReference &theReferences, const Handle(CDM_MessageDriver)&theMsgDriver)
static Standard_EXPORT void Extensions (const TCollection_ExtendedString &aFileName, TColStd_SequenceOfExtendedString &theExtensions, const Handle(CDM_MessageDriver)&theMsgDriver)
static Standard_EXPORT void UserInfo (const TCollection_ExtendedString &aFileName, const TCollection_AsciiString &Start, const TCollection_AsciiString &End, TColStd_SequenceOfExtendedString &theUserInfo, const Handle(CDM_MessageDriver)&theMsgDriver)

Private Attributes

TCollection_ExtendedString myFormat

Friends

Standard_EXPORT void PCDM_ReferenceIterator::Init (const Handle(CDM_MetaData)&aMetaData)

Member Function Documentation

static Standard_EXPORT Standard_Integer PCDM_RetrievalDriver::DocumentVersion const TCollection_ExtendedString &  aFileName,
const Handle(CDM_MessageDriver)&  theMsgDriver
[static]
 

static Standard_EXPORT void PCDM_RetrievalDriver::Extensions const TCollection_ExtendedString &  aFileName,
TColStd_SequenceOfExtendedString &  theExtensions,
const Handle(CDM_MessageDriver)&  theMsgDriver
[static, private]
 

Standard_EXPORT TCollection_ExtendedString PCDM_RetrievalDriver::GetFormat  )  const
 

Standard_EXPORT const PCDM_RetrievalDriver::Handle Standard_Type   )  const
 

Reimplemented from PCDM_Reader.

Reimplemented in BinDrivers_DocumentRetrievalDriver, BinLDrivers_DocumentRetrievalDriver, MDocStd_DocumentRetrievalDriver, StdDrivers_DocumentRetrievalDriver, StdLDrivers_DocumentRetrievalDriver, XmlDrivers_DocumentRetrievalDriver, and XmlLDrivers_DocumentRetrievalDriver.

virtual Standard_EXPORT void PCDM_RetrievalDriver::LoadExtensions const Handle(Storage_Schema)&  aSchema,
const TColStd_SequenceOfExtendedString &  Extensions,
const Handle(CDM_MessageDriver)&  theMsgDriver
[virtual]
 

virtual Standard_EXPORT 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 Standard_EXPORT void PCDM_RetrievalDriver::RaiseIfUnknownTypes const Handle(Storage_Schema)&  aSchema,
const TCollection_ExtendedString &  aFileName
[static]
 

virtual Standard_EXPORT void PCDM_RetrievalDriver::Read const TCollection_ExtendedString &  aFileName,
const Handle(CDM_Document)&  aNewDocument,
const Handle(CDM_Application)&  anApplication
[virtual]
 

Implements PCDM_Reader.

Reimplemented in BinLDrivers_DocumentRetrievalDriver, and XmlLDrivers_DocumentRetrievalDriver.

static Standard_EXPORT Standard_Integer PCDM_RetrievalDriver::ReferenceCounter const TCollection_ExtendedString &  aFileName,
const Handle(CDM_MessageDriver)&  theMsgDriver
[static]
 

static Standard_EXPORT void PCDM_RetrievalDriver::References const TCollection_ExtendedString &  aFileName,
PCDM_SequenceOfReference theReferences,
const Handle(CDM_MessageDriver)&  theMsgDriver
[static, private]
 

virtual Standard_EXPORT TCollection_ExtendedString PCDM_RetrievalDriver::SchemaName  )  const [pure virtual]
 

Implemented in BinLDrivers_DocumentRetrievalDriver, MDocStd_DocumentRetrievalDriver, and XmlLDrivers_DocumentRetrievalDriver.

Standard_EXPORT void PCDM_RetrievalDriver::SetFormat const TCollection_ExtendedString &  aformat  ) 
 

static Standard_EXPORT void PCDM_RetrievalDriver::UserInfo const TCollection_ExtendedString &  aFileName,
const TCollection_AsciiString Start,
const TCollection_AsciiString End,
TColStd_SequenceOfExtendedString &  theUserInfo,
const Handle(CDM_MessageDriver)&  theMsgDriver
[static, private]
 


Friends And Related Function Documentation

Standard_EXPORT void PCDM_ReferenceIterator::Init const Handle(CDM_MetaData)&  aMetaData  )  [friend]
 


Field Documentation

TCollection_ExtendedString PCDM_RetrievalDriver::myFormat [private]
 


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 14:13:34 2008 for OpenCASCADE by  doxygen 1.4.1