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