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_Parameter_Nodes;
50with AMF.UML.Activity_Partitions.Collections;
51with AMF.UML.Behaviors;
52with AMF.UML.Classifiers.Collections;
53with AMF.UML.Dependencies.Collections;
54with AMF.UML.Interruptible_Activity_Regions.Collections;
55with AMF.UML.Named_Elements;
56with AMF.UML.Namespaces;
57with AMF.UML.Packages.Collections;
58with AMF.UML.Parameters;
59with AMF.UML.Redefinable_Elements.Collections;
60with AMF.UML.States.Collections;
61with AMF.UML.String_Expressions;
62with AMF.UML.Structured_Activity_Nodes;
63with AMF.UML.Types;
64with AMF.UML.Value_Specifications;
65with AMF.Visitors;
66
67package AMF.Internals.UML_Activity_Parameter_Nodes is
68
69   type UML_Activity_Parameter_Node_Proxy is
70     limited new AMF.Internals.UML_Named_Elements.UML_Named_Element_Proxy
71       and AMF.UML.Activity_Parameter_Nodes.UML_Activity_Parameter_Node with null record;
72
73   overriding function Get_Parameter
74    (Self : not null access constant UML_Activity_Parameter_Node_Proxy)
75       return AMF.UML.Parameters.UML_Parameter_Access;
76   --  Getter of ActivityParameterNode::parameter.
77   --
78   --  The parameter the object node will be accepting or providing values for.
79
80   overriding procedure Set_Parameter
81    (Self : not null access UML_Activity_Parameter_Node_Proxy;
82     To   : AMF.UML.Parameters.UML_Parameter_Access);
83   --  Setter of ActivityParameterNode::parameter.
84   --
85   --  The parameter the object node will be accepting or providing values for.
86
87   overriding function Get_In_State
88    (Self : not null access constant UML_Activity_Parameter_Node_Proxy)
89       return AMF.UML.States.Collections.Set_Of_UML_State;
90   --  Getter of ObjectNode::inState.
91   --
92   --  The required states of the object available at this point in the
93   --  activity.
94
95   overriding function Get_Is_Control_Type
96    (Self : not null access constant UML_Activity_Parameter_Node_Proxy)
97       return Boolean;
98   --  Getter of ObjectNode::isControlType.
99   --
100   --  Tells whether the type of the object node is to be treated as control.
101
102   overriding procedure Set_Is_Control_Type
103    (Self : not null access UML_Activity_Parameter_Node_Proxy;
104     To   : Boolean);
105   --  Setter of ObjectNode::isControlType.
106   --
107   --  Tells whether the type of the object node is to be treated as control.
108
109   overriding function Get_Ordering
110    (Self : not null access constant UML_Activity_Parameter_Node_Proxy)
111       return AMF.UML.UML_Object_Node_Ordering_Kind;
112   --  Getter of ObjectNode::ordering.
113   --
114   --  Tells whether and how the tokens in the object node are ordered for
115   --  selection to traverse edges outgoing from the object node.
116
117   overriding procedure Set_Ordering
118    (Self : not null access UML_Activity_Parameter_Node_Proxy;
119     To   : AMF.UML.UML_Object_Node_Ordering_Kind);
120   --  Setter of ObjectNode::ordering.
121   --
122   --  Tells whether and how the tokens in the object node are ordered for
123   --  selection to traverse edges outgoing from the object node.
124
125   overriding function Get_Selection
126    (Self : not null access constant UML_Activity_Parameter_Node_Proxy)
127       return AMF.UML.Behaviors.UML_Behavior_Access;
128   --  Getter of ObjectNode::selection.
129   --
130   --  Selects tokens for outgoing edges.
131
132   overriding procedure Set_Selection
133    (Self : not null access UML_Activity_Parameter_Node_Proxy;
134     To   : AMF.UML.Behaviors.UML_Behavior_Access);
135   --  Setter of ObjectNode::selection.
136   --
137   --  Selects tokens for outgoing edges.
138
139   overriding function Get_Upper_Bound
140    (Self : not null access constant UML_Activity_Parameter_Node_Proxy)
141       return AMF.UML.Value_Specifications.UML_Value_Specification_Access;
142   --  Getter of ObjectNode::upperBound.
143   --
144   --  The maximum number of tokens allowed in the node. Objects cannot flow
145   --  into the node if the upper bound is reached.
146
147   overriding procedure Set_Upper_Bound
148    (Self : not null access UML_Activity_Parameter_Node_Proxy;
149     To   : AMF.UML.Value_Specifications.UML_Value_Specification_Access);
150   --  Setter of ObjectNode::upperBound.
151   --
152   --  The maximum number of tokens allowed in the node. Objects cannot flow
153   --  into the node if the upper bound is reached.
154
155   overriding function Get_Activity
156    (Self : not null access constant UML_Activity_Parameter_Node_Proxy)
157       return AMF.UML.Activities.UML_Activity_Access;
158   --  Getter of ActivityNode::activity.
159   --
160   --  Activity containing the node.
161
162   overriding procedure Set_Activity
163    (Self : not null access UML_Activity_Parameter_Node_Proxy;
164     To   : AMF.UML.Activities.UML_Activity_Access);
165   --  Setter of ActivityNode::activity.
166   --
167   --  Activity containing the node.
168
169   overriding function Get_In_Group
170    (Self : not null access constant UML_Activity_Parameter_Node_Proxy)
171       return AMF.UML.Activity_Groups.Collections.Set_Of_UML_Activity_Group;
172   --  Getter of ActivityNode::inGroup.
173   --
174   --  Groups containing the node.
175
176   overriding function Get_In_Interruptible_Region
177    (Self : not null access constant UML_Activity_Parameter_Node_Proxy)
178       return AMF.UML.Interruptible_Activity_Regions.Collections.Set_Of_UML_Interruptible_Activity_Region;
179   --  Getter of ActivityNode::inInterruptibleRegion.
180   --
181   --  Interruptible regions containing the node.
182
183   overriding function Get_In_Partition
184    (Self : not null access constant UML_Activity_Parameter_Node_Proxy)
185       return AMF.UML.Activity_Partitions.Collections.Set_Of_UML_Activity_Partition;
186   --  Getter of ActivityNode::inPartition.
187   --
188   --  Partitions containing the node.
189
190   overriding function Get_In_Structured_Node
191    (Self : not null access constant UML_Activity_Parameter_Node_Proxy)
192       return AMF.UML.Structured_Activity_Nodes.UML_Structured_Activity_Node_Access;
193   --  Getter of ActivityNode::inStructuredNode.
194   --
195   --  Structured activity node containing the node.
196
197   overriding procedure Set_In_Structured_Node
198    (Self : not null access UML_Activity_Parameter_Node_Proxy;
199     To   : AMF.UML.Structured_Activity_Nodes.UML_Structured_Activity_Node_Access);
200   --  Setter of ActivityNode::inStructuredNode.
201   --
202   --  Structured activity node containing the node.
203
204   overriding function Get_Incoming
205    (Self : not null access constant UML_Activity_Parameter_Node_Proxy)
206       return AMF.UML.Activity_Edges.Collections.Set_Of_UML_Activity_Edge;
207   --  Getter of ActivityNode::incoming.
208   --
209   --  Edges that have the node as target.
210
211   overriding function Get_Outgoing
212    (Self : not null access constant UML_Activity_Parameter_Node_Proxy)
213       return AMF.UML.Activity_Edges.Collections.Set_Of_UML_Activity_Edge;
214   --  Getter of ActivityNode::outgoing.
215   --
216   --  Edges that have the node as source.
217
218   overriding function Get_Redefined_Node
219    (Self : not null access constant UML_Activity_Parameter_Node_Proxy)
220       return AMF.UML.Activity_Nodes.Collections.Set_Of_UML_Activity_Node;
221   --  Getter of ActivityNode::redefinedNode.
222   --
223   --  Inherited nodes replaced by this node in a specialization of the
224   --  activity.
225
226   overriding function Get_Is_Leaf
227    (Self : not null access constant UML_Activity_Parameter_Node_Proxy)
228       return Boolean;
229   --  Getter of RedefinableElement::isLeaf.
230   --
231   --  Indicates whether it is possible to further redefine a
232   --  RedefinableElement. If the value is true, then it is not possible to
233   --  further redefine the RedefinableElement. Note that this property is
234   --  preserved through package merge operations; that is, the capability to
235   --  redefine a RedefinableElement (i.e., isLeaf=false) must be preserved in
236   --  the resulting RedefinableElement of a package merge operation where a
237   --  RedefinableElement with isLeaf=false is merged with a matching
238   --  RedefinableElement with isLeaf=true: the resulting RedefinableElement
239   --  will have isLeaf=false. Default value is false.
240
241   overriding procedure Set_Is_Leaf
242    (Self : not null access UML_Activity_Parameter_Node_Proxy;
243     To   : Boolean);
244   --  Setter of RedefinableElement::isLeaf.
245   --
246   --  Indicates whether it is possible to further redefine a
247   --  RedefinableElement. If the value is true, then it is not possible to
248   --  further redefine the RedefinableElement. Note that this property is
249   --  preserved through package merge operations; that is, the capability to
250   --  redefine a RedefinableElement (i.e., isLeaf=false) must be preserved in
251   --  the resulting RedefinableElement of a package merge operation where a
252   --  RedefinableElement with isLeaf=false is merged with a matching
253   --  RedefinableElement with isLeaf=true: the resulting RedefinableElement
254   --  will have isLeaf=false. Default value is false.
255
256   overriding function Get_Redefined_Element
257    (Self : not null access constant UML_Activity_Parameter_Node_Proxy)
258       return AMF.UML.Redefinable_Elements.Collections.Set_Of_UML_Redefinable_Element;
259   --  Getter of RedefinableElement::redefinedElement.
260   --
261   --  The redefinable element that is being redefined by this element.
262
263   overriding function Get_Redefinition_Context
264    (Self : not null access constant UML_Activity_Parameter_Node_Proxy)
265       return AMF.UML.Classifiers.Collections.Set_Of_UML_Classifier;
266   --  Getter of RedefinableElement::redefinitionContext.
267   --
268   --  References the contexts that this element may be redefined from.
269
270   overriding function Get_Client_Dependency
271    (Self : not null access constant UML_Activity_Parameter_Node_Proxy)
272       return AMF.UML.Dependencies.Collections.Set_Of_UML_Dependency;
273   --  Getter of NamedElement::clientDependency.
274   --
275   --  Indicates the dependencies that reference the client.
276
277   overriding function Get_Name_Expression
278    (Self : not null access constant UML_Activity_Parameter_Node_Proxy)
279       return AMF.UML.String_Expressions.UML_String_Expression_Access;
280   --  Getter of NamedElement::nameExpression.
281   --
282   --  The string expression used to define the name of this named element.
283
284   overriding procedure Set_Name_Expression
285    (Self : not null access UML_Activity_Parameter_Node_Proxy;
286     To   : AMF.UML.String_Expressions.UML_String_Expression_Access);
287   --  Setter of NamedElement::nameExpression.
288   --
289   --  The string expression used to define the name of this named element.
290
291   overriding function Get_Namespace
292    (Self : not null access constant UML_Activity_Parameter_Node_Proxy)
293       return AMF.UML.Namespaces.UML_Namespace_Access;
294   --  Getter of NamedElement::namespace.
295   --
296   --  Specifies the namespace that owns the NamedElement.
297
298   overriding function Get_Qualified_Name
299    (Self : not null access constant UML_Activity_Parameter_Node_Proxy)
300       return AMF.Optional_String;
301   --  Getter of NamedElement::qualifiedName.
302   --
303   --  A name which allows the NamedElement to be identified within a
304   --  hierarchy of nested Namespaces. It is constructed from the names of the
305   --  containing namespaces starting at the root of the hierarchy and ending
306   --  with the name of the NamedElement itself.
307
308   overriding function Get_Type
309    (Self : not null access constant UML_Activity_Parameter_Node_Proxy)
310       return AMF.UML.Types.UML_Type_Access;
311   --  Getter of TypedElement::type.
312   --
313   --  The type of the TypedElement.
314   --  This information is derived from the return result for this Operation.
315
316   overriding procedure Set_Type
317    (Self : not null access UML_Activity_Parameter_Node_Proxy;
318     To   : AMF.UML.Types.UML_Type_Access);
319   --  Setter of TypedElement::type.
320   --
321   --  The type of the TypedElement.
322   --  This information is derived from the return result for this Operation.
323
324   overriding function Is_Consistent_With
325    (Self : not null access constant UML_Activity_Parameter_Node_Proxy;
326     Redefinee : AMF.UML.Redefinable_Elements.UML_Redefinable_Element_Access)
327       return Boolean;
328   --  Operation RedefinableElement::isConsistentWith.
329   --
330   --  The query isConsistentWith() specifies, for any two RedefinableElements
331   --  in a context in which redefinition is possible, whether redefinition
332   --  would be logically consistent. By default, this is false; this
333   --  operation must be overridden for subclasses of RedefinableElement to
334   --  define the consistency conditions.
335
336   overriding function Is_Redefinition_Context_Valid
337    (Self : not null access constant UML_Activity_Parameter_Node_Proxy;
338     Redefined : AMF.UML.Redefinable_Elements.UML_Redefinable_Element_Access)
339       return Boolean;
340   --  Operation RedefinableElement::isRedefinitionContextValid.
341   --
342   --  The query isRedefinitionContextValid() specifies whether the
343   --  redefinition contexts of this RedefinableElement are properly related
344   --  to the redefinition contexts of the specified RedefinableElement to
345   --  allow this element to redefine the other. By default at least one of
346   --  the redefinition contexts of this element must be a specialization of
347   --  at least one of the redefinition contexts of the specified element.
348
349   overriding function All_Owning_Packages
350    (Self : not null access constant UML_Activity_Parameter_Node_Proxy)
351       return AMF.UML.Packages.Collections.Set_Of_UML_Package;
352   --  Operation NamedElement::allOwningPackages.
353   --
354   --  The query allOwningPackages() returns all the directly or indirectly
355   --  owning packages.
356
357   overriding function Is_Distinguishable_From
358    (Self : not null access constant UML_Activity_Parameter_Node_Proxy;
359     N : AMF.UML.Named_Elements.UML_Named_Element_Access;
360     Ns : AMF.UML.Namespaces.UML_Namespace_Access)
361       return Boolean;
362   --  Operation NamedElement::isDistinguishableFrom.
363   --
364   --  The query isDistinguishableFrom() determines whether two NamedElements
365   --  may logically co-exist within a Namespace. By default, two named
366   --  elements are distinguishable if (a) they have unrelated types or (b)
367   --  they have related types but different names.
368
369   overriding function Namespace
370    (Self : not null access constant UML_Activity_Parameter_Node_Proxy)
371       return AMF.UML.Namespaces.UML_Namespace_Access;
372   --  Operation NamedElement::namespace.
373   --
374   --  Missing derivation for NamedElement::/namespace : Namespace
375
376   overriding procedure Enter_Element
377    (Self    : not null access constant UML_Activity_Parameter_Node_Proxy;
378     Visitor : in out AMF.Visitors.Abstract_Visitor'Class;
379     Control : in out AMF.Visitors.Traverse_Control);
380   --  Dispatch call to corresponding subprogram of visitor interface.
381
382   overriding procedure Leave_Element
383    (Self    : not null access constant UML_Activity_Parameter_Node_Proxy;
384     Visitor : in out AMF.Visitors.Abstract_Visitor'Class;
385     Control : in out AMF.Visitors.Traverse_Control);
386   --  Dispatch call to corresponding subprogram of visitor interface.
387
388   overriding procedure Visit_Element
389    (Self     : not null access constant UML_Activity_Parameter_Node_Proxy;
390     Iterator : in out AMF.Visitors.Abstract_Iterator'Class;
391     Visitor  : in out AMF.Visitors.Abstract_Visitor'Class;
392     Control  : in out AMF.Visitors.Traverse_Control);
393   --  Dispatch call to corresponding subprogram of iterator interface.
394
395end AMF.Internals.UML_Activity_Parameter_Nodes;
396