0025748: Parallel version of progress indicator
[occt.git] / src / PCDM / PCDM_Reader.hxx
1 // Created on: 1997-12-18
2 // Created by: Jean-Louis Frenkel
3 // Copyright (c) 1997-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _PCDM_Reader_HeaderFile
18 #define _PCDM_Reader_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <PCDM_ReaderStatus.hxx>
24 #include <Standard_Transient.hxx>
25 #include <Standard_IStream.hxx>
26 #include <Storage_Data.hxx>
27 #include <Message_ProgressRange.hxx>
28
29 class PCDM_DriverError;
30 class CDM_Document;
31 class TCollection_ExtendedString;
32 class CDM_Application;
33
34
35 class PCDM_Reader;
36 DEFINE_STANDARD_HANDLE(PCDM_Reader, Standard_Transient)
37
38
39 class PCDM_Reader : public Standard_Transient
40 {
41
42 public:
43
44   
45   //! this method is called by the framework before the read method.
46   Standard_EXPORT virtual Handle(CDM_Document) CreateDocument() = 0;
47   
48   //! retrieves the content of the file into a new Document.
49   Standard_EXPORT virtual void Read (const TCollection_ExtendedString& aFileName, 
50                                      const Handle(CDM_Document)& aNewDocument, 
51                                      const Handle(CDM_Application)& anApplication, 
52                                      const Message_ProgressRange& theProgress = Message_ProgressRange()) = 0;
53
54   Standard_EXPORT virtual void Read (Standard_IStream&               theIStream,
55                                      const Handle(Storage_Data)&    theStorageData,
56                                      const Handle(CDM_Document)&    theDoc,
57                                      const Handle(CDM_Application)& theApplication,
58                                      const Message_ProgressRange& theProgress = Message_ProgressRange()) = 0;
59   
60     PCDM_ReaderStatus GetStatus() const;
61
62
63
64
65   DEFINE_STANDARD_RTTIEXT(PCDM_Reader,Standard_Transient)
66
67 protected:
68
69
70   PCDM_ReaderStatus myReaderStatus;
71
72
73 private:
74
75
76
77
78 };
79
80
81 #include <PCDM_Reader.lxx>
82
83
84
85
86
87 #endif // _PCDM_Reader_HeaderFile