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.Dependencies.Collections;
46with AMF.UML.Gates.Collections;
47with AMF.UML.General_Orderings.Collections;
48with AMF.UML.Interaction_Operands;
49with AMF.UML.Interaction_Uses;
50with AMF.UML.Interactions;
51with AMF.UML.Lifelines.Collections;
52with AMF.UML.Named_Elements;
53with AMF.UML.Namespaces;
54with AMF.UML.Packages.Collections;
55with AMF.UML.Properties;
56with AMF.UML.String_Expressions;
57with AMF.UML.Value_Specifications.Collections;
58with AMF.Visitors;
59
60package AMF.Internals.UML_Interaction_Uses is
61
62   type UML_Interaction_Use_Proxy is
63     limited new AMF.Internals.UML_Named_Elements.UML_Named_Element_Proxy
64       and AMF.UML.Interaction_Uses.UML_Interaction_Use with null record;
65
66   overriding function Get_Actual_Gate
67    (Self : not null access constant UML_Interaction_Use_Proxy)
68       return AMF.UML.Gates.Collections.Set_Of_UML_Gate;
69   --  Getter of InteractionUse::actualGate.
70   --
71   --  The actual gates of the InteractionUse
72
73   overriding function Get_Argument
74    (Self : not null access constant UML_Interaction_Use_Proxy)
75       return AMF.UML.Value_Specifications.Collections.Ordered_Set_Of_UML_Value_Specification;
76   --  Getter of InteractionUse::argument.
77   --
78   --  The actual arguments of the Interaction
79
80   overriding function Get_Refers_To
81    (Self : not null access constant UML_Interaction_Use_Proxy)
82       return AMF.UML.Interactions.UML_Interaction_Access;
83   --  Getter of InteractionUse::refersTo.
84   --
85   --  Refers to the Interaction that defines its meaning
86
87   overriding procedure Set_Refers_To
88    (Self : not null access UML_Interaction_Use_Proxy;
89     To   : AMF.UML.Interactions.UML_Interaction_Access);
90   --  Setter of InteractionUse::refersTo.
91   --
92   --  Refers to the Interaction that defines its meaning
93
94   overriding function Get_Return_Value
95    (Self : not null access constant UML_Interaction_Use_Proxy)
96       return AMF.UML.Value_Specifications.UML_Value_Specification_Access;
97   --  Getter of InteractionUse::returnValue.
98   --
99   --  The value of the executed Interaction.
100
101   overriding procedure Set_Return_Value
102    (Self : not null access UML_Interaction_Use_Proxy;
103     To   : AMF.UML.Value_Specifications.UML_Value_Specification_Access);
104   --  Setter of InteractionUse::returnValue.
105   --
106   --  The value of the executed Interaction.
107
108   overriding function Get_Return_Value_Recipient
109    (Self : not null access constant UML_Interaction_Use_Proxy)
110       return AMF.UML.Properties.UML_Property_Access;
111   --  Getter of InteractionUse::returnValueRecipient.
112   --
113   --  The recipient of the return value.
114
115   overriding procedure Set_Return_Value_Recipient
116    (Self : not null access UML_Interaction_Use_Proxy;
117     To   : AMF.UML.Properties.UML_Property_Access);
118   --  Setter of InteractionUse::returnValueRecipient.
119   --
120   --  The recipient of the return value.
121
122   overriding function Get_Covered
123    (Self : not null access constant UML_Interaction_Use_Proxy)
124       return AMF.UML.Lifelines.Collections.Set_Of_UML_Lifeline;
125   --  Getter of InteractionFragment::covered.
126   --
127   --  References the Lifelines that the InteractionFragment involves.
128
129   overriding function Get_Enclosing_Interaction
130    (Self : not null access constant UML_Interaction_Use_Proxy)
131       return AMF.UML.Interactions.UML_Interaction_Access;
132   --  Getter of InteractionFragment::enclosingInteraction.
133   --
134   --  The Interaction enclosing this InteractionFragment.
135
136   overriding procedure Set_Enclosing_Interaction
137    (Self : not null access UML_Interaction_Use_Proxy;
138     To   : AMF.UML.Interactions.UML_Interaction_Access);
139   --  Setter of InteractionFragment::enclosingInteraction.
140   --
141   --  The Interaction enclosing this InteractionFragment.
142
143   overriding function Get_Enclosing_Operand
144    (Self : not null access constant UML_Interaction_Use_Proxy)
145       return AMF.UML.Interaction_Operands.UML_Interaction_Operand_Access;
146   --  Getter of InteractionFragment::enclosingOperand.
147   --
148   --  The operand enclosing this InteractionFragment (they may nest
149   --  recursively)
150
151   overriding procedure Set_Enclosing_Operand
152    (Self : not null access UML_Interaction_Use_Proxy;
153     To   : AMF.UML.Interaction_Operands.UML_Interaction_Operand_Access);
154   --  Setter of InteractionFragment::enclosingOperand.
155   --
156   --  The operand enclosing this InteractionFragment (they may nest
157   --  recursively)
158
159   overriding function Get_General_Ordering
160    (Self : not null access constant UML_Interaction_Use_Proxy)
161       return AMF.UML.General_Orderings.Collections.Set_Of_UML_General_Ordering;
162   --  Getter of InteractionFragment::generalOrdering.
163   --
164   --  The general ordering relationships contained in this fragment.
165
166   overriding function Get_Client_Dependency
167    (Self : not null access constant UML_Interaction_Use_Proxy)
168       return AMF.UML.Dependencies.Collections.Set_Of_UML_Dependency;
169   --  Getter of NamedElement::clientDependency.
170   --
171   --  Indicates the dependencies that reference the client.
172
173   overriding function Get_Name_Expression
174    (Self : not null access constant UML_Interaction_Use_Proxy)
175       return AMF.UML.String_Expressions.UML_String_Expression_Access;
176   --  Getter of NamedElement::nameExpression.
177   --
178   --  The string expression used to define the name of this named element.
179
180   overriding procedure Set_Name_Expression
181    (Self : not null access UML_Interaction_Use_Proxy;
182     To   : AMF.UML.String_Expressions.UML_String_Expression_Access);
183   --  Setter of NamedElement::nameExpression.
184   --
185   --  The string expression used to define the name of this named element.
186
187   overriding function Get_Namespace
188    (Self : not null access constant UML_Interaction_Use_Proxy)
189       return AMF.UML.Namespaces.UML_Namespace_Access;
190   --  Getter of NamedElement::namespace.
191   --
192   --  Specifies the namespace that owns the NamedElement.
193
194   overriding function Get_Qualified_Name
195    (Self : not null access constant UML_Interaction_Use_Proxy)
196       return AMF.Optional_String;
197   --  Getter of NamedElement::qualifiedName.
198   --
199   --  A name which allows the NamedElement to be identified within a
200   --  hierarchy of nested Namespaces. It is constructed from the names of the
201   --  containing namespaces starting at the root of the hierarchy and ending
202   --  with the name of the NamedElement itself.
203
204   overriding function All_Owning_Packages
205    (Self : not null access constant UML_Interaction_Use_Proxy)
206       return AMF.UML.Packages.Collections.Set_Of_UML_Package;
207   --  Operation NamedElement::allOwningPackages.
208   --
209   --  The query allOwningPackages() returns all the directly or indirectly
210   --  owning packages.
211
212   overriding function Is_Distinguishable_From
213    (Self : not null access constant UML_Interaction_Use_Proxy;
214     N : AMF.UML.Named_Elements.UML_Named_Element_Access;
215     Ns : AMF.UML.Namespaces.UML_Namespace_Access)
216       return Boolean;
217   --  Operation NamedElement::isDistinguishableFrom.
218   --
219   --  The query isDistinguishableFrom() determines whether two NamedElements
220   --  may logically co-exist within a Namespace. By default, two named
221   --  elements are distinguishable if (a) they have unrelated types or (b)
222   --  they have related types but different names.
223
224   overriding function Namespace
225    (Self : not null access constant UML_Interaction_Use_Proxy)
226       return AMF.UML.Namespaces.UML_Namespace_Access;
227   --  Operation NamedElement::namespace.
228   --
229   --  Missing derivation for NamedElement::/namespace : Namespace
230
231   overriding procedure Enter_Element
232    (Self    : not null access constant UML_Interaction_Use_Proxy;
233     Visitor : in out AMF.Visitors.Abstract_Visitor'Class;
234     Control : in out AMF.Visitors.Traverse_Control);
235   --  Dispatch call to corresponding subprogram of visitor interface.
236
237   overriding procedure Leave_Element
238    (Self    : not null access constant UML_Interaction_Use_Proxy;
239     Visitor : in out AMF.Visitors.Abstract_Visitor'Class;
240     Control : in out AMF.Visitors.Traverse_Control);
241   --  Dispatch call to corresponding subprogram of visitor interface.
242
243   overriding procedure Visit_Element
244    (Self     : not null access constant UML_Interaction_Use_Proxy;
245     Iterator : in out AMF.Visitors.Abstract_Iterator'Class;
246     Visitor  : in out AMF.Visitors.Abstract_Visitor'Class;
247     Control  : in out AMF.Visitors.Traverse_Control);
248   --  Dispatch call to corresponding subprogram of iterator interface.
249
250end AMF.Internals.UML_Interaction_Uses;
251