0031939: Coding - correction of spelling errors in comments [part 3]
[occt.git] / src / Transfer / Transfer_TransientListBinder.hxx
1 // Created on: 1994-10-03
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 _Transfer_TransientListBinder_HeaderFile
18 #define _Transfer_TransientListBinder_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <TColStd_HSequenceOfTransient.hxx>
24 #include <Transfer_Binder.hxx>
25 #include <Standard_Boolean.hxx>
26 #include <Standard_Type.hxx>
27 #include <Standard_CString.hxx>
28 #include <Standard_Integer.hxx>
29 class Standard_TypeMismatch;
30 class Standard_OutOfRange;
31 class Standard_Transient;
32
33
34 class Transfer_TransientListBinder;
35 DEFINE_STANDARD_HANDLE(Transfer_TransientListBinder, Transfer_Binder)
36
37 //! This binder binds several (a list of) Transients with a starting
38 //! entity, when this entity itself corresponds to a simple list
39 //! of Transients. Each part is not seen as a sub-result of an
40 //! independent component, but as an item of a built-in list
41 class Transfer_TransientListBinder : public Transfer_Binder
42 {
43
44 public:
45
46   
47   Standard_EXPORT Transfer_TransientListBinder();
48   
49   Standard_EXPORT Transfer_TransientListBinder(const Handle(TColStd_HSequenceOfTransient)& list);
50   
51   Standard_EXPORT virtual Standard_Boolean IsMultiple() const Standard_OVERRIDE;
52   
53   Standard_EXPORT Handle(Standard_Type) ResultType() const Standard_OVERRIDE;
54   
55   Standard_EXPORT Standard_CString ResultTypeName() const Standard_OVERRIDE;
56   
57   //! Adds an item to the result list
58   Standard_EXPORT void AddResult (const Handle(Standard_Transient)& res);
59   
60   Standard_EXPORT Handle(TColStd_HSequenceOfTransient) Result() const;
61   
62   //! Changes an already defined sub-result
63   Standard_EXPORT void SetResult (const Standard_Integer num, const Handle(Standard_Transient)& res);
64   
65   Standard_EXPORT Standard_Integer NbTransients() const;
66   
67   Standard_EXPORT const Handle(Standard_Transient)& Transient (const Standard_Integer num) const;
68
69
70
71
72   DEFINE_STANDARD_RTTIEXT(Transfer_TransientListBinder,Transfer_Binder)
73
74 protected:
75
76
77
78
79 private:
80
81
82   Handle(TColStd_HSequenceOfTransient) theres;
83
84
85 };
86
87
88
89
90
91
92
93 #endif // _Transfer_TransientListBinder_HeaderFile