Open CASCADE Technology 6.6.0
Public Member Functions
PCDM_StorageDriver Class Reference

persistent implemention of storage.

The application must redefine one the two Make()
methods. The first one, if the application wants to
put only one document in the storage file.

The second method should be redefined to put
additional document that could be used by the
retrieval instead of the principal document, depending
on the schema used during the retrieval. For example,
a second document could be a standard
CDMShape_Document. This means that a client
application will already be able to extract a CDMShape_Document
of the file, if the Shape Schema remains unchanged.

#include <PCDM_StorageDriver.hxx>

Inheritance diagram for PCDM_StorageDriver:
Inheritance graph
[legend]

Public Member Functions

virtual Handle_PCDM_Document Make (const Handle< CDM_Document > &aDocument)
 raises NotImplemented.

virtual void Make (const Handle< CDM_Document > &aDocument, PCDM_SequenceOfDocument &Documents)
 By default, puts in the Sequence the document returns
by the previous Make method.


virtual TCollection_ExtendedString SchemaName () const =0
virtual void LoadExtensions (const Handle< Storage_Schema > &aSchema, const TColStd_SequenceOfExtendedString &Extensions)
virtual void Write (const Handle< CDM_Document > &aDocument, const TCollection_ExtendedString &aFileName)
 Warning! raises DriverError if an error occurs during inside the
Make method.
//! stores the content of the Document into a new file.

by default Write will use Make method to build a persistent
document and the Schema method to write the persistent document.


void SetFormat (const TCollection_ExtendedString &aformat)
TCollection_ExtendedString GetFormat () const
Standard_Boolean IsError () const
void SetIsError (const Standard_Boolean theIsError)
PCDM_StoreStatus GetStoreStatus () const
void SetStoreStatus (const PCDM_StoreStatus theStoreStatus)

Member Function Documentation

TCollection_ExtendedString PCDM_StorageDriver::GetFormat ( ) const
PCDM_StoreStatus PCDM_StorageDriver::GetStoreStatus ( ) const
Standard_Boolean PCDM_StorageDriver::IsError ( ) const
virtual void PCDM_StorageDriver::LoadExtensions ( const Handle< Storage_Schema > &  aSchema,
const TColStd_SequenceOfExtendedString Extensions 
) [virtual]
virtual Handle_PCDM_Document PCDM_StorageDriver::Make ( const Handle< CDM_Document > &  aDocument) [virtual]

Reimplemented in MDocStd_DocumentStorageDriver.

virtual void PCDM_StorageDriver::Make ( const Handle< CDM_Document > &  aDocument,
PCDM_SequenceOfDocument Documents 
) [virtual]
virtual TCollection_ExtendedString PCDM_StorageDriver::SchemaName ( ) const [pure virtual]
void PCDM_StorageDriver::SetFormat ( const TCollection_ExtendedString aformat)
void PCDM_StorageDriver::SetIsError ( const Standard_Boolean  theIsError)
void PCDM_StorageDriver::SetStoreStatus ( const PCDM_StoreStatus  theStoreStatus)
virtual void PCDM_StorageDriver::Write ( const Handle< CDM_Document > &  aDocument,
const TCollection_ExtendedString aFileName 
) [virtual]

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines