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_Packageable_Elements;
45with AMF.UML.Activity_Edges.Collections;
46with AMF.UML.Classifiers.Collections;
47with AMF.UML.Connectors.Collections;
48with AMF.UML.Dependencies.Collections;
49with AMF.UML.Elements.Collections;
50with AMF.UML.Information_Flows;
51with AMF.UML.Messages.Collections;
52with AMF.UML.Named_Elements.Collections;
53with AMF.UML.Namespaces;
54with AMF.UML.Packages.Collections;
55with AMF.UML.Parameterable_Elements;
56with AMF.UML.Relationships.Collections;
57with AMF.UML.String_Expressions;
58with AMF.UML.Template_Parameters;
59with AMF.Visitors;
60
61package AMF.Internals.UML_Information_Flows is
62
63   type UML_Information_Flow_Proxy is
64     limited new AMF.Internals.UML_Packageable_Elements.UML_Packageable_Element_Proxy
65       and AMF.UML.Information_Flows.UML_Information_Flow with null record;
66
67   overriding function Get_Conveyed
68    (Self : not null access constant UML_Information_Flow_Proxy)
69       return AMF.UML.Classifiers.Collections.Set_Of_UML_Classifier;
70   --  Getter of InformationFlow::conveyed.
71   --
72   --  Specifies the information items that may circulate on this information
73   --  flow.
74
75   overriding function Get_Information_Source
76    (Self : not null access constant UML_Information_Flow_Proxy)
77       return AMF.UML.Named_Elements.Collections.Set_Of_UML_Named_Element;
78   --  Getter of InformationFlow::informationSource.
79   --
80   --  Defines from which source the conveyed InformationItems are initiated.
81
82   overriding function Get_Information_Target
83    (Self : not null access constant UML_Information_Flow_Proxy)
84       return AMF.UML.Named_Elements.Collections.Set_Of_UML_Named_Element;
85   --  Getter of InformationFlow::informationTarget.
86   --
87   --  Defines to which target the conveyed InformationItems are directed.
88
89   overriding function Get_Realization
90    (Self : not null access constant UML_Information_Flow_Proxy)
91       return AMF.UML.Relationships.Collections.Set_Of_UML_Relationship;
92   --  Getter of InformationFlow::realization.
93   --
94   --  Determines which Relationship will realize the specified flow
95
96   overriding function Get_Realizing_Activity_Edge
97    (Self : not null access constant UML_Information_Flow_Proxy)
98       return AMF.UML.Activity_Edges.Collections.Set_Of_UML_Activity_Edge;
99   --  Getter of InformationFlow::realizingActivityEdge.
100   --
101   --  Determines which ActivityEdges will realize the specified flow.
102
103   overriding function Get_Realizing_Connector
104    (Self : not null access constant UML_Information_Flow_Proxy)
105       return AMF.UML.Connectors.Collections.Set_Of_UML_Connector;
106   --  Getter of InformationFlow::realizingConnector.
107   --
108   --  Determines which Connectors will realize the specified flow.
109
110   overriding function Get_Realizing_Message
111    (Self : not null access constant UML_Information_Flow_Proxy)
112       return AMF.UML.Messages.Collections.Set_Of_UML_Message;
113   --  Getter of InformationFlow::realizingMessage.
114   --
115   --  Determines which Messages will realize the specified flow.
116
117   overriding function Get_Source
118    (Self : not null access constant UML_Information_Flow_Proxy)
119       return AMF.UML.Elements.Collections.Set_Of_UML_Element;
120   --  Getter of DirectedRelationship::source.
121   --
122   --  Specifies the sources of the DirectedRelationship.
123
124   overriding function Get_Target
125    (Self : not null access constant UML_Information_Flow_Proxy)
126       return AMF.UML.Elements.Collections.Set_Of_UML_Element;
127   --  Getter of DirectedRelationship::target.
128   --
129   --  Specifies the targets of the DirectedRelationship.
130
131   overriding function Get_Related_Element
132    (Self : not null access constant UML_Information_Flow_Proxy)
133       return AMF.UML.Elements.Collections.Set_Of_UML_Element;
134   --  Getter of Relationship::relatedElement.
135   --
136   --  Specifies the elements related by the Relationship.
137
138   overriding function Get_Client_Dependency
139    (Self : not null access constant UML_Information_Flow_Proxy)
140       return AMF.UML.Dependencies.Collections.Set_Of_UML_Dependency;
141   --  Getter of NamedElement::clientDependency.
142   --
143   --  Indicates the dependencies that reference the client.
144
145   overriding function Get_Name_Expression
146    (Self : not null access constant UML_Information_Flow_Proxy)
147       return AMF.UML.String_Expressions.UML_String_Expression_Access;
148   --  Getter of NamedElement::nameExpression.
149   --
150   --  The string expression used to define the name of this named element.
151
152   overriding procedure Set_Name_Expression
153    (Self : not null access UML_Information_Flow_Proxy;
154     To   : AMF.UML.String_Expressions.UML_String_Expression_Access);
155   --  Setter of NamedElement::nameExpression.
156   --
157   --  The string expression used to define the name of this named element.
158
159   overriding function Get_Namespace
160    (Self : not null access constant UML_Information_Flow_Proxy)
161       return AMF.UML.Namespaces.UML_Namespace_Access;
162   --  Getter of NamedElement::namespace.
163   --
164   --  Specifies the namespace that owns the NamedElement.
165
166   overriding function Get_Qualified_Name
167    (Self : not null access constant UML_Information_Flow_Proxy)
168       return AMF.Optional_String;
169   --  Getter of NamedElement::qualifiedName.
170   --
171   --  A name which allows the NamedElement to be identified within a
172   --  hierarchy of nested Namespaces. It is constructed from the names of the
173   --  containing namespaces starting at the root of the hierarchy and ending
174   --  with the name of the NamedElement itself.
175
176   overriding function Get_Owning_Template_Parameter
177    (Self : not null access constant UML_Information_Flow_Proxy)
178       return AMF.UML.Template_Parameters.UML_Template_Parameter_Access;
179   --  Getter of ParameterableElement::owningTemplateParameter.
180   --
181   --  The formal template parameter that owns this element.
182
183   overriding procedure Set_Owning_Template_Parameter
184    (Self : not null access UML_Information_Flow_Proxy;
185     To   : AMF.UML.Template_Parameters.UML_Template_Parameter_Access);
186   --  Setter of ParameterableElement::owningTemplateParameter.
187   --
188   --  The formal template parameter that owns this element.
189
190   overriding function Get_Template_Parameter
191    (Self : not null access constant UML_Information_Flow_Proxy)
192       return AMF.UML.Template_Parameters.UML_Template_Parameter_Access;
193   --  Getter of ParameterableElement::templateParameter.
194   --
195   --  The template parameter that exposes this element as a formal parameter.
196
197   overriding procedure Set_Template_Parameter
198    (Self : not null access UML_Information_Flow_Proxy;
199     To   : AMF.UML.Template_Parameters.UML_Template_Parameter_Access);
200   --  Setter of ParameterableElement::templateParameter.
201   --
202   --  The template parameter that exposes this element as a formal parameter.
203
204   overriding function All_Owning_Packages
205    (Self : not null access constant UML_Information_Flow_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_Information_Flow_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_Information_Flow_Proxy)
226       return AMF.UML.Namespaces.UML_Namespace_Access;
227   --  Operation NamedElement::namespace.
228   --
229   --  Missing derivation for NamedElement::/namespace : Namespace
230
231   overriding function Is_Compatible_With
232    (Self : not null access constant UML_Information_Flow_Proxy;
233     P : AMF.UML.Parameterable_Elements.UML_Parameterable_Element_Access)
234       return Boolean;
235   --  Operation ParameterableElement::isCompatibleWith.
236   --
237   --  The query isCompatibleWith() determines if this parameterable element
238   --  is compatible with the specified parameterable element. By default
239   --  parameterable element P is compatible with parameterable element Q if
240   --  the kind of P is the same or a subtype as the kind of Q. Subclasses
241   --  should override this operation to specify different compatibility
242   --  constraints.
243
244   overriding function Is_Template_Parameter
245    (Self : not null access constant UML_Information_Flow_Proxy)
246       return Boolean;
247   --  Operation ParameterableElement::isTemplateParameter.
248   --
249   --  The query isTemplateParameter() determines if this parameterable
250   --  element is exposed as a formal template parameter.
251
252   overriding procedure Enter_Element
253    (Self    : not null access constant UML_Information_Flow_Proxy;
254     Visitor : in out AMF.Visitors.Abstract_Visitor'Class;
255     Control : in out AMF.Visitors.Traverse_Control);
256   --  Dispatch call to corresponding subprogram of visitor interface.
257
258   overriding procedure Leave_Element
259    (Self    : not null access constant UML_Information_Flow_Proxy;
260     Visitor : in out AMF.Visitors.Abstract_Visitor'Class;
261     Control : in out AMF.Visitors.Traverse_Control);
262   --  Dispatch call to corresponding subprogram of visitor interface.
263
264   overriding procedure Visit_Element
265    (Self     : not null access constant UML_Information_Flow_Proxy;
266     Iterator : in out AMF.Visitors.Abstract_Iterator'Class;
267     Visitor  : in out AMF.Visitors.Abstract_Visitor'Class;
268     Control  : in out AMF.Visitors.Traverse_Control);
269   --  Dispatch call to corresponding subprogram of iterator interface.
270
271end AMF.Internals.UML_Information_Flows;
272