0031939: Coding - correction of spelling errors in comments [part 3]
[occt.git] / src / TransferBRep / TransferBRep_BinderOfShape.hxx
1 // Created on: 1992-02-17
2 // Created by: Christian CAILLET
3 // Copyright (c) 1992-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 _TransferBRep_BinderOfShape_HeaderFile
18 #define _TransferBRep_BinderOfShape_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <TopoDS_Shape.hxx>
24 #include <Transfer_Binder.hxx>
25 #include <Standard_Type.hxx>
26 #include <Standard_CString.hxx>
27 class Transfer_TransferFailure;
28 class TopoDS_Shape;
29
30
31 class TransferBRep_BinderOfShape;
32 DEFINE_STANDARD_HANDLE(TransferBRep_BinderOfShape, Transfer_Binder)
33
34 //! Allows direct binding between a starting Object and the Result
35 //! of its transfer when it is Unique.
36 //! The Result itself is defined as a formal parameter <Shape from TopoDS>
37 //! Warning : While it is possible to instantiate BinderOfShape with any Type
38 //! for the Result, it is not advisable to instantiate it with
39 //! Transient Classes, because such Results are directly known and
40 //! managed by TransferProcess & Co, through
41 //! SimpleBinderOfTransient : this class looks like instantiation
42 //! of BinderOfShape, but its method ResultType
43 //! is adapted (reads DynamicType of the Result)
44 class TransferBRep_BinderOfShape : public Transfer_Binder
45 {
46
47 public:
48
49   
50   //! normal standard constructor, creates an empty BinderOfShape
51   Standard_EXPORT TransferBRep_BinderOfShape();
52   
53   //! constructor which in the same time defines the result
54   //! Returns True if a starting object is bound with SEVERAL
55   //! results : Here, returns always False
56   //! But it can have next results
57   Standard_EXPORT TransferBRep_BinderOfShape(const TopoDS_Shape& res);
58   
59   //! Returns the Type permitted for the Result, i.e. the Type
60   //! of the Parameter Class <Shape from TopoDS> (statically defined)
61   Standard_EXPORT Handle(Standard_Type) ResultType() const Standard_OVERRIDE;
62   
63   //! Returns the Type Name computed for the Result (dynamic)
64   Standard_EXPORT Standard_CString ResultTypeName() const Standard_OVERRIDE;
65   
66   //! Defines the Result
67   Standard_EXPORT void SetResult (const TopoDS_Shape& res);
68   
69   //! Returns the defined Result, if there is one
70   Standard_EXPORT const TopoDS_Shape& Result() const;
71   
72   //! Returns the defined Result, if there is one, and allows to
73   //! change it (avoids Result + SetResult).
74   //! Admits that Result can be not yet defined
75   //! Warning : a call to CResult causes Result to be known as defined
76   Standard_EXPORT TopoDS_Shape& CResult();
77
78
79
80
81   DEFINE_STANDARD_RTTIEXT(TransferBRep_BinderOfShape,Transfer_Binder)
82
83 protected:
84
85
86
87
88 private:
89
90
91   TopoDS_Shape theres;
92
93
94 };
95
96
97
98
99
100
101
102 #endif // _TransferBRep_BinderOfShape_HeaderFile