include/opencascade/PCDM_Reader.hxx

0001 // Created on: 1997-12-18
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_Reader_HeaderFile
0018 #define _PCDM_Reader_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <PCDM_ReaderStatus.hxx>
0024 #include <Standard_Transient.hxx>
0025 #include <Standard_IStream.hxx>
0026 #include <Storage_Data.hxx>
0027 #include <Message_ProgressRange.hxx>
0028
0029 class CDM_Document;
0030 class TCollection_ExtendedString;
0031 class CDM_Application;
0032 class PCDM_ReaderFilter;
0033
0034 class PCDM_Reader;
0035 DEFINE_STANDARD_HANDLE(PCDM_Reader, Standard_Transient)
0036
0037 class PCDM_Reader : public Standard_Transient
0038 {
0039
0040 public:
0041   //! retrieves the content of the file into a new Document.
0042   Standard_EXPORT virtual void Read(
0043     const TCollection_ExtendedString& aFileName,
0044     const Handle(CDM_Document)&       aNewDocument,
0045     const Handle(CDM_Application)&    anApplication,
0046     const Handle(PCDM_ReaderFilter)&  theFilter   = Handle(PCDM_ReaderFilter)(),
0047     const Message_ProgressRange&      theProgress = Message_ProgressRange()) = 0;
0048
0049   Standard_EXPORT virtual void Read(
0050     Standard_IStream&                theIStream,
0051     const Handle(Storage_Data)&      theStorageData,
0052     const Handle(CDM_Document)&      theDoc,
0053     const Handle(CDM_Application)&   theApplication,
0054     const Handle(PCDM_ReaderFilter)& theFilter   = Handle(PCDM_ReaderFilter)(),
0055     const Message_ProgressRange&     theProgress = Message_ProgressRange()) = 0;
0056
0057   PCDM_ReaderStatus GetStatus() const;
0058
0059   DEFINE_STANDARD_RTTIEXT(PCDM_Reader, Standard_Transient)
0060
0061 protected:
0062   PCDM_ReaderStatus myReaderStatus;
0063
0064 private:
0065 };
0066
0067 #include <PCDM_Reader.lxx>
0068
0069 #endif // _PCDM_Reader_HeaderFile