liboce-foundation-dev 0.17.1-1 / usr / include / oce / Storage_BaseDriver.hxx

// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to 
// this header file considered to be the "object code" form of the original source.

#ifndef _Storage_BaseDriver_HeaderFile
#define _Storage_BaseDriver_HeaderFile

#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_Macro.hxx>

#include <Storage_OpenMode.hxx>
#include <TCollection_AsciiString.hxx>
#include <Storage_Error.hxx>
#include <Standard_Boolean.hxx>
#include <Storage_Position.hxx>
#include <Standard_Integer.hxx>
#include <Standard_Character.hxx>
#include <Standard_ExtCharacter.hxx>
#include <Standard_Real.hxx>
#include <Standard_ShortReal.hxx>
class Storage_StreamTypeMismatchError;
class Storage_StreamFormatError;
class Storage_StreamWriteError;
class Storage_StreamExtCharParityError;
class TCollection_AsciiString;
class TCollection_ExtendedString;
class TColStd_SequenceOfAsciiString;
class TColStd_SequenceOfExtendedString;


//! 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 :
//! -   FSD_File is a general driver which defines a
//! file as the container of data.
class Storage_BaseDriver 
{
public:

  DEFINE_STANDARD_ALLOC

  
  Standard_EXPORT   void Delete() ;
Standard_EXPORT virtual ~Storage_BaseDriver(){Delete();}
  
  Standard_EXPORT virtual   Storage_Error Open (const TCollection_AsciiString& aName, const Storage_OpenMode aMode)  = 0;
  
      TCollection_AsciiString Name()  const;
  
      Storage_OpenMode OpenMode()  const;
  
  //! returns True if we are at end of the stream
  Standard_EXPORT virtual   Standard_Boolean IsEnd()  = 0;
  
  //! return position in the file. Return -1 upon error.
  Standard_EXPORT virtual   Storage_Position Tell()  = 0;
  
  Standard_EXPORT virtual   Storage_Error BeginWriteInfoSection()  = 0;
  
  Standard_EXPORT 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;
  
  Standard_EXPORT virtual   Storage_Error EndWriteInfoSection()  = 0;
  
  Standard_EXPORT virtual   Storage_Error BeginReadInfoSection()  = 0;
  
  Standard_EXPORT 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;
  
  Standard_EXPORT virtual   Storage_Error EndReadInfoSection()  = 0;
  
  Standard_EXPORT virtual   Storage_Error BeginWriteCommentSection()  = 0;
  
  Standard_EXPORT virtual   void WriteComment (const TColStd_SequenceOfExtendedString& userComments)  = 0;
  
  Standard_EXPORT virtual   Storage_Error EndWriteCommentSection()  = 0;
  
  Standard_EXPORT virtual   Storage_Error BeginReadCommentSection()  = 0;
  
  Standard_EXPORT virtual   void ReadComment (TColStd_SequenceOfExtendedString& userComments)  = 0;
  
  Standard_EXPORT virtual   Storage_Error EndReadCommentSection()  = 0;
  
  Standard_EXPORT virtual   Storage_Error BeginWriteTypeSection()  = 0;
  
  Standard_EXPORT virtual   void SetTypeSectionSize (const Standard_Integer aSize)  = 0;
  
  Standard_EXPORT virtual   void WriteTypeInformations (const Standard_Integer typeNum, const TCollection_AsciiString& typeName)  = 0;
  
  Standard_EXPORT virtual   Storage_Error EndWriteTypeSection()  = 0;
  
  Standard_EXPORT virtual   Storage_Error BeginReadTypeSection()  = 0;
  
  Standard_EXPORT virtual   Standard_Integer TypeSectionSize()  = 0;
  
  Standard_EXPORT virtual   void ReadTypeInformations (Standard_Integer& typeNum, TCollection_AsciiString& typeName)  = 0;
  
  Standard_EXPORT virtual   Storage_Error EndReadTypeSection()  = 0;
  
  Standard_EXPORT virtual   Storage_Error BeginWriteRootSection()  = 0;
  
  Standard_EXPORT virtual   void SetRootSectionSize (const Standard_Integer aSize)  = 0;
  
  Standard_EXPORT virtual   void WriteRoot (const TCollection_AsciiString& rootName, const Standard_Integer aRef, const TCollection_AsciiString& aType)  = 0;
  
  Standard_EXPORT virtual   Storage_Error EndWriteRootSection()  = 0;
  
  Standard_EXPORT virtual   Storage_Error BeginReadRootSection()  = 0;
  
  Standard_EXPORT virtual   Standard_Integer RootSectionSize()  = 0;
  
  Standard_EXPORT virtual   void ReadRoot (TCollection_AsciiString& rootName, Standard_Integer& aRef, TCollection_AsciiString& aType)  = 0;
  
  Standard_EXPORT virtual   Storage_Error EndReadRootSection()  = 0;
  
  Standard_EXPORT virtual   Storage_Error BeginWriteRefSection()  = 0;
  
  Standard_EXPORT virtual   void SetRefSectionSize (const Standard_Integer aSize)  = 0;
  
  Standard_EXPORT virtual   void WriteReferenceType (const Standard_Integer reference, const Standard_Integer typeNum)  = 0;
  
  Standard_EXPORT virtual   Storage_Error EndWriteRefSection()  = 0;
  
  Standard_EXPORT virtual   Storage_Error BeginReadRefSection()  = 0;
  
  Standard_EXPORT virtual   Standard_Integer RefSectionSize()  = 0;
  
  Standard_EXPORT virtual   void ReadReferenceType (Standard_Integer& reference, Standard_Integer& typeNum)  = 0;
  
  Standard_EXPORT virtual   Storage_Error EndReadRefSection()  = 0;
  
  Standard_EXPORT virtual   Storage_Error BeginWriteDataSection()  = 0;
  
  Standard_EXPORT virtual   void WritePersistentObjectHeader (const Standard_Integer aRef, const Standard_Integer aType)  = 0;
  
  Standard_EXPORT virtual   void BeginWritePersistentObjectData()  = 0;
  
  Standard_EXPORT virtual   void BeginWriteObjectData()  = 0;
  
  Standard_EXPORT virtual   void EndWriteObjectData()  = 0;
  
  Standard_EXPORT virtual   void EndWritePersistentObjectData()  = 0;
  
  Standard_EXPORT virtual   Storage_Error EndWriteDataSection()  = 0;
  
  Standard_EXPORT virtual   Storage_Error BeginReadDataSection()  = 0;
  
  Standard_EXPORT virtual   void ReadPersistentObjectHeader (Standard_Integer& aRef, Standard_Integer& aType)  = 0;
  
  Standard_EXPORT virtual   void BeginReadPersistentObjectData()  = 0;
  
  Standard_EXPORT virtual   void BeginReadObjectData()  = 0;
  
  Standard_EXPORT virtual   void EndReadObjectData()  = 0;
  
  Standard_EXPORT virtual   void EndReadPersistentObjectData()  = 0;
  
  Standard_EXPORT virtual   Storage_Error EndReadDataSection()  = 0;
  
  Standard_EXPORT virtual   void SkipObject()  = 0;
  
  Standard_EXPORT virtual   Storage_BaseDriver& PutReference (const Standard_Integer aValue)  = 0;
  
  Standard_EXPORT virtual   Storage_BaseDriver& PutCharacter (const Standard_Character aValue)  = 0;
  Storage_BaseDriver& operator << (const Standard_Character aValue) 
{
  return PutCharacter(aValue);
}
  
  Standard_EXPORT virtual   Storage_BaseDriver& PutExtCharacter (const Standard_ExtCharacter aValue)  = 0;
  Storage_BaseDriver& operator << (const Standard_ExtCharacter aValue) 
{
  return PutExtCharacter(aValue);
}
  
  Standard_EXPORT virtual   Storage_BaseDriver& PutInteger (const Standard_Integer aValue)  = 0;
  Storage_BaseDriver& operator << (const Standard_Integer aValue) 
{
  return PutInteger(aValue);
}
  
  Standard_EXPORT virtual   Storage_BaseDriver& PutBoolean (const Standard_Boolean aValue)  = 0;
  Storage_BaseDriver& operator << (const Standard_Boolean aValue) 
{
  return PutBoolean(aValue);
}
  
  Standard_EXPORT virtual   Storage_BaseDriver& PutReal (const Standard_Real aValue)  = 0;
  Storage_BaseDriver& operator << (const Standard_Real aValue) 
{
  return PutReal(aValue);
}
  
  Standard_EXPORT virtual   Storage_BaseDriver& PutShortReal (const Standard_ShortReal aValue)  = 0;
  Storage_BaseDriver& operator << (const Standard_ShortReal aValue) 
{
  return PutShortReal(aValue);
}
  
  Standard_EXPORT virtual   Storage_BaseDriver& GetReference (Standard_Integer& aValue)  = 0;
  
  Standard_EXPORT virtual   Storage_BaseDriver& GetCharacter (Standard_Character& aValue)  = 0;
  Storage_BaseDriver& operator >> (Standard_Character& aValue) 
{
  return GetCharacter(aValue);
}
  
  Standard_EXPORT virtual   Storage_BaseDriver& GetExtCharacter (Standard_ExtCharacter& aValue)  = 0;
  Storage_BaseDriver& operator >> (Standard_ExtCharacter& aValue) 
{
  return GetExtCharacter(aValue);
}
  
  Standard_EXPORT virtual   Storage_BaseDriver& GetInteger (Standard_Integer& aValue)  = 0;
  Storage_BaseDriver& operator >> (Standard_Integer& aValue) 
{
  return GetInteger(aValue);
}
  
  Standard_EXPORT virtual   Storage_BaseDriver& GetBoolean (Standard_Boolean& aValue)  = 0;
  Storage_BaseDriver& operator >> (Standard_Boolean& aValue) 
{
  return GetBoolean(aValue);
}
  
  Standard_EXPORT virtual   Storage_BaseDriver& GetReal (Standard_Real& aValue)  = 0;
  Storage_BaseDriver& operator >> (Standard_Real& aValue) 
{
  return GetReal(aValue);
}
  
  Standard_EXPORT virtual   Storage_BaseDriver& GetShortReal (Standard_ShortReal& aValue)  = 0;
  Storage_BaseDriver& operator >> (Standard_ShortReal& aValue) 
{
  return GetShortReal(aValue);
}
  
  Standard_EXPORT virtual   Storage_Error Close()  = 0;




protected:

  
  Standard_EXPORT Storage_BaseDriver();
  
      void SetName (const TCollection_AsciiString& aName) ;
  
      void SetOpenMode (const Storage_OpenMode aMode) ;




private:



  Storage_OpenMode myOpenMode;
  TCollection_AsciiString myName;


};


#include <Storage_BaseDriver.lxx>





#endif // _Storage_BaseDriver_HeaderFile