summaryrefslogtreecommitdiff
path: root/inc/Interface_EntityIterator.hxx
blob: 79bd09b5533927df1d85b3500c765e3c185e60a2 (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
// 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 _Interface_EntityIterator_HeaderFile
#define _Interface_EntityIterator_HeaderFile

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

#ifndef _Handle_Interface_IntVal_HeaderFile
#include <Handle_Interface_IntVal.hxx>
#endif
#ifndef _Handle_TColStd_HSequenceOfTransient_HeaderFile
#include <Handle_TColStd_HSequenceOfTransient.hxx>
#endif
#ifndef _Handle_Standard_Transient_HeaderFile
#include <Handle_Standard_Transient.hxx>
#endif
#ifndef _Handle_Standard_Type_HeaderFile
#include <Handle_Standard_Type.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
class Interface_IntVal;
class TColStd_HSequenceOfTransient;
class Standard_NoMoreObject;
class Standard_NoSuchObject;
class Standard_Transient;
class Standard_Type;


//! Defines an Iterator on Entities, complying with GraphTools <br>
//!           needs. Allows considering of various criteria <br>
class Interface_EntityIterator  {
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); 
  }

  //! Defines an empty iterator (see AddList & AddItem) <br>
  Standard_EXPORT   Interface_EntityIterator();
  //! Defines an iterator on a list, directly i.e. without copying it <br>
  Standard_EXPORT   Interface_EntityIterator(const Handle(TColStd_HSequenceOfTransient)& list);
  //! Gets a list of entities and adds its to the iteration list <br>
  Standard_EXPORT     void AddList(const Handle(TColStd_HSequenceOfTransient)& list) ;
  //! Adds to the iteration list a defined entity <br>
  Standard_EXPORT     void AddItem(const Handle(Standard_Transient)& anentity) ;
  //! same as AddItem (kept for compatibility) <br>
  Standard_EXPORT     void GetOneItem(const Handle(Standard_Transient)& anentity) ;
  //! Selects entities with are Kind of a given type,  keep only <br>
//!           them (is keep is True) or reject only them (if keep is False) <br>
  Standard_EXPORT     void SelectType(const Handle(Standard_Type)& atype,const Standard_Boolean keep) ;
  //! Returns count of entities which will be iterated on <br>
//!           Calls Start if not yet done <br>
  Standard_EXPORT     Standard_Integer NbEntities() const;
  //! Returns count of entities of a given type (kind of) <br>
  Standard_EXPORT     Standard_Integer NbTyped(const Handle(Standard_Type)& type) const;
  //! Returns the list of entities of a given type (kind of) <br>
  Standard_EXPORT     Interface_EntityIterator Typed(const Handle(Standard_Type)& type) const;
  //! Allows re-iteration (useless for the first iteration) <br>
  Standard_EXPORT   virtual  void Start() const;
  //! Says if there are other entities (vertices) to iterate <br>
//!           the first time, calls Start <br>
  Standard_EXPORT     Standard_Boolean More() const;
  //! Sets iteration to the next entity (vertex) to give <br>
  Standard_EXPORT     void Next() const;
  //! Returns the current Entity iterated, to be used by Interface <br>
//!           tools or by GraphTools (where Entity is a Vertex) <br>
  Standard_EXPORT    const Handle_Standard_Transient& Value() const;
  //! Returns the content of the Iterator, accessed through a Handle <br>
//!           to be used by a frontal-engine logic <br>
//!           Returns an empty Sequence if the Iterator is empty <br>
//!           Calls Start if not yet done <br>
  Standard_EXPORT     Handle_TColStd_HSequenceOfTransient Content() const;
  //! Clears data of iteration <br>
  Standard_EXPORT   virtual  void Destroy() ;
Standard_EXPORT virtual ~Interface_EntityIterator() { Destroy();}





protected:

  //! Allows subclasses of EntityIterator to reevaluate an iteration <br>
  Standard_EXPORT     void Reset() ;




private:



Handle_Interface_IntVal thecurr;
Handle_TColStd_HSequenceOfTransient thelist;


};





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


#endif