1 -- Created on: 1993-12-23
2 -- Created by: Gilles DEBARBOUILLE
3 -- Copyright (c) 1993-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 generic class MethodInstance from Dynamic (Dictionary as Transient)
23 ---Purpose: This class describes the facilities available to
24 -- manipulate methods objects. It is a generic class
25 -- because the creation of a MethodInstance requests
26 -- a specific dictionary of definitions. In a method
27 -- instance, it is only possible to set
28 -- VariableInstance which are roughtly a copy of the
29 -- variable set in the method definition and a
30 -- pointer on the variable, describing the signature
31 -- of the complex method in the process of build or
32 -- addressing the user value.
36 CString from Standard,
37 OStream from Standard,
38 Boolean from Standard,
39 ModeEnum from Dynamic,
40 Parameter from Dynamic,
41 Variable from Dynamic,
42 VariableNode from Dynamic,
43 AsciiString from TCollection
48 Create(atype : CString from Standard) returns mutable MethodInstance from Dynamic;
52 --- Purpose: Creates a MethodInstance object of the type <atype>.
53 -- If <atype> is not defined in the dictionary, the object
54 -- created will have no definition.
56 Create(amethodinstance : MethodInstance from Dynamic) returns mutable MethodInstance from Dynamic;
60 --- Purpose: Creates a MethodInstance with as definition the method
61 -- instance <amethodinstance>.
63 Type(me) returns AsciiString from TCollection
67 ---Purpose: Returns the type of object read in the definition.
71 Definition(me) returns Method from Dynamic
75 ---Purpose: Returns a reference to the definition of the
80 Variable(me : mutable ; aparameter : Parameter from Dynamic
81 ; amode : ModeEnum from Dynamic
82 ; avariable : Variable from Dynamic)
86 ---Purpose: Creates and adds to the instance <me> the variable
87 -- instance build with <aparameter> and <amode> and
88 -- adresses the variable .
92 Value(me ; aname : CString from Standard
93 ; aparameter : out any Parameter from Dynamic
94 ; amode : out ModeEnum from Dynamic
95 ; avariable : out any Variable from Dynamic) returns Boolean
99 ---Purpose: Returns True, if there is a variable instance named
100 -- <aname>, False otherwise. It returns in the argument
101 -- <aparameter> the signature of the variable, in <amode>
102 -- the variable is in, out, inout, internal or constant
103 -- and in <avariable>, the reference to the effective
104 -- value used by the instance or a reference to the
105 -- variable defining the signature of the complex method
106 -- using this instance of method.
110 Value(me ; aname : CString from Standard
111 ; aparameter : out any Parameter from Dynamic
112 ; amode : out ModeEnum from Dynamic
113 ; avariablenode : out any VariableNode from Dynamic) returns Boolean from Standard
117 ---Purpose: Returns True, if there is a variable instance named
118 -- <aname>, False otherwise. It returns in the argument
119 -- <aparameter> the signature of the variable, in <amode>
120 -- the variable is in, out, inout, internal or constant
121 -- and in <avariablenode>, the head of the effective
122 -- referenced value used by the instance or the head of
123 -- the variables reference defining the signature of the
124 -- complex method using this instance of method.
128 Dump(me ; astream : in out OStream from Standard)
132 ---Purpose: Useful for debugging.
138 thedefinition : Method from Dynamic;