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.Connectors;
46with AMF.UML.Dependencies.Collections;
47with AMF.UML.Interactions;
48with AMF.UML.Message_Ends;
49with AMF.UML.Messages;
50with AMF.UML.Named_Elements;
51with AMF.UML.Namespaces;
52with AMF.UML.Packages.Collections;
53with AMF.UML.String_Expressions;
54with AMF.UML.Value_Specifications.Collections;
55with AMF.Visitors;
56
57package AMF.Internals.UML_Messages is
58
59   type UML_Message_Proxy is
60     limited new AMF.Internals.UML_Named_Elements.UML_Named_Element_Proxy
61       and AMF.UML.Messages.UML_Message with null record;
62
63   overriding function Get_Argument
64    (Self : not null access constant UML_Message_Proxy)
65       return AMF.UML.Value_Specifications.Collections.Ordered_Set_Of_UML_Value_Specification;
66   --  Getter of Message::argument.
67   --
68   --  The arguments of the Message
69
70   overriding function Get_Connector
71    (Self : not null access constant UML_Message_Proxy)
72       return AMF.UML.Connectors.UML_Connector_Access;
73   --  Getter of Message::connector.
74   --
75   --  The Connector on which this Message is sent.
76
77   overriding procedure Set_Connector
78    (Self : not null access UML_Message_Proxy;
79     To   : AMF.UML.Connectors.UML_Connector_Access);
80   --  Setter of Message::connector.
81   --
82   --  The Connector on which this Message is sent.
83
84   overriding function Get_Interaction
85    (Self : not null access constant UML_Message_Proxy)
86       return AMF.UML.Interactions.UML_Interaction_Access;
87   --  Getter of Message::interaction.
88   --
89   --  The enclosing Interaction owning the Message
90
91   overriding procedure Set_Interaction
92    (Self : not null access UML_Message_Proxy;
93     To   : AMF.UML.Interactions.UML_Interaction_Access);
94   --  Setter of Message::interaction.
95   --
96   --  The enclosing Interaction owning the Message
97
98   overriding function Get_Message_Kind
99    (Self : not null access constant UML_Message_Proxy)
100       return AMF.UML.UML_Message_Kind;
101   --  Getter of Message::messageKind.
102   --
103   --  The derived kind of the Message (complete, lost, found or unknown)
104
105   overriding function Get_Message_Sort
106    (Self : not null access constant UML_Message_Proxy)
107       return AMF.UML.UML_Message_Sort;
108   --  Getter of Message::messageSort.
109   --
110   --  The sort of communication reflected by the Message
111
112   overriding procedure Set_Message_Sort
113    (Self : not null access UML_Message_Proxy;
114     To   : AMF.UML.UML_Message_Sort);
115   --  Setter of Message::messageSort.
116   --
117   --  The sort of communication reflected by the Message
118
119   overriding function Get_Receive_Event
120    (Self : not null access constant UML_Message_Proxy)
121       return AMF.UML.Message_Ends.UML_Message_End_Access;
122   --  Getter of Message::receiveEvent.
123   --
124   --  References the Receiving of the Message
125
126   overriding procedure Set_Receive_Event
127    (Self : not null access UML_Message_Proxy;
128     To   : AMF.UML.Message_Ends.UML_Message_End_Access);
129   --  Setter of Message::receiveEvent.
130   --
131   --  References the Receiving of the Message
132
133   overriding function Get_Send_Event
134    (Self : not null access constant UML_Message_Proxy)
135       return AMF.UML.Message_Ends.UML_Message_End_Access;
136   --  Getter of Message::sendEvent.
137   --
138   --  References the Sending of the Message.
139
140   overriding procedure Set_Send_Event
141    (Self : not null access UML_Message_Proxy;
142     To   : AMF.UML.Message_Ends.UML_Message_End_Access);
143   --  Setter of Message::sendEvent.
144   --
145   --  References the Sending of the Message.
146
147   overriding function Get_Signature
148    (Self : not null access constant UML_Message_Proxy)
149       return AMF.UML.Named_Elements.UML_Named_Element_Access;
150   --  Getter of Message::signature.
151   --
152   --  The signature of the Message is the specification of its content. It
153   --  refers either an Operation or a Signal.
154
155   overriding procedure Set_Signature
156    (Self : not null access UML_Message_Proxy;
157     To   : AMF.UML.Named_Elements.UML_Named_Element_Access);
158   --  Setter of Message::signature.
159   --
160   --  The signature of the Message is the specification of its content. It
161   --  refers either an Operation or a Signal.
162
163   overriding function Get_Client_Dependency
164    (Self : not null access constant UML_Message_Proxy)
165       return AMF.UML.Dependencies.Collections.Set_Of_UML_Dependency;
166   --  Getter of NamedElement::clientDependency.
167   --
168   --  Indicates the dependencies that reference the client.
169
170   overriding function Get_Name_Expression
171    (Self : not null access constant UML_Message_Proxy)
172       return AMF.UML.String_Expressions.UML_String_Expression_Access;
173   --  Getter of NamedElement::nameExpression.
174   --
175   --  The string expression used to define the name of this named element.
176
177   overriding procedure Set_Name_Expression
178    (Self : not null access UML_Message_Proxy;
179     To   : AMF.UML.String_Expressions.UML_String_Expression_Access);
180   --  Setter of NamedElement::nameExpression.
181   --
182   --  The string expression used to define the name of this named element.
183
184   overriding function Get_Namespace
185    (Self : not null access constant UML_Message_Proxy)
186       return AMF.UML.Namespaces.UML_Namespace_Access;
187   --  Getter of NamedElement::namespace.
188   --
189   --  Specifies the namespace that owns the NamedElement.
190
191   overriding function Get_Qualified_Name
192    (Self : not null access constant UML_Message_Proxy)
193       return AMF.Optional_String;
194   --  Getter of NamedElement::qualifiedName.
195   --
196   --  A name which allows the NamedElement to be identified within a
197   --  hierarchy of nested Namespaces. It is constructed from the names of the
198   --  containing namespaces starting at the root of the hierarchy and ending
199   --  with the name of the NamedElement itself.
200
201   overriding function Message_Kind
202    (Self : not null access constant UML_Message_Proxy)
203       return AMF.UML.UML_Message_Kind;
204   --  Operation Message::messageKind.
205   --
206   --  Missing derivation for Message::/messageKind : MessageKind
207
208   overriding function All_Owning_Packages
209    (Self : not null access constant UML_Message_Proxy)
210       return AMF.UML.Packages.Collections.Set_Of_UML_Package;
211   --  Operation NamedElement::allOwningPackages.
212   --
213   --  The query allOwningPackages() returns all the directly or indirectly
214   --  owning packages.
215
216   overriding function Is_Distinguishable_From
217    (Self : not null access constant UML_Message_Proxy;
218     N : AMF.UML.Named_Elements.UML_Named_Element_Access;
219     Ns : AMF.UML.Namespaces.UML_Namespace_Access)
220       return Boolean;
221   --  Operation NamedElement::isDistinguishableFrom.
222   --
223   --  The query isDistinguishableFrom() determines whether two NamedElements
224   --  may logically co-exist within a Namespace. By default, two named
225   --  elements are distinguishable if (a) they have unrelated types or (b)
226   --  they have related types but different names.
227
228   overriding function Namespace
229    (Self : not null access constant UML_Message_Proxy)
230       return AMF.UML.Namespaces.UML_Namespace_Access;
231   --  Operation NamedElement::namespace.
232   --
233   --  Missing derivation for NamedElement::/namespace : Namespace
234
235   overriding procedure Enter_Element
236    (Self    : not null access constant UML_Message_Proxy;
237     Visitor : in out AMF.Visitors.Abstract_Visitor'Class;
238     Control : in out AMF.Visitors.Traverse_Control);
239   --  Dispatch call to corresponding subprogram of visitor interface.
240
241   overriding procedure Leave_Element
242    (Self    : not null access constant UML_Message_Proxy;
243     Visitor : in out AMF.Visitors.Abstract_Visitor'Class;
244     Control : in out AMF.Visitors.Traverse_Control);
245   --  Dispatch call to corresponding subprogram of visitor interface.
246
247   overriding procedure Visit_Element
248    (Self     : not null access constant UML_Message_Proxy;
249     Iterator : in out AMF.Visitors.Abstract_Iterator'Class;
250     Visitor  : in out AMF.Visitors.Abstract_Visitor'Class;
251     Control  : in out AMF.Visitors.Traverse_Control);
252   --  Dispatch call to corresponding subprogram of iterator interface.
253
254end AMF.Internals.UML_Messages;
255