summaryrefslogtreecommitdiff
path: root/inc/Dynamic_Variable.hxx
blob: 094a36e0503691ef9de4340b3b752da49f19512b (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
// 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 _Dynamic_Variable_HeaderFile
#define _Dynamic_Variable_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineHandle_HeaderFile
#include <Standard_DefineHandle.hxx>
#endif
#ifndef _Handle_Dynamic_Variable_HeaderFile
#include <Handle_Dynamic_Variable.hxx>
#endif

#ifndef _Handle_Dynamic_Parameter_HeaderFile
#include <Handle_Dynamic_Parameter.hxx>
#endif
#ifndef _Dynamic_ModeEnum_HeaderFile
#include <Dynamic_ModeEnum.hxx>
#endif
#ifndef _MMgt_TShared_HeaderFile
#include <MMgt_TShared.hxx>
#endif
#ifndef _Standard_OStream_HeaderFile
#include <Standard_OStream.hxx>
#endif
class Dynamic_Parameter;


//! This  class   is the  root   class for  describing <br>
//!          variables.  A   variable is useful to  specify the <br>
//!          signature of a method in terms of arguments and if <br>
//!          necessary variables and/or constants needed inside <br>
//!          a  function.   This  set  of information defines a <br>
//!          scope for  these variables. This class is directly <br>
//!          used   by  the MethodDefinition class.   From this <br>
//!          class is  derived the instances of variables which <br>
//!          are used by the  classes under the  MethodInstance <br>
//!          class. A variable is composed by : <br>
//! <br>
//!          * an identifier for giving it a name, <br>
//!          * a type of expected value, <br>
//!          * possibly a default value, <br>
//!          * a mode which explains if the variable is : <br>
//! <br>
//!            - an input and/or output argument to the method, <br>
//!            - an internal or  constant variable used in  the <br>
//!            body of the method. <br>
class Dynamic_Variable : public MMgt_TShared {

public:

  //! Creates and returns an empty instance of this class. <br>
  Standard_EXPORT   Dynamic_Variable();
  //! Sets  the   parameter  <aparameter>   in  <me>.   This <br>
//!          parameter gives the name,  the  type of value, and  if <br>
//!          necessary the default value of the variable. <br>
  Standard_EXPORT     void Parameter(const Handle(Dynamic_Parameter)& aparameter) ;
  //! Returns the parameter stored in <me>. <br>
  Standard_EXPORT     Handle_Dynamic_Parameter Parameter() const;
  //! Sets the mode to the variable. the  mode is to take in <br>
//!          the enumeration  IN,  OUT, INOUT,  INTERNAL, CONSTANT, <br>
//!          which describes the type of the variable. <br>
  Standard_EXPORT     void Mode(const Dynamic_ModeEnum amode) ;
  //! Returns the mode of the variable. <br>
  Standard_EXPORT     Dynamic_ModeEnum Mode() const;
  //! Useful for debugging. <br>
  Standard_EXPORT     void Dump(Standard_OStream& astream) const;




  DEFINE_STANDARD_RTTI(Dynamic_Variable)

protected:




private: 


Handle_Dynamic_Parameter theparameter;
Dynamic_ModeEnum themode;


};





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


#endif