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