blob: 70c230f2ff16193284365296c102d4fdb697ecb0 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
/**
*/
package org.eclipse.etrice.core.room;
import org.eclipse.emf.common.util.EList;
import org.eclipse.etrice.core.common.base.Annotation;
import org.eclipse.etrice.core.common.base.Documentation;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Port</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
* <br>A port defines a part of the interface of an {@link ActorClass} in a specific role.
* The port is associated with a {@link ProtocolClass}. If it is conjugated then the
* roles of incoming and outgoing messages of the protocol are inverted.
*
* <p>
* Ports can have a multiplicity. If it is greater one the port is called replicated.
* </p>
*
* <p>
* Whether a port is a relay port or not is a property that is derived from how it is
* referenced by its {@link ActorClass}:
* <ul>
* <li>ports contained in the actor structure are called <em>internal end ports</em></li>
* <li>ports contained in the actor interface and are also referenced by an {@link ExternalPort}
* are called <em>external end ports</em></li>
* <li>ports contained in the actor interface only are called <em>relay ports</em></li>
* </ul>
* Relay ports delegate to sub actors and end ports are connected to the actor's state machine.
* </p>
*
* @see org.eclipse.etrice.core.room.util.RoomHelpers#isRelay(Port) RoomHelpers.isRelay(Port)
* @see org.eclipse.etrice.core.room.util.RoomHelpers#isInternal(Port) RoomHelpers.isInternal(Port)
* @see org.eclipse.etrice.core.room.util.RoomHelpers#isExternal(Port) RoomHelpers.isExternal(Port)
*
* <!-- end-model-doc -->
*
* <p>
* The following features are supported:
* </p>
* <ul>
* <li>{@link org.eclipse.etrice.core.room.Port#isConjugated <em>Conjugated</em>}</li>
* <li>{@link org.eclipse.etrice.core.room.Port#getMultiplicity <em>Multiplicity</em>}</li>
* <li>{@link org.eclipse.etrice.core.room.Port#getProtocol <em>Protocol</em>}</li>
* <li>{@link org.eclipse.etrice.core.room.Port#getAnnotations <em>Annotations</em>}</li>
* <li>{@link org.eclipse.etrice.core.room.Port#getDocu <em>Docu</em>}</li>
* </ul>
*
* @see org.eclipse.etrice.core.room.RoomPackage#getPort()
* @model
* @generated
*/
public interface Port extends InterfaceItem
{
/**
* Returns the value of the '<em><b>Conjugated</b></em>' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* <br>If a port is conjugated then the roles of outgoing and incoming messages are interchanged.
*
* <!-- end-model-doc -->
* @return the value of the '<em>Conjugated</em>' attribute.
* @see #setConjugated(boolean)
* @see org.eclipse.etrice.core.room.RoomPackage#getPort_Conjugated()
* @model
* @generated
*/
boolean isConjugated();
/**
* Sets the value of the '{@link org.eclipse.etrice.core.room.Port#isConjugated <em>Conjugated</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Conjugated</em>' attribute.
* @see #isConjugated()
* @generated
*/
void setConjugated(boolean value);
/**
* Returns the value of the '<em><b>Multiplicity</b></em>' attribute.
* The default value is <code>"1"</code>.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* <br>Ports with multiplicity >1 are called relay ports. A multiplicity of {@code -1} means replicated
* port with arbitrary multiplicity.
*
* <!-- end-model-doc -->
* @return the value of the '<em>Multiplicity</em>' attribute.
* @see #setMultiplicity(int)
* @see org.eclipse.etrice.core.room.RoomPackage#getPort_Multiplicity()
* @model default="1"
* @generated
*/
int getMultiplicity();
/**
* Sets the value of the '{@link org.eclipse.etrice.core.room.Port#getMultiplicity <em>Multiplicity</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Multiplicity</em>' attribute.
* @see #getMultiplicity()
* @generated
*/
void setMultiplicity(int value);
/**
* Returns the value of the '<em><b>Protocol</b></em>' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* <br>This is the port's protocol class.
*
* <!-- end-model-doc -->
* @return the value of the '<em>Protocol</em>' reference.
* @see #setProtocol(GeneralProtocolClass)
* @see org.eclipse.etrice.core.room.RoomPackage#getPort_Protocol()
* @model
* @generated
*/
GeneralProtocolClass getProtocol();
/**
* Sets the value of the '{@link org.eclipse.etrice.core.room.Port#getProtocol <em>Protocol</em>}' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Protocol</em>' reference.
* @see #getProtocol()
* @generated
*/
void setProtocol(GeneralProtocolClass value);
/**
* Returns the value of the '<em><b>Annotations</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.etrice.core.common.base.Annotation}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Annotations</em>' containment reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Annotations</em>' containment reference list.
* @see org.eclipse.etrice.core.room.RoomPackage#getPort_Annotations()
* @model containment="true"
* @generated
*/
EList<Annotation> getAnnotations();
/**
* Returns the value of the '<em><b>Docu</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* <br>This is an optional documentation.
*
* <!-- end-model-doc -->
* @return the value of the '<em>Docu</em>' containment reference.
* @see #setDocu(Documentation)
* @see org.eclipse.etrice.core.room.RoomPackage#getPort_Docu()
* @model containment="true"
* @generated
*/
Documentation getDocu();
/**
* Sets the value of the '{@link org.eclipse.etrice.core.room.Port#getDocu <em>Docu</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Docu</em>' containment reference.
* @see #getDocu()
* @generated
*/
void setDocu(Documentation value);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @model kind="operation"
* annotation="http://www.eclipse.org/emf/2002/GenModel body='return multiplicity>1 || multiplicity==-1;'"
* @generated
*/
boolean isReplicated();
} // Port
|
