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