blob: e0ada609173b199dc90692880faddc04c78d1663 (
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
|
/**
*/
package org.eclipse.etrice.core.room;
import org.eclipse.emf.common.util.EList;
import org.eclipse.emf.ecore.EObject;
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>Message</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
* <br>This is a concrete sub class of an {@link AbstractMessage}.
* A message in ROOM is part of a {@link ProtocolClass}. Messages are exchanged via {@link Port}s.
* For event driven protocols the message is an object that is deliverd using a message
* service of the runtime. For data driven systems only messages holding data are valid. In this
* case the conjugate port is the one holding (and writing) the data and the regular port is
* reading the data.
*
* <!-- end-model-doc -->
*
* <p>
* The following features are supported:
* </p>
* <ul>
* <li>{@link org.eclipse.etrice.core.room.Message#isPriv <em>Priv</em>}</li>
* <li>{@link org.eclipse.etrice.core.room.Message#getName <em>Name</em>}</li>
* <li>{@link org.eclipse.etrice.core.room.Message#getData <em>Data</em>}</li>
* <li>{@link org.eclipse.etrice.core.room.Message#getAnnotations <em>Annotations</em>}</li>
* <li>{@link org.eclipse.etrice.core.room.Message#getDocu <em>Docu</em>}</li>
* </ul>
*
* @see org.eclipse.etrice.core.room.RoomPackage#getMessage()
* @model
* @generated
*/
public interface Message extends EObject
{
/**
* Returns the value of the '<em><b>Priv</b></em>' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* <br>If this flag is {@code true} then the message is treated as private for this protocol
* and can only be sent by a PortClass.
*
* <!-- end-model-doc -->
* @return the value of the '<em>Priv</em>' attribute.
* @see #setPriv(boolean)
* @see org.eclipse.etrice.core.room.RoomPackage#getMessage_Priv()
* @model
* @generated
*/
boolean isPriv();
/**
* Sets the value of the '{@link org.eclipse.etrice.core.room.Message#isPriv <em>Priv</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Priv</em>' attribute.
* @see #isPriv()
* @generated
*/
void setPriv(boolean value);
/**
* Returns the value of the '<em><b>Name</b></em>' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* <br>By this name the message is referred to in the model.
*
* <!-- end-model-doc -->
* @return the value of the '<em>Name</em>' attribute.
* @see #setName(String)
* @see org.eclipse.etrice.core.room.RoomPackage#getMessage_Name()
* @model
* @generated
*/
String getName();
/**
* Sets the value of the '{@link org.eclipse.etrice.core.room.Message#getName <em>Name</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Name</em>' attribute.
* @see #getName()
* @generated
*/
void setName(String value);
/**
* Returns the value of the '<em><b>Data</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* <br>This is a reference to optional message data.
*
* <!-- end-model-doc -->
* @return the value of the '<em>Data</em>' containment reference.
* @see #setData(VarDecl)
* @see org.eclipse.etrice.core.room.RoomPackage#getMessage_Data()
* @model containment="true"
* @generated
*/
VarDecl getData();
/**
* Sets the value of the '{@link org.eclipse.etrice.core.room.Message#getData <em>Data</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Data</em>' containment reference.
* @see #getData()
* @generated
*/
void setData(VarDecl 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#getMessage_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#getMessage_Docu()
* @model containment="true"
* @generated
*/
Documentation getDocu();
/**
* Sets the value of the '{@link org.eclipse.etrice.core.room.Message#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);
} // Message
|
