summaryrefslogtreecommitdiff
path: root/inc/Interface_ReaderModule.hxx
blob: 2106631c7df3935fc7029f563ae09885ecd1f87d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
// 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 _Interface_ReaderModule_HeaderFile
#define _Interface_ReaderModule_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineHandle_HeaderFile
#include <Standard_DefineHandle.hxx>
#endif
#ifndef _Handle_Interface_ReaderModule_HeaderFile
#include <Handle_Interface_ReaderModule.hxx>
#endif

#ifndef _MMgt_TShared_HeaderFile
#include <MMgt_TShared.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _Handle_Interface_FileReaderData_HeaderFile
#include <Handle_Interface_FileReaderData.hxx>
#endif
#ifndef _Handle_Interface_Check_HeaderFile
#include <Handle_Interface_Check.hxx>
#endif
#ifndef _Handle_Standard_Transient_HeaderFile
#include <Handle_Standard_Transient.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
class Standard_DomainError;
class Interface_FileReaderData;
class Interface_Check;
class Standard_Transient;


//! Defines unitary operations required to read an Entity from a <br>
//!           File (see FileReaderData, FileReaderTool), under control of <br>
//!           a FileReaderTool. The initial creation is performed by a <br>
//!           GeneralModule (set in GeneralLib). Then, which remains is <br>
//!           Loading data from the FileReaderData to the Entity <br>
//! <br>
//!           To work, a GeneralModule has formerly recognized the Type read <br>
//!           from FileReaderData as a positive Case Number, then the <br>
//!           ReaderModule reads it according to this Case Number <br>
class Interface_ReaderModule : public MMgt_TShared {

public:

  //! Translates the type of record <num> in <data> to a positive <br>
//!           Case Number. If Recognition fails, must return 0 <br>
  Standard_EXPORT   virtual  Standard_Integer CaseNum(const Handle(Interface_FileReaderData)& data,const Standard_Integer num) const = 0;
  //! Performs the effective loading from <data>, record <num>, <br>
//!           to the Entity <ent> formerly created <br>
//!           In case of Error or Warning, fills <ach> with messages <br>
//!           Remark that the Case Number comes from translating a record <br>
  Standard_EXPORT   virtual  void Read(const Standard_Integer casenum,const Handle(Interface_FileReaderData)& data,const Standard_Integer num,Handle(Interface_Check)& ach,const Handle(Standard_Transient)& ent) const = 0;
  //! Specific operator (create+read) defaulted to do nothing. <br>
//!           It can be redefined when it is not possible to work in two <br>
//!           steps (NewVoid then Read). This occurs when no default <br>
//!           constructor is defined : hence the result <ent> must be <br>
//!           created with an effective definition from the reader. <br>
//!           Remark : if NewRead is defined, Copy has nothing to do. <br>
//! <br>
//!           Returns True if it has produced something, false else. <br>
//!           If nothing was produced, <ach> should be filled : it will be <br>
//!           treated as "Unrecognized case" by reader tool. <br>
  Standard_EXPORT   virtual  Standard_Boolean NewRead(const Standard_Integer casenum,const Handle(Interface_FileReaderData)& data,const Standard_Integer num,Handle(Interface_Check)& ach,Handle(Standard_Transient)& ent) const;




  DEFINE_STANDARD_RTTI(Interface_ReaderModule)

protected:




private: 




};





// other Inline functions and methods (like "C++: function call" methods)


#endif