summaryrefslogtreecommitdiff
path: root/inc/TDF_RelocationTable.hxx
blob: ad9a0c6163508d9639c9e2f1887723e3a5287f03 (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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
// 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 _TDF_RelocationTable_HeaderFile
#define _TDF_RelocationTable_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineHandle_HeaderFile
#include <Standard_DefineHandle.hxx>
#endif
#ifndef _Handle_TDF_RelocationTable_HeaderFile
#include <Handle_TDF_RelocationTable.hxx>
#endif

#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _TDF_LabelDataMap_HeaderFile
#include <TDF_LabelDataMap.hxx>
#endif
#ifndef _TDF_AttributeDataMap_HeaderFile
#include <TDF_AttributeDataMap.hxx>
#endif
#ifndef _TColStd_IndexedDataMapOfTransientTransient_HeaderFile
#include <TColStd_IndexedDataMapOfTransientTransient.hxx>
#endif
#ifndef _MMgt_TShared_HeaderFile
#include <MMgt_TShared.hxx>
#endif
#ifndef _Handle_TDF_Attribute_HeaderFile
#include <Handle_TDF_Attribute.hxx>
#endif
#ifndef _Handle_Standard_Transient_HeaderFile
#include <Handle_Standard_Transient.hxx>
#endif
#ifndef _Standard_OStream_HeaderFile
#include <Standard_OStream.hxx>
#endif
class TDF_Label;
class TDF_Attribute;
class Standard_Transient;
class TDF_LabelMap;
class TDF_AttributeMap;
class TDF_LabelDataMap;
class TDF_AttributeDataMap;
class TColStd_IndexedDataMapOfTransientTransient;


//! This is a relocation dictionnary between source <br>
//!          and target labels, attributes or any <br>
//!          transient. Note that one target value may be the <br>
//!          relocation value of more than one source object. <br>
//! <br>
//!          Common behaviour: it returns true and the found <br>
//!          relocation value as target object; false <br>
//!          otherwise. <br>
//! <br>
//!          Look at SelfRelocate method for more explanation <br>
//!          about self relocation behavior of this class. <br>
class TDF_RelocationTable : public MMgt_TShared {

public:

  //! Creates an relocation table. <selfRelocate> says <br>
//!          if a value without explicit relocation is its own <br>
//!          relocation. <br>
  Standard_EXPORT   TDF_RelocationTable(const Standard_Boolean selfRelocate = Standard_False);
  //! Sets <mySelfRelocate> to <selfRelocate>. <br>
//! <br>
//!          This flag affects the HasRelocation method <br>
//!          behavior like this: <br>
//! <br>
//!          <mySelfRelocate> == False: <br>
//! <br>
//!          If no relocation object is found in the map, a <br>
//!          null object is returned <br>
//! <br>
//!          <mySelfRelocate> == True: <br>
//! <br>
//!          If no relocation object is found in the map, the <br>
//!          method assumes the source object is relocation <br>
//!          value; so the source object is returned as target <br>
//!          object. <br>
  Standard_EXPORT     void SelfRelocate(const Standard_Boolean selfRelocate) ;
  //! Returns <mySelfRelocate>. <br>
  Standard_EXPORT     Standard_Boolean SelfRelocate() const;
  
  Standard_EXPORT     void AfterRelocate(const Standard_Boolean afterRelocate) ;
  //! Returns <myAfterRelocate>. <br>
  Standard_EXPORT     Standard_Boolean AfterRelocate() const;
  //! Sets the relocation value of <aSourceLabel> to <br>
//!          <aTargetLabel>. <br>
  Standard_EXPORT     void SetRelocation(const TDF_Label& aSourceLabel,const TDF_Label& aTargetLabel) ;
  //! Finds the relocation value of <aSourceLabel> <br>
//!          and returns it into <aTargetLabel>. <br>
//! <br>
//!          (See above SelfRelocate method for more <br>
//!          explanation about the method behavior) <br>
  Standard_EXPORT     Standard_Boolean HasRelocation(const TDF_Label& aSourceLabel,TDF_Label& aTargetLabel) const;
  //! Sets the relocation value of <aSourceAttribute> to <br>
//!          <aTargetAttribute>. <br>
  Standard_EXPORT     void SetRelocation(const Handle(TDF_Attribute)& aSourceAttribute,const Handle(TDF_Attribute)& aTargetAttribute) ;
  //! Finds the relocation value of <aSourceAttribute> <br>
//!          and returns it into <aTargetAttribute>. <br>
//! <br>
//!          (See above SelfRelocate method for more <br>
//!          explanation about the method behavior) <br>
  Standard_EXPORT     Standard_Boolean HasRelocation(const Handle(TDF_Attribute)& aSourceAttribute,Handle(TDF_Attribute)& aTargetAttribute) const;
  //! Sets the relocation value of <aSourceTransient> to <br>
//!          <aTargetTransient>. <br>
  Standard_EXPORT     void SetTransientRelocation(const Handle(Standard_Transient)& aSourceTransient,const Handle(Standard_Transient)& aTargetTransient) ;
  //! Finds the relocation value of <aSourceTransient> <br>
//!          and returns it into <aTargetTransient>. <br>
//! <br>
//!          (See above SelfRelocate method for more <br>
//!          explanation about the method behavior) <br>
  Standard_EXPORT     Standard_Boolean HasTransientRelocation(const Handle(Standard_Transient)& aSourceTransient,Handle(Standard_Transient)& aTargetTransient) const;
  //! Clears the relocation dictionnary, but lets the <br>
//!          self relocation flag to its current value. <br>
  Standard_EXPORT     void Clear() ;
  //! Fills <aLabelMap> with target relocation <br>
//!          labels. <aLabelMap> is not cleared before use. <br>
  Standard_EXPORT     void TargetLabelMap(TDF_LabelMap& aLabelMap) const;
  //! Fills <anAttributeMap> with target relocation <br>
//!          attributes. <anAttributeMap> is not cleared before <br>
//!          use. <br>
  Standard_EXPORT     void TargetAttributeMap(TDF_AttributeMap& anAttributeMap) const;
  //! Returns <myLabelTable> to be used or updated. <br>
//! <br>
  Standard_EXPORT     TDF_LabelDataMap& LabelTable() ;
  //! Returns <myAttributeTable> to be used or updated. <br>
//! <br>
  Standard_EXPORT     TDF_AttributeDataMap& AttributeTable() ;
  //! Returns <myTransientTable> to be used or updated. <br>
//! <br>
  Standard_EXPORT     TColStd_IndexedDataMapOfTransientTransient& TransientTable() ;
  //! Dumps the relocation table. <br>
//! <br>
  Standard_EXPORT     Standard_OStream& Dump(const Standard_Boolean dumpLabels,const Standard_Boolean dumpAttributes,const Standard_Boolean dumpTransients,Standard_OStream& anOS) const;




  DEFINE_STANDARD_RTTI(TDF_RelocationTable)

protected:




private: 


Standard_Boolean mySelfRelocate;
Standard_Boolean myAfterRelocate;
TDF_LabelDataMap myLabelTable;
TDF_AttributeDataMap myAttributeTable;
TColStd_IndexedDataMapOfTransientTransient myTransientTable;


};





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


#endif