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.Named_Elements;
47with AMF.UML.Namespaces;
48with AMF.UML.Packages.Collections;
49with AMF.UML.Pseudostates;
50with AMF.UML.Regions;
51with AMF.UML.State_Machines;
52with AMF.UML.States;
53with AMF.UML.String_Expressions;
54with AMF.UML.Transitions.Collections;
55with AMF.Visitors;
56
57package AMF.Internals.UML_Pseudostates is
58
59   type UML_Pseudostate_Proxy is
60     limited new AMF.Internals.UML_Named_Elements.UML_Named_Element_Proxy
61       and AMF.UML.Pseudostates.UML_Pseudostate with null record;
62
63   overriding function Get_Kind
64    (Self : not null access constant UML_Pseudostate_Proxy)
65       return AMF.UML.UML_Pseudostate_Kind;
66   --  Getter of Pseudostate::kind.
67   --
68   --  Determines the precise type of the Pseudostate and can be one of:
69   --  entryPoint, exitPoint, initial, deepHistory, shallowHistory, join,
70   --  fork, junction, terminate or choice.
71
72   overriding procedure Set_Kind
73    (Self : not null access UML_Pseudostate_Proxy;
74     To   : AMF.UML.UML_Pseudostate_Kind);
75   --  Setter of Pseudostate::kind.
76   --
77   --  Determines the precise type of the Pseudostate and can be one of:
78   --  entryPoint, exitPoint, initial, deepHistory, shallowHistory, join,
79   --  fork, junction, terminate or choice.
80
81   overriding function Get_State
82    (Self : not null access constant UML_Pseudostate_Proxy)
83       return AMF.UML.States.UML_State_Access;
84   --  Getter of Pseudostate::state.
85   --
86   --  The State that owns this pseudostate and in which it appears.
87
88   overriding procedure Set_State
89    (Self : not null access UML_Pseudostate_Proxy;
90     To   : AMF.UML.States.UML_State_Access);
91   --  Setter of Pseudostate::state.
92   --
93   --  The State that owns this pseudostate and in which it appears.
94
95   overriding function Get_State_Machine
96    (Self : not null access constant UML_Pseudostate_Proxy)
97       return AMF.UML.State_Machines.UML_State_Machine_Access;
98   --  Getter of Pseudostate::stateMachine.
99   --
100   --  The StateMachine in which this Pseudostate is defined. This only
101   --  applies to Pseudostates of the kind entryPoint or exitPoint.
102
103   overriding procedure Set_State_Machine
104    (Self : not null access UML_Pseudostate_Proxy;
105     To   : AMF.UML.State_Machines.UML_State_Machine_Access);
106   --  Setter of Pseudostate::stateMachine.
107   --
108   --  The StateMachine in which this Pseudostate is defined. This only
109   --  applies to Pseudostates of the kind entryPoint or exitPoint.
110
111   overriding function Get_Container
112    (Self : not null access constant UML_Pseudostate_Proxy)
113       return AMF.UML.Regions.UML_Region_Access;
114   --  Getter of Vertex::container.
115   --
116   --  The region that contains this vertex.
117
118   overriding procedure Set_Container
119    (Self : not null access UML_Pseudostate_Proxy;
120     To   : AMF.UML.Regions.UML_Region_Access);
121   --  Setter of Vertex::container.
122   --
123   --  The region that contains this vertex.
124
125   overriding function Get_Incoming
126    (Self : not null access constant UML_Pseudostate_Proxy)
127       return AMF.UML.Transitions.Collections.Set_Of_UML_Transition;
128   --  Getter of Vertex::incoming.
129   --
130   --  Specifies the transitions entering this vertex.
131
132   overriding function Get_Outgoing
133    (Self : not null access constant UML_Pseudostate_Proxy)
134       return AMF.UML.Transitions.Collections.Set_Of_UML_Transition;
135   --  Getter of Vertex::outgoing.
136   --
137   --  Specifies the transitions departing from this vertex.
138
139   overriding function Get_Client_Dependency
140    (Self : not null access constant UML_Pseudostate_Proxy)
141       return AMF.UML.Dependencies.Collections.Set_Of_UML_Dependency;
142   --  Getter of NamedElement::clientDependency.
143   --
144   --  Indicates the dependencies that reference the client.
145
146   overriding function Get_Name_Expression
147    (Self : not null access constant UML_Pseudostate_Proxy)
148       return AMF.UML.String_Expressions.UML_String_Expression_Access;
149   --  Getter of NamedElement::nameExpression.
150   --
151   --  The string expression used to define the name of this named element.
152
153   overriding procedure Set_Name_Expression
154    (Self : not null access UML_Pseudostate_Proxy;
155     To   : AMF.UML.String_Expressions.UML_String_Expression_Access);
156   --  Setter of NamedElement::nameExpression.
157   --
158   --  The string expression used to define the name of this named element.
159
160   overriding function Get_Namespace
161    (Self : not null access constant UML_Pseudostate_Proxy)
162       return AMF.UML.Namespaces.UML_Namespace_Access;
163   --  Getter of NamedElement::namespace.
164   --
165   --  Specifies the namespace that owns the NamedElement.
166
167   overriding function Get_Qualified_Name
168    (Self : not null access constant UML_Pseudostate_Proxy)
169       return AMF.Optional_String;
170   --  Getter of NamedElement::qualifiedName.
171   --
172   --  A name which allows the NamedElement to be identified within a
173   --  hierarchy of nested Namespaces. It is constructed from the names of the
174   --  containing namespaces starting at the root of the hierarchy and ending
175   --  with the name of the NamedElement itself.
176
177   overriding function Containing_State_Machine
178    (Self : not null access constant UML_Pseudostate_Proxy)
179       return AMF.UML.State_Machines.UML_State_Machine_Access;
180   --  Operation Vertex::containingStateMachine.
181   --
182   --  The operation containingStateMachine() returns the state machine in
183   --  which this Vertex is defined
184
185   overriding function Incoming
186    (Self : not null access constant UML_Pseudostate_Proxy)
187       return AMF.UML.Transitions.Collections.Set_Of_UML_Transition;
188   --  Operation Vertex::incoming.
189   --
190   --  Missing derivation for Vertex::/incoming : Transition
191
192   overriding function Outgoing
193    (Self : not null access constant UML_Pseudostate_Proxy)
194       return AMF.UML.Transitions.Collections.Set_Of_UML_Transition;
195   --  Operation Vertex::outgoing.
196   --
197   --  Missing derivation for Vertex::/outgoing : Transition
198
199   overriding function All_Owning_Packages
200    (Self : not null access constant UML_Pseudostate_Proxy)
201       return AMF.UML.Packages.Collections.Set_Of_UML_Package;
202   --  Operation NamedElement::allOwningPackages.
203   --
204   --  The query allOwningPackages() returns all the directly or indirectly
205   --  owning packages.
206
207   overriding function Is_Distinguishable_From
208    (Self : not null access constant UML_Pseudostate_Proxy;
209     N : AMF.UML.Named_Elements.UML_Named_Element_Access;
210     Ns : AMF.UML.Namespaces.UML_Namespace_Access)
211       return Boolean;
212   --  Operation NamedElement::isDistinguishableFrom.
213   --
214   --  The query isDistinguishableFrom() determines whether two NamedElements
215   --  may logically co-exist within a Namespace. By default, two named
216   --  elements are distinguishable if (a) they have unrelated types or (b)
217   --  they have related types but different names.
218
219   overriding function Namespace
220    (Self : not null access constant UML_Pseudostate_Proxy)
221       return AMF.UML.Namespaces.UML_Namespace_Access;
222   --  Operation NamedElement::namespace.
223   --
224   --  Missing derivation for NamedElement::/namespace : Namespace
225
226   overriding procedure Enter_Element
227    (Self    : not null access constant UML_Pseudostate_Proxy;
228     Visitor : in out AMF.Visitors.Abstract_Visitor'Class;
229     Control : in out AMF.Visitors.Traverse_Control);
230   --  Dispatch call to corresponding subprogram of visitor interface.
231
232   overriding procedure Leave_Element
233    (Self    : not null access constant UML_Pseudostate_Proxy;
234     Visitor : in out AMF.Visitors.Abstract_Visitor'Class;
235     Control : in out AMF.Visitors.Traverse_Control);
236   --  Dispatch call to corresponding subprogram of visitor interface.
237
238   overriding procedure Visit_Element
239    (Self     : not null access constant UML_Pseudostate_Proxy;
240     Iterator : in out AMF.Visitors.Abstract_Iterator'Class;
241     Visitor  : in out AMF.Visitors.Abstract_Visitor'Class;
242     Control  : in out AMF.Visitors.Traverse_Control);
243   --  Dispatch call to corresponding subprogram of iterator interface.
244
245end AMF.Internals.UML_Pseudostates;
246