1 -- Created on: 1994-08-24
2 -- Created by: Gilles DEBARBOUILLE
3 -- Copyright (c) 1994-1999 Matra Datavision
4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
6 -- This file is part of Open CASCADE Technology software library.
8 -- This library is free software; you can redistribute it and/or modify it under
9 -- the terms of the GNU Lesser General Public License version 2.1 as published
10 -- by the Free Software Foundation, with special exception defined in the file
11 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 -- distribution for complete text of the license and disclaimer of any warranty.
14 -- Alternatively, this file may be used under the terms of Open CASCADE
15 -- commercial license or contractual agreement.
17 class Variable from Dynamic
23 ---Purpose: This class is the root class for describing
24 -- variables. A variable is useful to specify the
25 -- signature of a method in terms of arguments and if
26 -- necessary variables and/or constants needed inside
27 -- a function. This set of information defines a
28 -- scope for these variables. This class is directly
29 -- used by the MethodDefinition class. From this
30 -- class is derived the instances of variables which
31 -- are used by the classes under the MethodInstance
32 -- class. A variable is composed by :
34 -- * an identifier for giving it a name,
35 -- * a type of expected value,
36 -- * possibly a default value,
37 -- * a mode which explains if the variable is :
39 -- - an input and/or output argument to the method,
40 -- - an internal or constant variable used in the
41 -- body of the method.
45 OStream from Standard,
46 Parameter from Dynamic,
52 Create returns mutable Variable from Dynamic;
56 ---Purpose: Creates and returns an empty instance of this class.
58 Parameter(me : mutable ; aparameter : Parameter from Dynamic)
62 ---Purpose: Sets the parameter <aparameter> in <me>. This
63 -- parameter gives the name, the type of value, and if
64 -- necessary the default value of the variable.
68 Parameter(me) returns any Parameter from Dynamic
72 ---Purpose: Returns the parameter stored in <me>.
76 Mode(me : mutable ; amode : ModeEnum from Dynamic)
80 ---Purpose: Sets the mode to the variable. the mode is to take in
81 -- the enumeration IN, OUT, INOUT, INTERNAL, CONSTANT,
82 -- which describes the type of the variable.
86 Mode(me) returns ModeEnum from Dynamic
90 ---Purpose: Returns the mode of the variable.
94 Dump(me; astream : in out OStream from Standard);
98 ---Purpose: Useful for debugging.
102 theparameter : Parameter from Dynamic;
103 themode : ModeEnum from Dynamic;