summaryrefslogtreecommitdiff
path: root/inc/Interface_ReportEntity.hxx
blob: 97a1aeb78aa02cf0d48f415ad66a478c36580bc2 (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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
// 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_ReportEntity_HeaderFile
#define _Interface_ReportEntity_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineHandle_HeaderFile
#include <Standard_DefineHandle.hxx>
#endif
#ifndef _Handle_Interface_ReportEntity_HeaderFile
#include <Handle_Interface_ReportEntity.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 _MMgt_TShared_HeaderFile
#include <MMgt_TShared.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
class Interface_Check;
class Standard_Transient;


//! A ReportEntity is produced to aknowledge and memorize the <br>
//!           binding between a Check and an Entity. The Check can bring <br>
//!           Fails (+ Warnings if any), or only Warnings. If it is empty, <br>
//!           the Report Entity is for an Unknown Entity. <br>
//! <br>
//!           The ReportEntity brings : the Concerned Entity, the <br>
//!           Check, and if the Entity is empty (Fails due to Read <br>
//!           Errors, hence the Entity could not be loaded), a Content. <br>
//!           The Content is itself an Transient Object, but remains in a <br>
//!           literal form : it is an "Unknown Entity". If the Concerned <br>
//!           Entity is itself Unknown, Concerned and Content are equal. <br>
//! <br>
//!           According to the Check, if it brings Fail messages, <br>
//!           the ReportEntity is an "Error Entity", the Concerned Entity is <br>
//!           an "Erroneous Entity". Else it is a "Correction Entity", the <br>
//!           Concerned Entity is a "Corrected Entity". With no Check <br>
//!           message and if Concerened and Content are equal, it reports <br>
//!           for an "Unknown Entity". <br>
//! <br>
//!           Each norm must produce its own type of Unknown Entity, but can <br>
//!           use the class UndefinedContent to brings parameters : it is <br>
//!           enough for most of information and avoids to redefine them, <br>
//!           only the specific part remains to be defined for each norm. <br>
class Interface_ReportEntity : public MMgt_TShared {

public:

  //! Creates a ReportEntity for an Unknown Entity : Check is empty, <br>
//!           and Concerned equates Content (i.e. the Unknown Entity) <br>
  Standard_EXPORT   Interface_ReportEntity(const Handle(Standard_Transient)& unknown);
  //! Creates a ReportEntity with its features : <br>
//!           - <acheck> is the Check to be memorised <br>
//!           - <concerned> is the Entity to which the Check is bound <br>
//!           Later, a Content can be set : it is required for an Error <br>
  Standard_EXPORT   Interface_ReportEntity(const Handle(Interface_Check)& acheck,const Handle(Standard_Transient)& concerned);
  //! Sets a Content : it brings non interpreted data which belong <br>
//!           to the Concerned Entity. It can be empty then loaded later. <br>
//!           Remark that for an Unknown Entity, Content is set by Create. <br>
  Standard_EXPORT     void SetContent(const Handle(Standard_Transient)& content) ;
  //! Returns the stored Check <br>
  Standard_EXPORT    const Handle_Interface_Check& Check() const;
  //! Returns the stored Check in order to change it <br>
  Standard_EXPORT     Handle_Interface_Check& CCheck() ;
  //! Returns the stored Concerned Entity. It equates the Content <br>
//!           in the case of an Unknown Entity <br>
  Standard_EXPORT     Handle_Standard_Transient Concerned() const;
  //! Returns True if a Content is stored (it can equate Concerned) <br>
  Standard_EXPORT     Standard_Boolean HasContent() const;
  //! Returns True if a Content is stored AND differs from Concerned <br>
//!           (i.e. redefines content) : used when Concerned could not be <br>
//!           loaded <br>
  Standard_EXPORT     Standard_Boolean HasNewContent() const;
  //! Returns the stored Content, or a Null Handle <br>
//!           Remark that it must be an "Unknown Entity" suitable for <br>
//!           the norm of the containing Model <br>
  Standard_EXPORT     Handle_Standard_Transient Content() const;
  //! Returns True for an Error Entity, i.e. if the Check <br>
//!           brings at least one Fail message <br>
  Standard_EXPORT     Standard_Boolean IsError() const;
  //! Returns True for an Unknown Entity, i,e. if the Check <br>
//!           is empty and Concerned equates Content <br>
  Standard_EXPORT     Standard_Boolean IsUnknown() const;




  DEFINE_STANDARD_RTTI(Interface_ReportEntity)

protected:




private: 


Handle_Interface_Check thecheck;
Handle_Standard_Transient theconcerned;
Handle_Standard_Transient thecontent;


};





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


#endif