summaryrefslogtreecommitdiff
path: root/inc/TFunction_Driver.hxx
blob: f870366dbca5589dfcdbae81c0a1dc3a01124ad3 (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
// 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_Driver_HeaderFile
#define _TFunction_Driver_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineHandle_HeaderFile
#include <Standard_DefineHandle.hxx>
#endif
#ifndef _Handle_TFunction_Driver_HeaderFile
#include <Handle_TFunction_Driver.hxx>
#endif

#ifndef _TDF_Label_HeaderFile
#include <TDF_Label.hxx>
#endif
#ifndef _MMgt_TShared_HeaderFile
#include <MMgt_TShared.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
class TDF_Label;
class TFunction_Logbook;
class TDF_LabelList;


//! This  driver  class provide  services  around function <br>
//!          execution.   One instance of  this class is  built for <br>
//!          the whole  session.    The driver  is bound   to   the <br>
//!          DriverGUID in the DriverTable class. <br>
//!          It allows you to create classes which inherit from <br>
//!          this abstract class. <br>
//!          These subclasses identify the various algorithms <br>
//!          which can be applied to the data contained in the <br>
//!          attributes of sub-labels of a model. <br>
//!          A single instance of this class and each of its <br>
//!          subclasses is built for the whole session. <br>
class TFunction_Driver : public MMgt_TShared {

public:

  //! Initializes the label L for this function prior to its  execution. <br>
  Standard_EXPORT     void Init(const TDF_Label& L) ;
  //! Returns the label of the driver for this function. <br>
        TDF_Label Label() const;
  //! Validates labels of a function  in <log>. <br>
//! This function is the one initialized in this function driver. <br>
//! Warning <br>
//! In regeneration mode, the solver must call this <br>
//! method even if the function is not executed. <br>//! execution of function <br>
//!          ===================== <br>
  Standard_EXPORT   virtual  void Validate(TFunction_Logbook& log) const;
  //! Analyzes the labels in the logbook log. <br>
//! Returns true if attributes have been modified. <br>
//! If the function label itself has been modified, the function must be executed. <br>
  Standard_EXPORT   virtual  Standard_Boolean MustExecute(const TFunction_Logbook& log) const;
  //! Executes the function in this function driver and <br>
//! puts the impacted labels in the logbook log. <br>//! arguments & results of functions <br>
//!          ================================ <br>
  Standard_EXPORT   virtual  Standard_Integer Execute(TFunction_Logbook& log) const = 0;
  //! The method fills-in the list by labels, <br>
//!          where the arguments of the function are located. <br>
  Standard_EXPORT   virtual  void Arguments(TDF_LabelList& args) const;
  //! The method fills-in the list by labels, <br>
//!          where the results of the function are located. <br>
  Standard_EXPORT   virtual  void Results(TDF_LabelList& res) const;




  DEFINE_STANDARD_RTTI(TFunction_Driver)

protected:

  //! initialisation of the driver <br>
//!          ============================ <br>
  Standard_EXPORT   TFunction_Driver();



private: 


TDF_Label myLabel;


};


#include <TFunction_Driver.lxx>



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


#endif