0031939: Coding - correction of spelling errors in comments [part 4]
[occt.git] / src / IFSelect / IFSelect_TransformStandard.hxx
1 // Created on: 1994-05-27
2 // Created by: Christian CAILLET
3 // Copyright (c) 1994-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 _IFSelect_TransformStandard_HeaderFile
18 #define _IFSelect_TransformStandard_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <Standard_Boolean.hxx>
24 #include <IFSelect_SequenceOfGeneralModifier.hxx>
25 #include <IFSelect_Transformer.hxx>
26 #include <Standard_Integer.hxx>
27 class IFSelect_Selection;
28 class Interface_CopyControl;
29 class IFSelect_Modifier;
30 class Interface_Graph;
31 class Interface_Protocol;
32 class Interface_CheckIterator;
33 class Interface_InterfaceModel;
34 class Interface_CopyTool;
35 class Standard_Transient;
36 class TCollection_AsciiString;
37
38 class IFSelect_TransformStandard;
39 DEFINE_STANDARD_HANDLE(IFSelect_TransformStandard, IFSelect_Transformer)
40
41 //! This class runs transformations made by Modifiers, as
42 //! the ModelCopier does when it produces files (the same set
43 //! of Modifiers can then be used, as to transform the starting
44 //! Model, as at file sending time).
45 //!
46 //! First, considering the resulting model, two options :
47 //! - modifications are made directly on the starting model
48 //! (OnTheSpot option), or
49 //! - data are copied by the standard service Copy, only the
50 //! remaining (not yet sent in a file) entities are copied
51 //! (StandardCopy option)
52 //!
53 //! If a Selection is set, it forces the list of Entities on which
54 //! the Modifiers are applied. Else, each Modifier is considered
55 //! its Selection. By default, it is for the whole Model
56 //!
57 //! Then, the Modifiers are sequentially applied
58 //! If at least one Modifier "May Change Graph", or if the option
59 //! StandardCopy is selected, the graph will be recomputed
60 //! (by the WorkSession, see method RunTransformer)
61 //!
62 //! Remark that a TransformStandard with option StandardCopy
63 //! and no Modifier at all has the effect of computing the
64 //! remaining data (those not yet sent in any output file).
65 //! Moreover, the Protocol is not changed
66 class IFSelect_TransformStandard : public IFSelect_Transformer
67 {
68
69 public:
70
71   //! Creates a TransformStandard, option StandardCopy, no Modifier
72   Standard_EXPORT IFSelect_TransformStandard();
73   
74   //! Sets the Copy option to a new value :
75   //! - True for StandardCopy  - False for OnTheSpot
76   Standard_EXPORT void SetCopyOption (const Standard_Boolean option);
77   
78   //! Returns the Copy option
79   Standard_EXPORT Standard_Boolean CopyOption() const;
80   
81   //! Sets a Selection (or unsets if Null)
82   //! This Selection then defines the list of entities on which the
83   //! Modifiers will be applied
84   //! If it is set, it has priority on Selections of Modifiers
85   //! Else, for each Modifier its Selection is evaluated
86   //! By default, all the Model is taken
87   Standard_EXPORT void SetSelection (const Handle(IFSelect_Selection)& sel);
88   
89   //! Returns the Selection, Null by default
90   Standard_EXPORT Handle(IFSelect_Selection) Selection() const;
91   
92   //! Returns the count of recorded Modifiers
93   Standard_EXPORT Standard_Integer NbModifiers() const;
94   
95   //! Returns a Modifier given its rank in the list
96   Standard_EXPORT Handle(IFSelect_Modifier) Modifier (const Standard_Integer num) const;
97   
98   //! Returns the rank of a Modifier in the list, 0 if unknown
99   Standard_EXPORT Standard_Integer ModifierRank (const Handle(IFSelect_Modifier)& modif) const;
100   
101   //! Adds a Modifier to the list :
102   //! - <atnum> = 0 (default) : at the end of the list
103   //! - <atnum> > 0 : at rank <atnum>
104   //! Returns True if done, False if <atnum> is out of range
105   Standard_EXPORT Standard_Boolean AddModifier (const Handle(IFSelect_Modifier)& modif, const Standard_Integer atnum = 0);
106   
107   //! Removes a Modifier from the list
108   //! Returns True if done, False if <modif> not in the list
109   Standard_EXPORT Standard_Boolean RemoveModifier (const Handle(IFSelect_Modifier)& modif);
110   
111   //! Removes a Modifier from the list, given its rank
112   //! Returns True if done, False if <num> is out of range
113   Standard_EXPORT Standard_Boolean RemoveModifier (const Standard_Integer num);
114   
115   //! Performs the Standard Transformation, by calling Copy then
116   //! ApplyModifiers (which can return an error status)
117   Standard_EXPORT Standard_Boolean Perform (const Interface_Graph& G, const Handle(Interface_Protocol)& protocol, Interface_CheckIterator& checks, Handle(Interface_InterfaceModel)& newmod) Standard_OVERRIDE;
118   
119   //! This the first operation. It calls StandardCopy or OnTheSpot
120   //! according the option
121   Standard_EXPORT void Copy (const Interface_Graph& G, Interface_CopyTool& TC, Handle(Interface_InterfaceModel)& newmod) const;
122   
123   //! This is the standard action of Copy : its takes into account
124   //! only the remaining entities (noted by Graph Status positive)
125   //! and their proper dependances of course. Produces a new model.
126   Standard_EXPORT void StandardCopy (const Interface_Graph& G, Interface_CopyTool& TC, Handle(Interface_InterfaceModel)& newmod) const;
127   
128   //! This is the OnTheSpot action : each entity is bound with ...
129   //! itself. The produced model is the same as the starting one.
130   Standard_EXPORT void OnTheSpot (const Interface_Graph& G, Interface_CopyTool& TC, Handle(Interface_InterfaceModel)& newmod) const;
131
132   //! Applies the modifiers sequentially.
133   //! For each one, prepares required data (if a Selection is associated as a filter).
134   //! For the option OnTheSpot, it determines if the graph may be
135   //! changed and updates <newmod> if required
136   //! If a Modifier causes an error (check "HasFailed"),
137   //! ApplyModifier stops : the following Modifiers are ignored
138   Standard_EXPORT Standard_Boolean ApplyModifiers (const Interface_Graph& G, const Handle(Interface_Protocol)& protocol, Interface_CopyTool& TC, Interface_CheckIterator& checks, Handle(Interface_InterfaceModel)& newmod) const;
139
140   //! This methods allows to know what happened to a starting
141   //! entity after the last Perform. It reads result from the map
142   //! which was filled by Perform.
143   Standard_EXPORT Standard_Boolean Updated (const Handle(Standard_Transient)& entfrom, Handle(Standard_Transient)& entto) const Standard_OVERRIDE;
144   
145   //! Returns a text which defines the way a Transformer works :
146   //! "On the spot edition" or "Standard Copy" followed by
147   //! "<nn> Modifiers"
148   Standard_EXPORT TCollection_AsciiString Label() const Standard_OVERRIDE;
149
150   DEFINE_STANDARD_RTTIEXT(IFSelect_TransformStandard,IFSelect_Transformer)
151
152 private:
153
154   Standard_Boolean thecopy;
155   Handle(IFSelect_Selection) thesel;
156   IFSelect_SequenceOfGeneralModifier themodifs;
157   Handle(Interface_CopyControl) themap;
158
159 };
160
161 #endif // _IFSelect_TransformStandard_HeaderFile