persistent implemention of storage. More...
#include <PCDM_StorageDriver.hxx>
Public Member Functions | |
| virtual Handle< PCDM_Document > | Make (const Handle< CDM_Document > &aDocument) |
| raises NotImplemented. More... | |
| 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. More... | |
| 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) override |
| Warning! raises DriverError if an error occurs during inside the Make method. stores the content of the Document into a new file. More... | |
| virtual void | Write (const Handle< CDM_Document > &theDocument, Standard_OStream &theOStream) override |
| Write <theDocument> to theOStream. More... | |
| 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) |
 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 opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. More... | |
| Standard_Boolean | IsInstance (const opencascade::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 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. 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... | |
| 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. More... | |
| Standard_Integer | GetRefCount () const |
| Get the reference counter of this object. More... | |
| void | IncrementRefCounter () const |
| Increments the reference counter of this object. More... | |
| Standard_Integer | DecrementRefCounter () const |
| Decrements the reference counter of this object; returns the decremented value. More... | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. More... | |
| Static Public Member Functions inherited from Standard_Transient | |
| static const char * | get_type_name () |
| Returns a type descriptor about this object. More... | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. More... | |
Detailed Description
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.
Member Function Documentation
| TCollection_ExtendedString PCDM_StorageDriver::GetFormat | ( | ) | const |
| PCDM_StoreStatus PCDM_StorageDriver::GetStoreStatus | ( | ) | const |
| Standard_Boolean PCDM_StorageDriver::IsError | ( | ) | const |
|
virtual |
|
virtual |
raises NotImplemented.
|
virtual |
By default, puts in the Sequence the document returns by the previous Make method.
|
pure virtual |
Implemented in BinLDrivers_DocumentStorageDriver, and XmlLDrivers_DocumentStorageDriver.
| void PCDM_StorageDriver::SetFormat | ( | const TCollection_ExtendedString & | aformat | ) |
| void PCDM_StorageDriver::SetIsError | ( | const Standard_Boolean | theIsError | ) |
| void PCDM_StorageDriver::SetStoreStatus | ( | const PCDM_StoreStatus | theStoreStatus | ) |
|
overridevirtual |
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.
Implements PCDM_Writer.
Reimplemented in BinLDrivers_DocumentStorageDriver, and XmlLDrivers_DocumentStorageDriver.
|
overridevirtual |
Write <theDocument> to theOStream.
Implements PCDM_Writer.
Reimplemented in BinLDrivers_DocumentStorageDriver, and XmlLDrivers_DocumentStorageDriver.
The documentation for this class was generated from the following file:
