summaryrefslogtreecommitdiff
path: root/inc/TDF_ChildIterator.hxx
blob: edff0a4e6f7feb28f48f1a1bd58c8053d971c57f (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_ChildIterator_HeaderFile
#define _TDF_ChildIterator_HeaderFile

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

#ifndef _TDF_LabelNodePtr_HeaderFile
#include <TDF_LabelNodePtr.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _TDF_Label_HeaderFile
#include <TDF_Label.hxx>
#endif
class TDF_Label;


//! Iterates on the children of a label, at the first <br>
//!          level only. It is possible to ask the iterator to <br>
//!          explore all the sub label levels of the given one, <br>
//!          with the option "allLevels". <br>
class TDF_ChildIterator  {
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); 
  }

  //! Creates an empty iterator  object to <br>
//!  explore the children of a label. <br>
  Standard_EXPORT   TDF_ChildIterator();
  //! Constructs the iterator object defined by <br>
//!  the label aLabel.  Iterates on the children of the given label. If <br>
//!          <allLevels> option is set to true, it explores not <br>
//!          only the first, but all the sub label levels. <br>
  Standard_EXPORT   TDF_ChildIterator(const TDF_Label& aLabel,const Standard_Boolean allLevels = Standard_False);
  //! Initializes the iteration on the children of the <br>
//!          given label. <br>
//! If <allLevels> option is set to true, <br>
//!          it explores not only the first, but all the sub <br>
//!          label levels. <br>
//!  If allLevels is false, only the first level of <br>
//!  child labels is explored. <br>
//!  In the example below, the label is iterated <br>
//!  using Initialize, More and Next and its <br>
//!  child labels dumped using TDF_Tool::Entry. <br>
//!  Example <br>
//!  void DumpChildren(const <br>
//!  TDF_Label& aLabel) <br>
//!  { <br>
//!  TDF_ChildIterator it; <br>
//!  TCollection_AsciiString es; <br>
//!  for <br>
//!  (it.Initialize(aLabel,Standard_True); <br>
//!  it.More(); it.Next()){ <br>
//!  TDF_Tool::Entry(it.Value(),es); <br>
//!  cout << as.ToCString() << endl; <br>
//!  } <br>
//!  } <br>
  Standard_EXPORT     void Initialize(const TDF_Label& aLabel,const Standard_Boolean allLevels = Standard_False) ;
  //! Returns true if a current label is found in the <br>
//!  iteration process. <br>
//! <br>
        Standard_Boolean More() const;
  //! Move the  current  iteration  to the next Item. <br>
  Standard_EXPORT     void Next() ;
  //! Moves this iteration to the next brother <br>
//!  label. A brother label is one with the same <br>
//!  father as an initial label. <br>
//!  Use this function when the non-empty <br>
//!  constructor or Initialize has allLevels set to <br>
//!  true. The result is that the iteration does not <br>
//!  explore the children of the current label. <br>
//!          This method is interesting only with <br>
//!          "allLevels" behavior, because it avoids to explore <br>
//!          the current label children. <br>
  Standard_EXPORT     void NextBrother() ;
  //! Returns the current label; or, if there is <br>
//!          none, a null label. <br>
//! <br>
       const TDF_Label Value() const;





protected:





private:



TDF_LabelNodePtr myNode;
Standard_Integer myFirstLevel;


};


#include <TDF_ChildIterator.lxx>



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


#endif