include/opencascade/Storage_HeaderData.hxx

0001 // Created on: 1997-02-06
0002 // Created by: Kernel
0003 // Copyright (c) 1997-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _Storage_HeaderData_HeaderFile
0018 #define _Storage_HeaderData_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_Integer.hxx>
0024 #include <TColStd_SequenceOfAsciiString.hxx>
0025 #include <TColStd_SequenceOfExtendedString.hxx>
0026 #include <Storage_Error.hxx>
0027 #include <Standard_Transient.hxx>
0028 class Storage_BaseDriver;
0029
0030 class Storage_HeaderData;
0031 DEFINE_STANDARD_HANDLE(Storage_HeaderData, Standard_Transient)
0032
0033 class Storage_HeaderData : public Standard_Transient
0034 {
0035
0036 public:
0037   Standard_EXPORT Storage_HeaderData();
0038
0039   Standard_EXPORT Standard_Boolean Read(const Handle(Storage_BaseDriver)& theDriver);
0040
0041   //! return the creation date
0042   Standard_EXPORT TCollection_AsciiString CreationDate() const;
0043
0044   //! return the Storage package version
0045   Standard_EXPORT TCollection_AsciiString StorageVersion() const;
0046
0047   //! get the version of the schema
0048   Standard_EXPORT TCollection_AsciiString SchemaVersion() const;
0049
0050   //! get the schema's name
0051   Standard_EXPORT TCollection_AsciiString SchemaName() const;
0052
0053   //! set the version of the application
0054   Standard_EXPORT void SetApplicationVersion(const TCollection_AsciiString& aVersion);
0055
0056   //! get the version of the application
0057   Standard_EXPORT TCollection_AsciiString ApplicationVersion() const;
0058
0059   //! set the name of the application
0060   Standard_EXPORT void SetApplicationName(const TCollection_ExtendedString& aName);
0061
0062   //! get the name of the application
0063   Standard_EXPORT TCollection_ExtendedString ApplicationName() const;
0064
0065   //! set the data type
0066   Standard_EXPORT void SetDataType(const TCollection_ExtendedString& aType);
0067
0068   //! returns data type
0069   Standard_EXPORT TCollection_ExtendedString DataType() const;
0070
0071   //! add <theUserInfo> to the user information
0072   Standard_EXPORT void AddToUserInfo(const TCollection_AsciiString& theUserInfo);
0073
0074   //! return the user information
0075   Standard_EXPORT const TColStd_SequenceOfAsciiString& UserInfo() const;
0076
0077   //! add <theUserInfo> to the user information
0078   Standard_EXPORT void AddToComments(const TCollection_ExtendedString& aComment);
0079
0080   //! return the user information
0081   Standard_EXPORT const TColStd_SequenceOfExtendedString& Comments() const;
0082
0083   //! the number of persistent objects
0084   //! Return:
0085   //! the number of persistent objects readed
0086   Standard_EXPORT Standard_Integer NumberOfObjects() const;
0087
0088   Standard_EXPORT Storage_Error ErrorStatus() const;
0089
0090   Standard_EXPORT TCollection_AsciiString ErrorStatusExtension() const;
0091
0092   Standard_EXPORT void ClearErrorStatus();
0093
0094   friend class Storage_Schema;
0095
0096   DEFINE_STANDARD_RTTIEXT(Storage_HeaderData, Standard_Transient)
0097
0098 public:
0099   Standard_EXPORT void SetNumberOfObjects(const Standard_Integer anObjectNumber);
0100
0101   Standard_EXPORT void SetStorageVersion(const TCollection_AsciiString& aVersion);
0102
0103   void SetStorageVersion(const Standard_Integer theVersion)
0104   {
0105     SetStorageVersion(TCollection_AsciiString(theVersion));
0106   }
0107
0108   Standard_EXPORT void SetCreationDate(const TCollection_AsciiString& aDate);
0109
0110   Standard_EXPORT void SetSchemaVersion(const TCollection_AsciiString& aVersion);
0111
0112   Standard_EXPORT void SetSchemaName(const TCollection_AsciiString& aName);
0113
0114 private:
0115   Standard_EXPORT void SetErrorStatus(const Storage_Error anError);
0116
0117   Standard_EXPORT void SetErrorStatusExtension(const TCollection_AsciiString& anErrorExt);
0118
0119   Standard_Integer                 myNBObj;
0120   TCollection_AsciiString          myStorageVersion;
0121   TCollection_AsciiString          mySchemaVersion;
0122   TCollection_AsciiString          mySchemaName;
0123   TCollection_AsciiString          myApplicationVersion;
0124   TCollection_ExtendedString       myApplicationName;
0125   TCollection_ExtendedString       myDataType;
0126   TCollection_AsciiString          myDate;
0127   TColStd_SequenceOfAsciiString    myUserInfo;
0128   TColStd_SequenceOfExtendedString myComments;
0129   Storage_Error                    myErrorStatus;
0130   TCollection_AsciiString          myErrorStatusExt;
0131 };
0132
0133 #endif // _Storage_HeaderData_HeaderFile