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