summaryrefslogtreecommitdiff
path: root/inc/IGESData_GeneralModule.hxx
blob: 314df48c2b87a15168060e889aea2cc38223a707 (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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
// 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 _IGESData_GeneralModule_HeaderFile
#define _IGESData_GeneralModule_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineHandle_HeaderFile
#include <Standard_DefineHandle.hxx>
#endif
#ifndef _Handle_IGESData_GeneralModule_HeaderFile
#include <Handle_IGESData_GeneralModule.hxx>
#endif

#ifndef _Interface_GeneralModule_HeaderFile
#include <Interface_GeneralModule.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _Handle_Standard_Transient_HeaderFile
#include <Handle_Standard_Transient.hxx>
#endif
#ifndef _Handle_IGESData_IGESEntity_HeaderFile
#include <Handle_IGESData_IGESEntity.hxx>
#endif
#ifndef _Handle_Interface_Check_HeaderFile
#include <Handle_Interface_Check.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _Handle_TCollection_HAsciiString_HeaderFile
#include <Handle_TCollection_HAsciiString.hxx>
#endif
class Standard_Transient;
class Interface_EntityIterator;
class IGESData_IGESEntity;
class Interface_ShareTool;
class Interface_Check;
class IGESData_DirChecker;
class Interface_CopyTool;
class TCollection_HAsciiString;


//! Definition of General Services adapted to IGES. <br>
//!           This Services comprise : Shared & Implied Lists, Copy, Check <br>
//!           They are adapted according to the organisation of IGES <br>
//!           Entities : Directory Part, Lists of Associativities and <br>
//!           Properties are specifically processed <br>
class IGESData_GeneralModule : public Interface_GeneralModule {

public:

  //! Fills the list of Entities shared by an IGESEntity <ent>, <br>
//!           according a Case Number <CN> (formerly computed by CaseNum). <br>
//!           Considers Properties and Directory Part, and calls <br>
//!           OwnSharedCase (which is adapted to each Type of Entity) <br>
  Standard_EXPORT     void FillSharedCase(const Standard_Integer CN,const Handle(Standard_Transient)& ent,Interface_EntityIterator& iter) const;
  //! Lists the Entities shared by a given IGESEntity <ent>, from <br>
//!           its specific parameters : specific for each type <br>
  Standard_EXPORT   virtual  void OwnSharedCase(const Standard_Integer CN,const Handle(IGESData_IGESEntity)& ent,Interface_EntityIterator& iter) const = 0;
  //! Lists the Implied References of <ent>. Here, these are the <br>
//!           Associativities, plus the Entities defined by OwnSharedCase <br>
  Standard_EXPORT   virtual  void ListImpliedCase(const Standard_Integer CN,const Handle(Standard_Transient)& ent,Interface_EntityIterator& iter) const;
  //! Specific list of Entities implied by a given IGESEntity <ent> <br>
//!           (in addition to Associativities). By default, there are none, <br>
//!           but this method can be redefined as required <br>
  Standard_EXPORT   virtual  void OwnImpliedCase(const Standard_Integer CN,const Handle(IGESData_IGESEntity)& ent,Interface_EntityIterator& iter) const;
  //! Semantic Checking of an IGESEntity. Performs general Checks, <br>
//!           which use DirChecker, then call OwnCheck which does a check <br>
//!           specific for each type of Entity <br>
  Standard_EXPORT     void CheckCase(const Standard_Integer CN,const Handle(Standard_Transient)& ent,const Interface_ShareTool& shares,Handle(Interface_Check)& ach) const;
  //! Returns a DirChecker, specific for each type of Entity <br>
//!           (identified by its Case Number) : this DirChecker defines <br>
//!           constraints which must be respected by the DirectoryPart <br>
  Standard_EXPORT   virtual  IGESData_DirChecker DirChecker(const Standard_Integer CN,const Handle(IGESData_IGESEntity)& ent) const = 0;
  //! Performs Specific Semantic Check for each type of Entity <br>
  Standard_EXPORT   virtual  void OwnCheckCase(const Standard_Integer CN,const Handle(IGESData_IGESEntity)& ent,const Interface_ShareTool& shares,Handle(Interface_Check)& ach) const = 0;
  //! Specific answer to the question "is Copy properly implemented" <br>
//!           For IGES, answer is always True <br>
  Standard_EXPORT   virtual  Standard_Boolean CanCopy(const Standard_Integer CN,const Handle(Standard_Transient)& ent) const;
  //! Specific creation of a new void entity <br>
  Standard_EXPORT   virtual  Standard_Boolean NewVoid(const Standard_Integer CN,Handle(Standard_Transient)& entto) const = 0;
  //! Copy ("Deep") from <entfrom> to <entto> (same type) <br>
//!           by using a CopyTool which provides its working Map. <br>
//!           For IGESEntities, Copies general data (Directory Part, List of <br>
//!           Properties) and call OwnCopyCase <br>
  Standard_EXPORT     void CopyCase(const Standard_Integer CN,const Handle(Standard_Transient)& entfrom,const Handle(Standard_Transient)& entto,Interface_CopyTool& TC) const;
  //! Copies parameters which are specific of each Type of Entity <br>
  Standard_EXPORT   virtual  void OwnCopyCase(const Standard_Integer CN,const Handle(IGESData_IGESEntity)& entfrom,const Handle(IGESData_IGESEntity)& entto,Interface_CopyTool& TC) const = 0;
  //! Renewing of Implied References. <br>
//!           For IGESEntities, Copies general data(List of Associativities) <br>
//!           and calls OwnRenewCase <br>
  Standard_EXPORT   virtual  void RenewImpliedCase(const Standard_Integer CN,const Handle(Standard_Transient)& entfrom,const Handle(Standard_Transient)& entto,const Interface_CopyTool& TC) const;
  //! Renews parameters which are specific of each Type of Entity : <br>
//!           the provided default does nothing, but this method may be <br>
//!           redefined as required <br>
  Standard_EXPORT   virtual  void OwnRenewCase(const Standard_Integer CN,const Handle(IGESData_IGESEntity)& entfrom,const Handle(IGESData_IGESEntity)& entto,const Interface_CopyTool& TC) const;
  //! Prepares an IGES Entity for delete : works on directory part <br>
//!           then calls OwnDeleteCase <br>
//!           While dispatch requires to copy the entities, <dispatched> is <br>
//!           ignored, entities are cleared in any case <br>
  Standard_EXPORT   virtual  void WhenDeleteCase(const Standard_Integer CN,const Handle(Standard_Transient)& ent,const Standard_Boolean dispatched) const;
  //! Specific preparation for delete, acts on own parameters <br>
//!           Default does nothing, to be redefined as required <br>
  Standard_EXPORT   virtual  void OwnDeleteCase(const Standard_Integer CN,const Handle(IGESData_IGESEntity)& ent) const;
  //! Returns the name of an IGES Entity (its NameValue) <br>
//!           Can be redefined for an even more specific case ... <br>
  Standard_EXPORT   virtual  Handle_TCollection_HAsciiString Name(const Standard_Integer CN,const Handle(Standard_Transient)& ent,const Interface_ShareTool& shares) const;




  DEFINE_STANDARD_RTTI(IGESData_GeneralModule)

protected:




private: 




};





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


#endif