summaryrefslogtreecommitdiff
path: root/inc/TDF_ComparisonTool.hxx
blob: 12fbe4d073dfc85fa8aca061bbdfc60b31365895 (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
// 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_ComparisonTool_HeaderFile
#define _TDF_ComparisonTool_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_Macro_HeaderFile
#include <Standard_Macro.hxx>
#endif

#ifndef _Handle_TDF_DataSet_HeaderFile
#include <Handle_TDF_DataSet.hxx>
#endif
#ifndef _Handle_TDF_RelocationTable_HeaderFile
#include <Handle_TDF_RelocationTable.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
class TDF_DataSet;
class TDF_IDFilter;
class TDF_RelocationTable;
class TDF_Label;


//! This class provides services to compare sets of <br>
//!          information. The use of this tool can works after <br>
//!          a copy, acted by a CopyTool. <br>
//! <br>
//!          * Compare(...) compares two DataSet and returns <br>
//!          the result. <br>
//! <br>
//!          * SourceUnbound(...) builds the difference between <br>
//!          a relocation dictionnary and a source set of <br>
//!          information. <br>
//! <br>
//!          * TargetUnbound(...) does the same between a <br>
//!          relocation dictionnary and a target set of <br>
//!          information. <br>
//! <br>
//!          * Cut(aDataSet, anLabel) removes a set of <br>
//!          attributes. <br>
//! <br>
//!          * IsSelfContained(...) returns true if all the <br>
//!          labels of the attributes of the given DataSet are <br>
//!          descendant of the given label. <br>
class TDF_ComparisonTool  {
public:

  void* operator new(size_t,void* anAddress) 
  {
    return anAddress;
  }
  void* operator new(size_t size) 
  {
    return Standard::Allocate(size); 
  }
  void  operator delete(void *anAddress) 
  {
    if (anAddress) Standard::Free((Standard_Address&)anAddress); 
  }

  //! Compares <aSourceDataSet> with <aTargetDataSet>, <br>
//!          updating <aRelocationTable> with labels and <br>
//!          attributes found in both sets. <br>
  Standard_EXPORT   static  void Compare(const Handle(TDF_DataSet)& aSourceDataSet,const Handle(TDF_DataSet)& aTargetDataSet,const TDF_IDFilter& aFilter,const Handle(TDF_RelocationTable)& aRelocationTable) ;
  //! Finds from <aRefDataSet> all the keys not bound <br>
//!          into <aRelocationTable> and put them into <br>
//!          <aDiffDataSet>. Returns True if the difference <br>
//!          contains at least one key. (A key is a source <br>
//!          object). <br>
//! <br>
//!          <anOption> may take the following values: <br>
//!          1 : labels treatment only; <br>
//!          2 : attributes treatment only (default value); <br>
//!          3 : both labels & attributes treatment. <br>
  Standard_EXPORT   static  Standard_Boolean SourceUnbound(const Handle(TDF_DataSet)& aRefDataSet,const Handle(TDF_RelocationTable)& aRelocationTable,const TDF_IDFilter& aFilter,const Handle(TDF_DataSet)& aDiffDataSet,const Standard_Integer anOption = 2) ;
  //! Substracts from <aRefDataSet> all the items bound <br>
//!          into <aRelocationTable>. The result is put into <br>
//!          <aDiffDataSet>. Returns True if the difference <br>
//!          contains at least one item. (An item is a target <br>
//!          object). <br>
//! <br>
//!          <anOption> may take the following values: <br>
//!          1 : labels treatment only; <br>
//!          2 : attributes treatment  only(default value); <br>
//!          3 : both labels & attributes treatment. <br>
  Standard_EXPORT   static  Standard_Boolean TargetUnbound(const Handle(TDF_DataSet)& aRefDataSet,const Handle(TDF_RelocationTable)& aRelocationTable,const TDF_IDFilter& aFilter,const Handle(TDF_DataSet)& aDiffDataSet,const Standard_Integer anOption = 2) ;
  //! Removes attributes from <aDataSet>. <br>
  Standard_EXPORT   static  void Cut(const Handle(TDF_DataSet)& aDataSet) ;
  //! Returns true if all the labels of <aDataSet> are <br>
//!          descendant of <aLabel>. <br>
  Standard_EXPORT   static  Standard_Boolean IsSelfContained(const TDF_Label& aLabel,const Handle(TDF_DataSet)& aDataSet) ;





protected:





private:

  //! Internal comparison method used by Compare(...). <br>
  Standard_EXPORT   static  void Compare(const TDF_Label& aSrcLabel,const TDF_Label& aTrgLabel,const Handle(TDF_DataSet)& aSourceDataSet,const Handle(TDF_DataSet)& aTargetDataSet,const TDF_IDFilter& aFilter,const Handle(TDF_RelocationTable)& aRelocationTable) ;
  //! Internal function used by SourceUnbound() and <br>
//!          TargetUnbound(). <br>
  Standard_EXPORT   static  Standard_Boolean Unbound(const Handle(TDF_DataSet)& aRefDataSet,const Handle(TDF_RelocationTable)& aRelocationTable,const TDF_IDFilter& aFilter,const Handle(TDF_DataSet)& aDiffDataSet,const Standard_Integer anOption,const Standard_Boolean theSource) ;




};





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


#endif