summaryrefslogtreecommitdiff
path: root/inc/TFunction_Iterator.hxx
blob: 2c69944f3e77069ef7e6826e1c53e61596a18d66 (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
// 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 _TFunction_Iterator_HeaderFile
#define _TFunction_Iterator_HeaderFile

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

#ifndef _TDF_LabelList_HeaderFile
#include <TDF_LabelList.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _TDF_LabelMap_HeaderFile
#include <TDF_LabelMap.hxx>
#endif
#ifndef _Handle_TFunction_Scope_HeaderFile
#include <Handle_TFunction_Scope.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _TFunction_ExecutionStatus_HeaderFile
#include <TFunction_ExecutionStatus.hxx>
#endif
#ifndef _Standard_OStream_HeaderFile
#include <Standard_OStream.hxx>
#endif
class TFunction_Scope;
class TDF_Label;
class TDF_LabelList;


//! Iterator of the graph of functions <br>
class TFunction_Iterator  {
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); 
  }

  //! An empty constructor. <br>
  Standard_EXPORT   TFunction_Iterator();
  //! A constructor. <br>
//!          Initializes the iterator. <br>
  Standard_EXPORT   TFunction_Iterator(const TDF_Label& Access);
  //! Initializes the Iterator. <br>
  Standard_EXPORT   virtual  void Init(const TDF_Label& Access) ;
  //! Defines the mode of iteration - usage or not of the execution status. <br>
//!          If the iterator takes into account the execution status, <br>
//!          the method ::Current() returns only "not executed" functions <br>
//!          while their status is not changed. <br>
//!          If the iterator ignores the execution status, <br>
//!          the method ::Current() returns the functions <br>
//!          following their dependencies and ignoring the execution status. <br>
  Standard_EXPORT     void SetUsageOfExecutionStatus(const Standard_Boolean usage) ;
  //! Returns usage of execution status by the iterator. <br>
  Standard_EXPORT     Standard_Boolean GetUsageOfExecutionStatus() const;
  //! Analyses the graph of dependencies and returns <br>
//!          maximum number of threads may be used to calculate the model. <br>
  Standard_EXPORT   virtual  Standard_Integer GetMaxNbThreads() const;
  //! Returns the current list of functions. <br>
//!          If the iterator uses the execution status, <br>
//!          the returned list contains only the functions <br>
//!          with "not executed" status. <br>
  Standard_EXPORT   virtual const TDF_LabelList& Current() const;
  //! Returns false if the graph of functions is fully iterated. <br>
  Standard_EXPORT   virtual  Standard_Boolean More() const;
  //! Switches the iterator to the next list of current functions. <br>
  Standard_EXPORT   virtual  void Next() ;
  //! A help-function aimed to help the user to check the status of retrurned function. <br>
//!          It calls TFunction_GraphNode::GetStatus() inside. <br>
  Standard_EXPORT     TFunction_ExecutionStatus GetStatus(const TDF_Label& func) const;
  //! A help-function aimed to help the user to change the execution status of a function. <br>
//!          It calls TFunction_GraphNode::SetStatus() inside. <br>
  Standard_EXPORT     void SetStatus(const TDF_Label& func,const TFunction_ExecutionStatus status) const;
  
  Standard_EXPORT     Standard_OStream& Dump(Standard_OStream& OS) const;





protected:





private:



TDF_LabelList myCurrent;
Standard_Boolean myUsageOfExecutionStatus;
TDF_LabelMap myPassedFunctions;
Handle_TFunction_Scope myScope;


};





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


#endif