1------------------------------------------------------------------------------
2--                                                                          --
3--                            Matreshka Project                             --
4--                                                                          --
5--                          Ada Modeling Framework                          --
6--                                                                          --
7--                        Runtime Library Component                         --
8--                                                                          --
9------------------------------------------------------------------------------
10--                                                                          --
11-- Copyright © 2011-2012, Vadim Godunko <vgodunko@gmail.com>                --
12-- All rights reserved.                                                     --
13--                                                                          --
14-- Redistribution and use in source and binary forms, with or without       --
15-- modification, are permitted provided that the following conditions       --
16-- are met:                                                                 --
17--                                                                          --
18--  * Redistributions of source code must retain the above copyright        --
19--    notice, this list of conditions and the following disclaimer.         --
20--                                                                          --
21--  * Redistributions in binary form must reproduce the above copyright     --
22--    notice, this list of conditions and the following disclaimer in the   --
23--    documentation and/or other materials provided with the distribution.  --
24--                                                                          --
25--  * Neither the name of the Vadim Godunko, IE nor the names of its        --
26--    contributors may be used to endorse or promote products derived from  --
27--    this software without specific prior written permission.              --
28--                                                                          --
29-- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS      --
30-- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT        --
31-- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR    --
32-- A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT     --
33-- HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,   --
34-- SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED --
35-- TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR   --
36-- PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF   --
37-- LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING     --
38-- NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS       --
39-- SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.             --
40--                                                                          --
41------------------------------------------------------------------------------
42--  $Revision: 2937 $ $Date: 2012-05-01 21:07:27 +0400 (Tue, 01 May 2012) $
43------------------------------------------------------------------------------
44with AMF.Internals.UML_Named_Elements;
45with AMF.UML.Activities;
46with AMF.UML.Activity_Edges.Collections;
47with AMF.UML.Activity_Groups.Collections;
48with AMF.UML.Activity_Nodes.Collections;
49with AMF.UML.Activity_Partitions.Collections;
50with AMF.UML.Classifiers.Collections;
51with AMF.UML.Clear_Variable_Actions;
52with AMF.UML.Constraints.Collections;
53with AMF.UML.Dependencies.Collections;
54with AMF.UML.Exception_Handlers.Collections;
55with AMF.UML.Input_Pins.Collections;
56with AMF.UML.Interruptible_Activity_Regions.Collections;
57with AMF.UML.Named_Elements;
58with AMF.UML.Namespaces;
59with AMF.UML.Output_Pins.Collections;
60with AMF.UML.Packages.Collections;
61with AMF.UML.Redefinable_Elements.Collections;
62with AMF.UML.String_Expressions;
63with AMF.UML.Structured_Activity_Nodes;
64with AMF.UML.Variables;
65with AMF.Visitors;
66
67package AMF.Internals.UML_Clear_Variable_Actions is
68
69   type UML_Clear_Variable_Action_Proxy is
70     limited new AMF.Internals.UML_Named_Elements.UML_Named_Element_Proxy
71       and AMF.UML.Clear_Variable_Actions.UML_Clear_Variable_Action with null record;
72
73   overriding function Get_Variable
74    (Self : not null access constant UML_Clear_Variable_Action_Proxy)
75       return AMF.UML.Variables.UML_Variable_Access;
76   --  Getter of VariableAction::variable.
77   --
78   --  Variable to be read.
79
80   overriding procedure Set_Variable
81    (Self : not null access UML_Clear_Variable_Action_Proxy;
82     To   : AMF.UML.Variables.UML_Variable_Access);
83   --  Setter of VariableAction::variable.
84   --
85   --  Variable to be read.
86
87   overriding function Get_Context
88    (Self : not null access constant UML_Clear_Variable_Action_Proxy)
89       return AMF.UML.Classifiers.UML_Classifier_Access;
90   --  Getter of Action::context.
91   --
92   --  The classifier that owns the behavior of which this action is a part.
93
94   overriding function Get_Input
95    (Self : not null access constant UML_Clear_Variable_Action_Proxy)
96       return AMF.UML.Input_Pins.Collections.Ordered_Set_Of_UML_Input_Pin;
97   --  Getter of Action::input.
98   --
99   --  The ordered set of input pins connected to the Action. These are among
100   --  the total set of inputs.
101
102   overriding function Get_Is_Locally_Reentrant
103    (Self : not null access constant UML_Clear_Variable_Action_Proxy)
104       return Boolean;
105   --  Getter of Action::isLocallyReentrant.
106   --
107   --  If true, the action can begin a new, concurrent execution, even if
108   --  there is already another execution of the action ongoing. If false, the
109   --  action cannot begin a new execution until any previous execution has
110   --  completed.
111
112   overriding procedure Set_Is_Locally_Reentrant
113    (Self : not null access UML_Clear_Variable_Action_Proxy;
114     To   : Boolean);
115   --  Setter of Action::isLocallyReentrant.
116   --
117   --  If true, the action can begin a new, concurrent execution, even if
118   --  there is already another execution of the action ongoing. If false, the
119   --  action cannot begin a new execution until any previous execution has
120   --  completed.
121
122   overriding function Get_Local_Postcondition
123    (Self : not null access constant UML_Clear_Variable_Action_Proxy)
124       return AMF.UML.Constraints.Collections.Set_Of_UML_Constraint;
125   --  Getter of Action::localPostcondition.
126   --
127   --  Constraint that must be satisfied when executed is completed.
128
129   overriding function Get_Local_Precondition
130    (Self : not null access constant UML_Clear_Variable_Action_Proxy)
131       return AMF.UML.Constraints.Collections.Set_Of_UML_Constraint;
132   --  Getter of Action::localPrecondition.
133   --
134   --  Constraint that must be satisfied when execution is started.
135
136   overriding function Get_Output
137    (Self : not null access constant UML_Clear_Variable_Action_Proxy)
138       return AMF.UML.Output_Pins.Collections.Ordered_Set_Of_UML_Output_Pin;
139   --  Getter of Action::output.
140   --
141   --  The ordered set of output pins connected to the Action. The action
142   --  places its results onto pins in this set.
143
144   overriding function Get_Handler
145    (Self : not null access constant UML_Clear_Variable_Action_Proxy)
146       return AMF.UML.Exception_Handlers.Collections.Set_Of_UML_Exception_Handler;
147   --  Getter of ExecutableNode::handler.
148   --
149   --  A set of exception handlers that are examined if an uncaught exception
150   --  propagates to the outer level of the executable node.
151
152   overriding function Get_Activity
153    (Self : not null access constant UML_Clear_Variable_Action_Proxy)
154       return AMF.UML.Activities.UML_Activity_Access;
155   --  Getter of ActivityNode::activity.
156   --
157   --  Activity containing the node.
158
159   overriding procedure Set_Activity
160    (Self : not null access UML_Clear_Variable_Action_Proxy;
161     To   : AMF.UML.Activities.UML_Activity_Access);
162   --  Setter of ActivityNode::activity.
163   --
164   --  Activity containing the node.
165
166   overriding function Get_In_Group
167    (Self : not null access constant UML_Clear_Variable_Action_Proxy)
168       return AMF.UML.Activity_Groups.Collections.Set_Of_UML_Activity_Group;
169   --  Getter of ActivityNode::inGroup.
170   --
171   --  Groups containing the node.
172
173   overriding function Get_In_Interruptible_Region
174    (Self : not null access constant UML_Clear_Variable_Action_Proxy)
175       return AMF.UML.Interruptible_Activity_Regions.Collections.Set_Of_UML_Interruptible_Activity_Region;
176   --  Getter of ActivityNode::inInterruptibleRegion.
177   --
178   --  Interruptible regions containing the node.
179
180   overriding function Get_In_Partition
181    (Self : not null access constant UML_Clear_Variable_Action_Proxy)
182       return AMF.UML.Activity_Partitions.Collections.Set_Of_UML_Activity_Partition;
183   --  Getter of ActivityNode::inPartition.
184   --
185   --  Partitions containing the node.
186
187   overriding function Get_In_Structured_Node
188    (Self : not null access constant UML_Clear_Variable_Action_Proxy)
189       return AMF.UML.Structured_Activity_Nodes.UML_Structured_Activity_Node_Access;
190   --  Getter of ActivityNode::inStructuredNode.
191   --
192   --  Structured activity node containing the node.
193
194   overriding procedure Set_In_Structured_Node
195    (Self : not null access UML_Clear_Variable_Action_Proxy;
196     To   : AMF.UML.Structured_Activity_Nodes.UML_Structured_Activity_Node_Access);
197   --  Setter of ActivityNode::inStructuredNode.
198   --
199   --  Structured activity node containing the node.
200
201   overriding function Get_Incoming
202    (Self : not null access constant UML_Clear_Variable_Action_Proxy)
203       return AMF.UML.Activity_Edges.Collections.Set_Of_UML_Activity_Edge;
204   --  Getter of ActivityNode::incoming.
205   --
206   --  Edges that have the node as target.
207
208   overriding function Get_Outgoing
209    (Self : not null access constant UML_Clear_Variable_Action_Proxy)
210       return AMF.UML.Activity_Edges.Collections.Set_Of_UML_Activity_Edge;
211   --  Getter of ActivityNode::outgoing.
212   --
213   --  Edges that have the node as source.
214
215   overriding function Get_Redefined_Node
216    (Self : not null access constant UML_Clear_Variable_Action_Proxy)
217       return AMF.UML.Activity_Nodes.Collections.Set_Of_UML_Activity_Node;
218   --  Getter of ActivityNode::redefinedNode.
219   --
220   --  Inherited nodes replaced by this node in a specialization of the
221   --  activity.
222
223   overriding function Get_Is_Leaf
224    (Self : not null access constant UML_Clear_Variable_Action_Proxy)
225       return Boolean;
226   --  Getter of RedefinableElement::isLeaf.
227   --
228   --  Indicates whether it is possible to further redefine a
229   --  RedefinableElement. If the value is true, then it is not possible to
230   --  further redefine the RedefinableElement. Note that this property is
231   --  preserved through package merge operations; that is, the capability to
232   --  redefine a RedefinableElement (i.e., isLeaf=false) must be preserved in
233   --  the resulting RedefinableElement of a package merge operation where a
234   --  RedefinableElement with isLeaf=false is merged with a matching
235   --  RedefinableElement with isLeaf=true: the resulting RedefinableElement
236   --  will have isLeaf=false. Default value is false.
237
238   overriding procedure Set_Is_Leaf
239    (Self : not null access UML_Clear_Variable_Action_Proxy;
240     To   : Boolean);
241   --  Setter of RedefinableElement::isLeaf.
242   --
243   --  Indicates whether it is possible to further redefine a
244   --  RedefinableElement. If the value is true, then it is not possible to
245   --  further redefine the RedefinableElement. Note that this property is
246   --  preserved through package merge operations; that is, the capability to
247   --  redefine a RedefinableElement (i.e., isLeaf=false) must be preserved in
248   --  the resulting RedefinableElement of a package merge operation where a
249   --  RedefinableElement with isLeaf=false is merged with a matching
250   --  RedefinableElement with isLeaf=true: the resulting RedefinableElement
251   --  will have isLeaf=false. Default value is false.
252
253   overriding function Get_Redefined_Element
254    (Self : not null access constant UML_Clear_Variable_Action_Proxy)
255       return AMF.UML.Redefinable_Elements.Collections.Set_Of_UML_Redefinable_Element;
256   --  Getter of RedefinableElement::redefinedElement.
257   --
258   --  The redefinable element that is being redefined by this element.
259
260   overriding function Get_Redefinition_Context
261    (Self : not null access constant UML_Clear_Variable_Action_Proxy)
262       return AMF.UML.Classifiers.Collections.Set_Of_UML_Classifier;
263   --  Getter of RedefinableElement::redefinitionContext.
264   --
265   --  References the contexts that this element may be redefined from.
266
267   overriding function Get_Client_Dependency
268    (Self : not null access constant UML_Clear_Variable_Action_Proxy)
269       return AMF.UML.Dependencies.Collections.Set_Of_UML_Dependency;
270   --  Getter of NamedElement::clientDependency.
271   --
272   --  Indicates the dependencies that reference the client.
273
274   overriding function Get_Name_Expression
275    (Self : not null access constant UML_Clear_Variable_Action_Proxy)
276       return AMF.UML.String_Expressions.UML_String_Expression_Access;
277   --  Getter of NamedElement::nameExpression.
278   --
279   --  The string expression used to define the name of this named element.
280
281   overriding procedure Set_Name_Expression
282    (Self : not null access UML_Clear_Variable_Action_Proxy;
283     To   : AMF.UML.String_Expressions.UML_String_Expression_Access);
284   --  Setter of NamedElement::nameExpression.
285   --
286   --  The string expression used to define the name of this named element.
287
288   overriding function Get_Namespace
289    (Self : not null access constant UML_Clear_Variable_Action_Proxy)
290       return AMF.UML.Namespaces.UML_Namespace_Access;
291   --  Getter of NamedElement::namespace.
292   --
293   --  Specifies the namespace that owns the NamedElement.
294
295   overriding function Get_Qualified_Name
296    (Self : not null access constant UML_Clear_Variable_Action_Proxy)
297       return AMF.Optional_String;
298   --  Getter of NamedElement::qualifiedName.
299   --
300   --  A name which allows the NamedElement to be identified within a
301   --  hierarchy of nested Namespaces. It is constructed from the names of the
302   --  containing namespaces starting at the root of the hierarchy and ending
303   --  with the name of the NamedElement itself.
304
305   overriding function Context
306    (Self : not null access constant UML_Clear_Variable_Action_Proxy)
307       return AMF.UML.Classifiers.UML_Classifier_Access;
308   --  Operation Action::context.
309   --
310   --  Missing derivation for Action::/context : Classifier
311
312   overriding function Is_Consistent_With
313    (Self : not null access constant UML_Clear_Variable_Action_Proxy;
314     Redefinee : AMF.UML.Redefinable_Elements.UML_Redefinable_Element_Access)
315       return Boolean;
316   --  Operation RedefinableElement::isConsistentWith.
317   --
318   --  The query isConsistentWith() specifies, for any two RedefinableElements
319   --  in a context in which redefinition is possible, whether redefinition
320   --  would be logically consistent. By default, this is false; this
321   --  operation must be overridden for subclasses of RedefinableElement to
322   --  define the consistency conditions.
323
324   overriding function Is_Redefinition_Context_Valid
325    (Self : not null access constant UML_Clear_Variable_Action_Proxy;
326     Redefined : AMF.UML.Redefinable_Elements.UML_Redefinable_Element_Access)
327       return Boolean;
328   --  Operation RedefinableElement::isRedefinitionContextValid.
329   --
330   --  The query isRedefinitionContextValid() specifies whether the
331   --  redefinition contexts of this RedefinableElement are properly related
332   --  to the redefinition contexts of the specified RedefinableElement to
333   --  allow this element to redefine the other. By default at least one of
334   --  the redefinition contexts of this element must be a specialization of
335   --  at least one of the redefinition contexts of the specified element.
336
337   overriding function All_Owning_Packages
338    (Self : not null access constant UML_Clear_Variable_Action_Proxy)
339       return AMF.UML.Packages.Collections.Set_Of_UML_Package;
340   --  Operation NamedElement::allOwningPackages.
341   --
342   --  The query allOwningPackages() returns all the directly or indirectly
343   --  owning packages.
344
345   overriding function Is_Distinguishable_From
346    (Self : not null access constant UML_Clear_Variable_Action_Proxy;
347     N : AMF.UML.Named_Elements.UML_Named_Element_Access;
348     Ns : AMF.UML.Namespaces.UML_Namespace_Access)
349       return Boolean;
350   --  Operation NamedElement::isDistinguishableFrom.
351   --
352   --  The query isDistinguishableFrom() determines whether two NamedElements
353   --  may logically co-exist within a Namespace. By default, two named
354   --  elements are distinguishable if (a) they have unrelated types or (b)
355   --  they have related types but different names.
356
357   overriding function Namespace
358    (Self : not null access constant UML_Clear_Variable_Action_Proxy)
359       return AMF.UML.Namespaces.UML_Namespace_Access;
360   --  Operation NamedElement::namespace.
361   --
362   --  Missing derivation for NamedElement::/namespace : Namespace
363
364   overriding procedure Enter_Element
365    (Self    : not null access constant UML_Clear_Variable_Action_Proxy;
366     Visitor : in out AMF.Visitors.Abstract_Visitor'Class;
367     Control : in out AMF.Visitors.Traverse_Control);
368   --  Dispatch call to corresponding subprogram of visitor interface.
369
370   overriding procedure Leave_Element
371    (Self    : not null access constant UML_Clear_Variable_Action_Proxy;
372     Visitor : in out AMF.Visitors.Abstract_Visitor'Class;
373     Control : in out AMF.Visitors.Traverse_Control);
374   --  Dispatch call to corresponding subprogram of visitor interface.
375
376   overriding procedure Visit_Element
377    (Self     : not null access constant UML_Clear_Variable_Action_Proxy;
378     Iterator : in out AMF.Visitors.Abstract_Iterator'Class;
379     Visitor  : in out AMF.Visitors.Abstract_Visitor'Class;
380     Control  : in out AMF.Visitors.Traverse_Control);
381   --  Dispatch call to corresponding subprogram of iterator interface.
382
383end AMF.Internals.UML_Clear_Variable_Actions;
384