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.Constraints.Collections;
52with AMF.UML.Dependencies.Collections;
53with AMF.UML.Exception_Handlers.Collections;
54with AMF.UML.Input_Pins.Collections;
55with AMF.UML.Interruptible_Activity_Regions.Collections;
56with AMF.UML.Named_Elements;
57with AMF.UML.Namespaces;
58with AMF.UML.Output_Pins.Collections;
59with AMF.UML.Packages.Collections;
60with AMF.UML.Redefinable_Elements.Collections;
61with AMF.UML.Remove_Variable_Value_Actions;
62with AMF.UML.String_Expressions;
63with AMF.UML.Structured_Activity_Nodes;
64with AMF.UML.Variables;
65with AMF.Visitors;
66
67package AMF.Internals.UML_Remove_Variable_Value_Actions is
68
69   type UML_Remove_Variable_Value_Action_Proxy is
70     limited new AMF.Internals.UML_Named_Elements.UML_Named_Element_Proxy
71       and AMF.UML.Remove_Variable_Value_Actions.UML_Remove_Variable_Value_Action with null record;
72
73   overriding function Get_Is_Remove_Duplicates
74    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy)
75       return Boolean;
76   --  Getter of RemoveVariableValueAction::isRemoveDuplicates.
77   --
78   --  Specifies whether to remove duplicates of the value in nonunique
79   --  variables.
80
81   overriding procedure Set_Is_Remove_Duplicates
82    (Self : not null access UML_Remove_Variable_Value_Action_Proxy;
83     To   : Boolean);
84   --  Setter of RemoveVariableValueAction::isRemoveDuplicates.
85   --
86   --  Specifies whether to remove duplicates of the value in nonunique
87   --  variables.
88
89   overriding function Get_Remove_At
90    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy)
91       return AMF.UML.Input_Pins.UML_Input_Pin_Access;
92   --  Getter of RemoveVariableValueAction::removeAt.
93   --
94   --  Specifies the position of an existing value to remove in ordered
95   --  nonunique variables. The type of the pin is UnlimitedNatural, but the
96   --  value cannot be zero or unlimited.
97
98   overriding procedure Set_Remove_At
99    (Self : not null access UML_Remove_Variable_Value_Action_Proxy;
100     To   : AMF.UML.Input_Pins.UML_Input_Pin_Access);
101   --  Setter of RemoveVariableValueAction::removeAt.
102   --
103   --  Specifies the position of an existing value to remove in ordered
104   --  nonunique variables. The type of the pin is UnlimitedNatural, but the
105   --  value cannot be zero or unlimited.
106
107   overriding function Get_Value
108    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy)
109       return AMF.UML.Input_Pins.UML_Input_Pin_Access;
110   --  Getter of WriteVariableAction::value.
111   --
112   --  Value to be added or removed from the variable.
113
114   overriding procedure Set_Value
115    (Self : not null access UML_Remove_Variable_Value_Action_Proxy;
116     To   : AMF.UML.Input_Pins.UML_Input_Pin_Access);
117   --  Setter of WriteVariableAction::value.
118   --
119   --  Value to be added or removed from the variable.
120
121   overriding function Get_Variable
122    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy)
123       return AMF.UML.Variables.UML_Variable_Access;
124   --  Getter of VariableAction::variable.
125   --
126   --  Variable to be read.
127
128   overriding procedure Set_Variable
129    (Self : not null access UML_Remove_Variable_Value_Action_Proxy;
130     To   : AMF.UML.Variables.UML_Variable_Access);
131   --  Setter of VariableAction::variable.
132   --
133   --  Variable to be read.
134
135   overriding function Get_Context
136    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy)
137       return AMF.UML.Classifiers.UML_Classifier_Access;
138   --  Getter of Action::context.
139   --
140   --  The classifier that owns the behavior of which this action is a part.
141
142   overriding function Get_Input
143    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy)
144       return AMF.UML.Input_Pins.Collections.Ordered_Set_Of_UML_Input_Pin;
145   --  Getter of Action::input.
146   --
147   --  The ordered set of input pins connected to the Action. These are among
148   --  the total set of inputs.
149
150   overriding function Get_Is_Locally_Reentrant
151    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy)
152       return Boolean;
153   --  Getter of Action::isLocallyReentrant.
154   --
155   --  If true, the action can begin a new, concurrent execution, even if
156   --  there is already another execution of the action ongoing. If false, the
157   --  action cannot begin a new execution until any previous execution has
158   --  completed.
159
160   overriding procedure Set_Is_Locally_Reentrant
161    (Self : not null access UML_Remove_Variable_Value_Action_Proxy;
162     To   : Boolean);
163   --  Setter of Action::isLocallyReentrant.
164   --
165   --  If true, the action can begin a new, concurrent execution, even if
166   --  there is already another execution of the action ongoing. If false, the
167   --  action cannot begin a new execution until any previous execution has
168   --  completed.
169
170   overriding function Get_Local_Postcondition
171    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy)
172       return AMF.UML.Constraints.Collections.Set_Of_UML_Constraint;
173   --  Getter of Action::localPostcondition.
174   --
175   --  Constraint that must be satisfied when executed is completed.
176
177   overriding function Get_Local_Precondition
178    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy)
179       return AMF.UML.Constraints.Collections.Set_Of_UML_Constraint;
180   --  Getter of Action::localPrecondition.
181   --
182   --  Constraint that must be satisfied when execution is started.
183
184   overriding function Get_Output
185    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy)
186       return AMF.UML.Output_Pins.Collections.Ordered_Set_Of_UML_Output_Pin;
187   --  Getter of Action::output.
188   --
189   --  The ordered set of output pins connected to the Action. The action
190   --  places its results onto pins in this set.
191
192   overriding function Get_Handler
193    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy)
194       return AMF.UML.Exception_Handlers.Collections.Set_Of_UML_Exception_Handler;
195   --  Getter of ExecutableNode::handler.
196   --
197   --  A set of exception handlers that are examined if an uncaught exception
198   --  propagates to the outer level of the executable node.
199
200   overriding function Get_Activity
201    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy)
202       return AMF.UML.Activities.UML_Activity_Access;
203   --  Getter of ActivityNode::activity.
204   --
205   --  Activity containing the node.
206
207   overriding procedure Set_Activity
208    (Self : not null access UML_Remove_Variable_Value_Action_Proxy;
209     To   : AMF.UML.Activities.UML_Activity_Access);
210   --  Setter of ActivityNode::activity.
211   --
212   --  Activity containing the node.
213
214   overriding function Get_In_Group
215    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy)
216       return AMF.UML.Activity_Groups.Collections.Set_Of_UML_Activity_Group;
217   --  Getter of ActivityNode::inGroup.
218   --
219   --  Groups containing the node.
220
221   overriding function Get_In_Interruptible_Region
222    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy)
223       return AMF.UML.Interruptible_Activity_Regions.Collections.Set_Of_UML_Interruptible_Activity_Region;
224   --  Getter of ActivityNode::inInterruptibleRegion.
225   --
226   --  Interruptible regions containing the node.
227
228   overriding function Get_In_Partition
229    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy)
230       return AMF.UML.Activity_Partitions.Collections.Set_Of_UML_Activity_Partition;
231   --  Getter of ActivityNode::inPartition.
232   --
233   --  Partitions containing the node.
234
235   overriding function Get_In_Structured_Node
236    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy)
237       return AMF.UML.Structured_Activity_Nodes.UML_Structured_Activity_Node_Access;
238   --  Getter of ActivityNode::inStructuredNode.
239   --
240   --  Structured activity node containing the node.
241
242   overriding procedure Set_In_Structured_Node
243    (Self : not null access UML_Remove_Variable_Value_Action_Proxy;
244     To   : AMF.UML.Structured_Activity_Nodes.UML_Structured_Activity_Node_Access);
245   --  Setter of ActivityNode::inStructuredNode.
246   --
247   --  Structured activity node containing the node.
248
249   overriding function Get_Incoming
250    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy)
251       return AMF.UML.Activity_Edges.Collections.Set_Of_UML_Activity_Edge;
252   --  Getter of ActivityNode::incoming.
253   --
254   --  Edges that have the node as target.
255
256   overriding function Get_Outgoing
257    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy)
258       return AMF.UML.Activity_Edges.Collections.Set_Of_UML_Activity_Edge;
259   --  Getter of ActivityNode::outgoing.
260   --
261   --  Edges that have the node as source.
262
263   overriding function Get_Redefined_Node
264    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy)
265       return AMF.UML.Activity_Nodes.Collections.Set_Of_UML_Activity_Node;
266   --  Getter of ActivityNode::redefinedNode.
267   --
268   --  Inherited nodes replaced by this node in a specialization of the
269   --  activity.
270
271   overriding function Get_Is_Leaf
272    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy)
273       return Boolean;
274   --  Getter of RedefinableElement::isLeaf.
275   --
276   --  Indicates whether it is possible to further redefine a
277   --  RedefinableElement. If the value is true, then it is not possible to
278   --  further redefine the RedefinableElement. Note that this property is
279   --  preserved through package merge operations; that is, the capability to
280   --  redefine a RedefinableElement (i.e., isLeaf=false) must be preserved in
281   --  the resulting RedefinableElement of a package merge operation where a
282   --  RedefinableElement with isLeaf=false is merged with a matching
283   --  RedefinableElement with isLeaf=true: the resulting RedefinableElement
284   --  will have isLeaf=false. Default value is false.
285
286   overriding procedure Set_Is_Leaf
287    (Self : not null access UML_Remove_Variable_Value_Action_Proxy;
288     To   : Boolean);
289   --  Setter of RedefinableElement::isLeaf.
290   --
291   --  Indicates whether it is possible to further redefine a
292   --  RedefinableElement. If the value is true, then it is not possible to
293   --  further redefine the RedefinableElement. Note that this property is
294   --  preserved through package merge operations; that is, the capability to
295   --  redefine a RedefinableElement (i.e., isLeaf=false) must be preserved in
296   --  the resulting RedefinableElement of a package merge operation where a
297   --  RedefinableElement with isLeaf=false is merged with a matching
298   --  RedefinableElement with isLeaf=true: the resulting RedefinableElement
299   --  will have isLeaf=false. Default value is false.
300
301   overriding function Get_Redefined_Element
302    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy)
303       return AMF.UML.Redefinable_Elements.Collections.Set_Of_UML_Redefinable_Element;
304   --  Getter of RedefinableElement::redefinedElement.
305   --
306   --  The redefinable element that is being redefined by this element.
307
308   overriding function Get_Redefinition_Context
309    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy)
310       return AMF.UML.Classifiers.Collections.Set_Of_UML_Classifier;
311   --  Getter of RedefinableElement::redefinitionContext.
312   --
313   --  References the contexts that this element may be redefined from.
314
315   overriding function Get_Client_Dependency
316    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy)
317       return AMF.UML.Dependencies.Collections.Set_Of_UML_Dependency;
318   --  Getter of NamedElement::clientDependency.
319   --
320   --  Indicates the dependencies that reference the client.
321
322   overriding function Get_Name_Expression
323    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy)
324       return AMF.UML.String_Expressions.UML_String_Expression_Access;
325   --  Getter of NamedElement::nameExpression.
326   --
327   --  The string expression used to define the name of this named element.
328
329   overriding procedure Set_Name_Expression
330    (Self : not null access UML_Remove_Variable_Value_Action_Proxy;
331     To   : AMF.UML.String_Expressions.UML_String_Expression_Access);
332   --  Setter of NamedElement::nameExpression.
333   --
334   --  The string expression used to define the name of this named element.
335
336   overriding function Get_Namespace
337    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy)
338       return AMF.UML.Namespaces.UML_Namespace_Access;
339   --  Getter of NamedElement::namespace.
340   --
341   --  Specifies the namespace that owns the NamedElement.
342
343   overriding function Get_Qualified_Name
344    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy)
345       return AMF.Optional_String;
346   --  Getter of NamedElement::qualifiedName.
347   --
348   --  A name which allows the NamedElement to be identified within a
349   --  hierarchy of nested Namespaces. It is constructed from the names of the
350   --  containing namespaces starting at the root of the hierarchy and ending
351   --  with the name of the NamedElement itself.
352
353   overriding function Context
354    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy)
355       return AMF.UML.Classifiers.UML_Classifier_Access;
356   --  Operation Action::context.
357   --
358   --  Missing derivation for Action::/context : Classifier
359
360   overriding function Is_Consistent_With
361    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy;
362     Redefinee : AMF.UML.Redefinable_Elements.UML_Redefinable_Element_Access)
363       return Boolean;
364   --  Operation RedefinableElement::isConsistentWith.
365   --
366   --  The query isConsistentWith() specifies, for any two RedefinableElements
367   --  in a context in which redefinition is possible, whether redefinition
368   --  would be logically consistent. By default, this is false; this
369   --  operation must be overridden for subclasses of RedefinableElement to
370   --  define the consistency conditions.
371
372   overriding function Is_Redefinition_Context_Valid
373    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy;
374     Redefined : AMF.UML.Redefinable_Elements.UML_Redefinable_Element_Access)
375       return Boolean;
376   --  Operation RedefinableElement::isRedefinitionContextValid.
377   --
378   --  The query isRedefinitionContextValid() specifies whether the
379   --  redefinition contexts of this RedefinableElement are properly related
380   --  to the redefinition contexts of the specified RedefinableElement to
381   --  allow this element to redefine the other. By default at least one of
382   --  the redefinition contexts of this element must be a specialization of
383   --  at least one of the redefinition contexts of the specified element.
384
385   overriding function All_Owning_Packages
386    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy)
387       return AMF.UML.Packages.Collections.Set_Of_UML_Package;
388   --  Operation NamedElement::allOwningPackages.
389   --
390   --  The query allOwningPackages() returns all the directly or indirectly
391   --  owning packages.
392
393   overriding function Is_Distinguishable_From
394    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy;
395     N : AMF.UML.Named_Elements.UML_Named_Element_Access;
396     Ns : AMF.UML.Namespaces.UML_Namespace_Access)
397       return Boolean;
398   --  Operation NamedElement::isDistinguishableFrom.
399   --
400   --  The query isDistinguishableFrom() determines whether two NamedElements
401   --  may logically co-exist within a Namespace. By default, two named
402   --  elements are distinguishable if (a) they have unrelated types or (b)
403   --  they have related types but different names.
404
405   overriding function Namespace
406    (Self : not null access constant UML_Remove_Variable_Value_Action_Proxy)
407       return AMF.UML.Namespaces.UML_Namespace_Access;
408   --  Operation NamedElement::namespace.
409   --
410   --  Missing derivation for NamedElement::/namespace : Namespace
411
412   overriding procedure Enter_Element
413    (Self    : not null access constant UML_Remove_Variable_Value_Action_Proxy;
414     Visitor : in out AMF.Visitors.Abstract_Visitor'Class;
415     Control : in out AMF.Visitors.Traverse_Control);
416   --  Dispatch call to corresponding subprogram of visitor interface.
417
418   overriding procedure Leave_Element
419    (Self    : not null access constant UML_Remove_Variable_Value_Action_Proxy;
420     Visitor : in out AMF.Visitors.Abstract_Visitor'Class;
421     Control : in out AMF.Visitors.Traverse_Control);
422   --  Dispatch call to corresponding subprogram of visitor interface.
423
424   overriding procedure Visit_Element
425    (Self     : not null access constant UML_Remove_Variable_Value_Action_Proxy;
426     Iterator : in out AMF.Visitors.Abstract_Iterator'Class;
427     Visitor  : in out AMF.Visitors.Abstract_Visitor'Class;
428     Control  : in out AMF.Visitors.Traverse_Control);
429   --  Dispatch call to corresponding subprogram of iterator interface.
430
431end AMF.Internals.UML_Remove_Variable_Value_Actions;
432