Open CASCADE Technology 7.8.2.dev
|
Root class for drivers. A driver assigns a physical container to data to be stored or retrieved, for instance a file. The FSD package provides two derived concrete classes : More...
#include <Storage_BaseDriver.hxx>
Public Member Functions | |
virtual | ~Storage_BaseDriver () |
TCollection_AsciiString | Name () const |
Storage_OpenMode | OpenMode () const |
Virtual methods, to be provided by descendants | |
virtual Storage_Error | Open (const TCollection_AsciiString &aName, const Storage_OpenMode aMode)=0 |
returns True if we are at end of the stream | |
virtual Standard_Boolean | IsEnd ()=0 |
returns True if we are at end of the stream | |
virtual Storage_Position | Tell ()=0 |
return position in the file. Return -1 upon error. | |
virtual Storage_Error | BeginWriteInfoSection ()=0 |
returns True if we are at end of the stream | |
virtual void | WriteInfo (const Standard_Integer nbObj, const TCollection_AsciiString &dbVersion, const TCollection_AsciiString &date, const TCollection_AsciiString &schemaName, const TCollection_AsciiString &schemaVersion, const TCollection_ExtendedString &appName, const TCollection_AsciiString &appVersion, const TCollection_ExtendedString &objectType, const TColStd_SequenceOfAsciiString &userInfo)=0 |
returns True if we are at end of the stream | |
virtual Storage_Error | EndWriteInfoSection ()=0 |
returns True if we are at end of the stream | |
virtual Storage_Error | BeginReadInfoSection ()=0 |
returns True if we are at end of the stream | |
virtual void | ReadInfo (Standard_Integer &nbObj, TCollection_AsciiString &dbVersion, TCollection_AsciiString &date, TCollection_AsciiString &schemaName, TCollection_AsciiString &schemaVersion, TCollection_ExtendedString &appName, TCollection_AsciiString &appVersion, TCollection_ExtendedString &objectType, TColStd_SequenceOfAsciiString &userInfo)=0 |
returns True if we are at end of the stream | |
virtual void | ReadCompleteInfo (Standard_IStream &theIStream, Handle< Storage_Data > &theData)=0 |
returns True if we are at end of the stream | |
virtual Storage_Error | EndReadInfoSection ()=0 |
returns True if we are at end of the stream | |
virtual Storage_Error | BeginWriteCommentSection ()=0 |
returns True if we are at end of the stream | |
virtual void | WriteComment (const TColStd_SequenceOfExtendedString &userComments)=0 |
returns True if we are at end of the stream | |
virtual Storage_Error | EndWriteCommentSection ()=0 |
returns True if we are at end of the stream | |
virtual Storage_Error | BeginReadCommentSection ()=0 |
returns True if we are at end of the stream | |
virtual void | ReadComment (TColStd_SequenceOfExtendedString &userComments)=0 |
returns True if we are at end of the stream | |
virtual Storage_Error | EndReadCommentSection ()=0 |
returns True if we are at end of the stream | |
virtual Storage_Error | BeginWriteTypeSection ()=0 |
returns True if we are at end of the stream | |
virtual void | SetTypeSectionSize (const Standard_Integer aSize)=0 |
returns True if we are at end of the stream | |
virtual void | WriteTypeInformations (const Standard_Integer typeNum, const TCollection_AsciiString &typeName)=0 |
returns True if we are at end of the stream | |
virtual Storage_Error | EndWriteTypeSection ()=0 |
returns True if we are at end of the stream | |
virtual Storage_Error | BeginReadTypeSection ()=0 |
returns True if we are at end of the stream | |
virtual Standard_Integer | TypeSectionSize ()=0 |
returns True if we are at end of the stream | |
virtual void | ReadTypeInformations (Standard_Integer &typeNum, TCollection_AsciiString &typeName)=0 |
returns True if we are at end of the stream | |
virtual Storage_Error | EndReadTypeSection ()=0 |
returns True if we are at end of the stream | |
virtual Storage_Error | BeginWriteRootSection ()=0 |
returns True if we are at end of the stream | |
virtual void | SetRootSectionSize (const Standard_Integer aSize)=0 |
returns True if we are at end of the stream | |
virtual void | WriteRoot (const TCollection_AsciiString &rootName, const Standard_Integer aRef, const TCollection_AsciiString &aType)=0 |
returns True if we are at end of the stream | |
virtual Storage_Error | EndWriteRootSection ()=0 |
returns True if we are at end of the stream | |
virtual Storage_Error | BeginReadRootSection ()=0 |
returns True if we are at end of the stream | |
virtual Standard_Integer | RootSectionSize ()=0 |
returns True if we are at end of the stream | |
virtual void | ReadRoot (TCollection_AsciiString &rootName, Standard_Integer &aRef, TCollection_AsciiString &aType)=0 |
returns True if we are at end of the stream | |
virtual Storage_Error | EndReadRootSection ()=0 |
returns True if we are at end of the stream | |
virtual Storage_Error | BeginWriteRefSection ()=0 |
returns True if we are at end of the stream | |
virtual void | SetRefSectionSize (const Standard_Integer aSize)=0 |
returns True if we are at end of the stream | |
virtual void | WriteReferenceType (const Standard_Integer reference, const Standard_Integer typeNum)=0 |
returns True if we are at end of the stream | |
virtual Storage_Error | EndWriteRefSection ()=0 |
returns True if we are at end of the stream | |
virtual Storage_Error | BeginReadRefSection ()=0 |
returns True if we are at end of the stream | |
virtual Standard_Integer | RefSectionSize ()=0 |
returns True if we are at end of the stream | |
virtual void | ReadReferenceType (Standard_Integer &reference, Standard_Integer &typeNum)=0 |
returns True if we are at end of the stream | |
virtual Storage_Error | EndReadRefSection ()=0 |
returns True if we are at end of the stream | |
virtual Storage_Error | BeginWriteDataSection ()=0 |
returns True if we are at end of the stream | |
virtual void | WritePersistentObjectHeader (const Standard_Integer aRef, const Standard_Integer aType)=0 |
returns True if we are at end of the stream | |
virtual void | BeginWritePersistentObjectData ()=0 |
returns True if we are at end of the stream | |
virtual void | BeginWriteObjectData ()=0 |
returns True if we are at end of the stream | |
virtual void | EndWriteObjectData ()=0 |
returns True if we are at end of the stream | |
virtual void | EndWritePersistentObjectData ()=0 |
returns True if we are at end of the stream | |
virtual Storage_Error | EndWriteDataSection ()=0 |
returns True if we are at end of the stream | |
virtual Storage_Error | BeginReadDataSection ()=0 |
returns True if we are at end of the stream | |
virtual void | ReadPersistentObjectHeader (Standard_Integer &aRef, Standard_Integer &aType)=0 |
returns True if we are at end of the stream | |
virtual void | BeginReadPersistentObjectData ()=0 |
returns True if we are at end of the stream | |
virtual void | BeginReadObjectData ()=0 |
returns True if we are at end of the stream | |
virtual void | EndReadObjectData ()=0 |
returns True if we are at end of the stream | |
virtual void | EndReadPersistentObjectData ()=0 |
returns True if we are at end of the stream | |
virtual Storage_Error | EndReadDataSection ()=0 |
returns True if we are at end of the stream | |
virtual void | SkipObject ()=0 |
returns True if we are at end of the stream | |
virtual Storage_Error | Close ()=0 |
returns True if we are at end of the stream | |
Output methods | |
virtual Storage_BaseDriver & | PutReference (const Standard_Integer aValue)=0 |
virtual Storage_BaseDriver & | PutCharacter (const Standard_Character aValue)=0 |
Storage_BaseDriver & | operator<< (const Standard_Character aValue) |
virtual Storage_BaseDriver & | PutExtCharacter (const Standard_ExtCharacter aValue)=0 |
Storage_BaseDriver & | operator<< (const Standard_ExtCharacter aValue) |
virtual Storage_BaseDriver & | PutInteger (const Standard_Integer aValue)=0 |
Storage_BaseDriver & | operator<< (const Standard_Integer aValue) |
virtual Storage_BaseDriver & | PutBoolean (const Standard_Boolean aValue)=0 |
Storage_BaseDriver & | operator<< (const Standard_Boolean aValue) |
virtual Storage_BaseDriver & | PutReal (const Standard_Real aValue)=0 |
Storage_BaseDriver & | operator<< (const Standard_Real aValue) |
virtual Storage_BaseDriver & | PutShortReal (const Standard_ShortReal aValue)=0 |
Storage_BaseDriver & | operator<< (const Standard_ShortReal aValue) |
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. | |
Static Public Member Functions | |
static TCollection_AsciiString | ReadMagicNumber (Standard_IStream &theIStream) |
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. | |
Input methods | |
virtual Storage_BaseDriver & | GetReference (Standard_Integer &aValue)=0 |
virtual Storage_BaseDriver & | GetCharacter (Standard_Character &aValue)=0 |
Storage_BaseDriver & | operator>> (Standard_Character &aValue) |
virtual Storage_BaseDriver & | GetExtCharacter (Standard_ExtCharacter &aValue)=0 |
Storage_BaseDriver & | operator>> (Standard_ExtCharacter &aValue) |
virtual Storage_BaseDriver & | GetInteger (Standard_Integer &aValue)=0 |
Storage_BaseDriver & | operator>> (Standard_Integer &aValue) |
virtual Storage_BaseDriver & | GetBoolean (Standard_Boolean &aValue)=0 |
Storage_BaseDriver & | operator>> (Standard_Boolean &aValue) |
virtual Storage_BaseDriver & | GetReal (Standard_Real &aValue)=0 |
Storage_BaseDriver & | operator>> (Standard_Real &aValue) |
virtual Storage_BaseDriver & | GetShortReal (Standard_ShortReal &aValue)=0 |
Storage_BaseDriver & | operator>> (Standard_ShortReal &aValue) |
Storage_BaseDriver () | |
void | SetName (const TCollection_AsciiString &aName) |
void | SetOpenMode (const Storage_OpenMode aMode) |
Additional Inherited Members | |
Public Types inherited from Standard_Transient | |
typedef void | base_type |
Returns a type descriptor about this object. | |
Root class for drivers. A driver assigns a physical container to data to be stored or retrieved, for instance a file. The FSD package provides two derived concrete classes :
|
virtual |
|
protected |
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, FSD_CmpFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, FSD_CmpFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, FSD_CmpFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, FSD_CmpFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, FSD_CmpFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, FSD_CmpFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, FSD_CmpFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, FSD_CmpFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, FSD_CmpFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, FSD_CmpFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
inline |
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, FSD_CmpFile, and FSD_File.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
pure virtual |
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
static |
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, FSD_CmpFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
inlineprotected |
|
inlineprotected |
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
return position in the file. Return -1 upon error.
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, FSD_CmpFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.
|
pure virtual |
returns True if we are at end of the stream
Implemented in FSD_BinaryFile, and FSD_File.