0031939: Coding - correction of spelling errors in comments [part 4]
[occt.git] / src / IFSelect / IFSelect_Transformer.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_Transformer_HeaderFile
18 #define _IFSelect_Transformer_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <Standard_Transient.hxx>
24 #include <Standard_Boolean.hxx>
25 class Interface_Graph;
26 class Interface_Protocol;
27 class Interface_CheckIterator;
28 class Interface_InterfaceModel;
29 class Standard_Transient;
30 class TCollection_AsciiString;
31
32 class IFSelect_Transformer;
33 DEFINE_STANDARD_HANDLE(IFSelect_Transformer, Standard_Transient)
34
35 //! A Transformer defines the way an InterfaceModel is transformed
36 //! (without sending it to a file).
37 //! In order to work, each type of Transformer defines it method
38 //! Perform, it can be parametred as needed.
39 //!
40 //! It receives a Model (the data set) as input. It then can :
41 //! - edit this Model on the spot
42 //!   (i.e. alter its content: by editing entities, or adding/replacing some ...)
43 //! - produce a copied Model, which detains the needed changes
44 //!   (typically on the same type, but some or all entities being
45 //!   rebuilt or converted; or converted from a protocol to another one)
46 class IFSelect_Transformer : public Standard_Transient
47 {
48
49 public:
50
51   //! Performs a Transformation (defined by each sub-class) :
52   //! <G> gives the input data (especially the starting model) and
53   //! can be used for queries (by Selections, etc...)
54   //! <protocol> allows to work with General Services as necessary
55   //! (it applies to input data)
56   //! If the change corresponds to a conversion to a new protocol,
57   //! see also the method ChangeProtocol
58   //! <checks> stores produced checks messages if any
59   //! <newmod> gives the result of the transformation :
60   //! - if it is Null (i.e. has not been affected), the transformation
61   //! has been made on the spot, it is assumed to cause no change
62   //! to the graph of dependances
63   //! - if it equates the starting Model, it has been transformed on
64   //! the spot (possibiliy some entities were replaced inside it)
65   //! - if it is new, it corresponds to a new data set which replaces
66   //! the starting one
67   //!
68   //! <me> is mutable to allow results for ChangeProtocol to be
69   //! memorized if needed, and to store information useful for
70   //! the method Updated
71   //!
72   //! Returns True if Done, False if an Error occurred:
73   //! in this case, if a new data set has been produced, the transformation is ignored,
74   //! else data may be corrupted.
75   Standard_EXPORT virtual Standard_Boolean Perform (const Interface_Graph& G, const Handle(Interface_Protocol)& protocol, Interface_CheckIterator& checks, Handle(Interface_InterfaceModel)& newmod) = 0;
76   
77   //! This methods allows to declare that the Protocol applied to
78   //! the new Model has changed. It applies to the last call to
79   //! Perform.
80   //!
81   //! Returns True if the Protocol has changed, False else.
82   //! The provided default keeps the starting Protocol. This method
83   //! should be redefined as required by the effect of Perform.
84   Standard_EXPORT virtual Standard_Boolean ChangeProtocol (Handle(Interface_Protocol)& newproto) const;
85   
86   //! This method allows to know what happened to a starting
87   //! entity after the last Perform. If <entfrom> (from starting
88   //! model) has one and only one known item which corresponds in
89   //! the new produced model, this method must return True and
90   //! fill the argument <entto>. Else, it returns False.
91   Standard_EXPORT virtual Standard_Boolean Updated (const Handle(Standard_Transient)& entfrom, Handle(Standard_Transient)& entto) const = 0;
92   
93   //! Returns a text which defines the way a Transformer works
94   //! (to identify the transformation it performs)
95   Standard_EXPORT virtual TCollection_AsciiString Label() const = 0;
96
97   DEFINE_STANDARD_RTTIEXT(IFSelect_Transformer,Standard_Transient)
98
99
100 };
101
102 #endif // _IFSelect_Transformer_HeaderFile