include/opencascade/PCDM_ReadWriter.hxx

0001 // Created on: 1997-12-09
0002 // Created by: Jean-Louis Frenkel
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 _PCDM_ReadWriter_HeaderFile
0018 #define _PCDM_ReadWriter_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_Transient.hxx>
0024 #include <Standard_Integer.hxx>
0025 #include <PCDM_SequenceOfReference.hxx>
0026 #include <TColStd_SequenceOfExtendedString.hxx>
0027 #include <Storage_OpenMode.hxx>
0028 class TCollection_AsciiString;
0029 class Storage_Data;
0030 class CDM_Document;
0031 class TCollection_ExtendedString;
0032 class Message_Messenger;
0033 class Storage_BaseDriver;
0034
0035
0036 class PCDM_ReadWriter;
0037 DEFINE_STANDARD_HANDLE(PCDM_ReadWriter, Standard_Transient)
0038
0039
0040 class PCDM_ReadWriter : public Standard_Transient
0041 {
0042
0043 public:
0044
0045
0046   //! returns PCDM_ReadWriter_1.
0047   Standard_EXPORT virtual TCollection_AsciiString Version() const = 0;
0048
0049   Standard_EXPORT virtual void WriteReferenceCounter (const Handle(Storage_Data)& aData, const Handle(CDM_Document)& aDocument) const = 0;
0050
0051   Standard_EXPORT virtual void WriteReferences (const Handle(Storage_Data)& aData, const Handle(CDM_Document)& aDocument, const TCollection_ExtendedString& theReferencerFileName) const = 0;
0052
0053   Standard_EXPORT virtual void WriteExtensions (const Handle(Storage_Data)& aData, const Handle(CDM_Document)& aDocument) const = 0;
0054
0055   Standard_EXPORT virtual void WriteVersion (const Handle(Storage_Data)& aData, const Handle(CDM_Document)& aDocument) const = 0;
0056
0057   Standard_EXPORT virtual Standard_Integer ReadReferenceCounter (const TCollection_ExtendedString& theFileName, const Handle(Message_Messenger)& theMsgDriver) const = 0;
0058
0059   Standard_EXPORT virtual void ReadReferences (const TCollection_ExtendedString& aFileName, PCDM_SequenceOfReference& theReferences, const Handle(Message_Messenger)& theMsgDriver) const = 0;
0060
0061   Standard_EXPORT virtual void ReadExtensions (const TCollection_ExtendedString& aFileName, TColStd_SequenceOfExtendedString& theExtensions, const Handle(Message_Messenger)& theMsgDriver) const = 0;
0062
0063   Standard_EXPORT virtual Standard_Integer ReadDocumentVersion (const TCollection_ExtendedString& aFileName, const Handle(Message_Messenger)& theMsgDriver) const = 0;
0064
0065   Standard_EXPORT static void Open (const Handle(Storage_BaseDriver)& aDriver,
0066                                     const TCollection_ExtendedString& aFileName,
0067                                     const Storage_OpenMode anOpenMode);
0068
0069   //! returns the convenient Reader for a File.
0070   Standard_EXPORT static Handle(PCDM_ReadWriter) Reader (const TCollection_ExtendedString& aFileName);
0071
0072   Standard_EXPORT static Handle(PCDM_ReadWriter) Writer();
0073
0074   Standard_EXPORT static void WriteFileFormat (const Handle(Storage_Data)& aData, const Handle(CDM_Document)& aDocument);
0075
0076   //! tries  to get a format  in the  file.  returns an empty
0077   //! string if the file could not be read or does not have
0078   //! a FileFormat information.
0079   Standard_EXPORT static TCollection_ExtendedString FileFormat (const TCollection_ExtendedString& aFileName);
0080
0081   //! tries  to get a format  from the stream.  returns an empty
0082   //! string if the file could not be read or does not have
0083   //! a FileFormat information.
0084   Standard_EXPORT static TCollection_ExtendedString FileFormat (Standard_IStream& theIStream, Handle(Storage_Data)& theData);
0085
0086
0087
0088   DEFINE_STANDARD_RTTIEXT(PCDM_ReadWriter,Standard_Transient)
0089
0090 protected:
0091
0092
0093
0094
0095 private:
0096
0097
0098
0099
0100 };
0101
0102
0103
0104
0105
0106
0107
0108 #endif // _PCDM_ReadWriter_HeaderFile