blob: 897dec20eb11afbee42b62dbd744b612961b09e2 (
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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
/**
*/
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.fsm.fSM.DetailCode;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Data Class</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
* <br>Together with {@link ProtocolClass} and {@link ActorClass} one of
* the main class types of the ROOM language.
*
* <p>
* In ROOM this is the equivalent to a class in Java or C++.
* A data class can be derived from a base class (single
* inheritance), has {@link Attribute}s and {@link Operation}s.
* </p>
*
* <p>
* Additionally it can be annotated with generator specific
* meaning and user ocde can be added in several places
* (again generator specific).
* </p>
*
* <!-- end-model-doc -->
*
* <p>
* The following features are supported:
* </p>
* <ul>
* <li>{@link org.eclipse.etrice.core.room.DataClass#getBase <em>Base</em>}</li>
* <li>{@link org.eclipse.etrice.core.room.DataClass#getAnnotations <em>Annotations</em>}</li>
* <li>{@link org.eclipse.etrice.core.room.DataClass#getUserCode1 <em>User Code1</em>}</li>
* <li>{@link org.eclipse.etrice.core.room.DataClass#getUserCode2 <em>User Code2</em>}</li>
* <li>{@link org.eclipse.etrice.core.room.DataClass#getUserCode3 <em>User Code3</em>}</li>
* <li>{@link org.eclipse.etrice.core.room.DataClass#getOperations <em>Operations</em>}</li>
* <li>{@link org.eclipse.etrice.core.room.DataClass#getStructors <em>Structors</em>}</li>
* <li>{@link org.eclipse.etrice.core.room.DataClass#getAttributes <em>Attributes</em>}</li>
* </ul>
*
* @see org.eclipse.etrice.core.room.RoomPackage#getDataClass()
* @model
* @generated
*/
public interface DataClass extends ComplexType
{
/**
* Returns the value of the '<em><b>Base</b></em>' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* <br>The base class from which all attributes and operations are inherited.
*
* <!-- end-model-doc -->
* @return the value of the '<em>Base</em>' reference.
* @see #setBase(DataClass)
* @see org.eclipse.etrice.core.room.RoomPackage#getDataClass_Base()
* @model
* @generated
*/
DataClass getBase();
/**
* Sets the value of the '{@link org.eclipse.etrice.core.room.DataClass#getBase <em>Base</em>}' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Base</em>' reference.
* @see #getBase()
* @generated
*/
void setBase(DataClass 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 -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* <br>This is a list of data class annotations.
*
* <!-- end-model-doc -->
* @return the value of the '<em>Annotations</em>' containment reference list.
* @see org.eclipse.etrice.core.room.RoomPackage#getDataClass_Annotations()
* @model containment="true"
* @generated
*/
EList<Annotation> getAnnotations();
/**
* Returns the value of the '<em><b>User Code1</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* <br>The user code is treated in a generator dependent way.
*
* <!-- end-model-doc -->
* @return the value of the '<em>User Code1</em>' containment reference.
* @see #setUserCode1(DetailCode)
* @see org.eclipse.etrice.core.room.RoomPackage#getDataClass_UserCode1()
* @model containment="true"
* @generated
*/
DetailCode getUserCode1();
/**
* Sets the value of the '{@link org.eclipse.etrice.core.room.DataClass#getUserCode1 <em>User Code1</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>User Code1</em>' containment reference.
* @see #getUserCode1()
* @generated
*/
void setUserCode1(DetailCode value);
/**
* Returns the value of the '<em><b>User Code2</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* <br>The user code is treated in a generator dependent way.
*
* <!-- end-model-doc -->
* @return the value of the '<em>User Code2</em>' containment reference.
* @see #setUserCode2(DetailCode)
* @see org.eclipse.etrice.core.room.RoomPackage#getDataClass_UserCode2()
* @model containment="true"
* @generated
*/
DetailCode getUserCode2();
/**
* Sets the value of the '{@link org.eclipse.etrice.core.room.DataClass#getUserCode2 <em>User Code2</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>User Code2</em>' containment reference.
* @see #getUserCode2()
* @generated
*/
void setUserCode2(DetailCode value);
/**
* Returns the value of the '<em><b>User Code3</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* <br>The user code is treated in a generator dependent way.
*
* <!-- end-model-doc -->
* @return the value of the '<em>User Code3</em>' containment reference.
* @see #setUserCode3(DetailCode)
* @see org.eclipse.etrice.core.room.RoomPackage#getDataClass_UserCode3()
* @model containment="true"
* @generated
*/
DetailCode getUserCode3();
/**
* Sets the value of the '{@link org.eclipse.etrice.core.room.DataClass#getUserCode3 <em>User Code3</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>User Code3</em>' containment reference.
* @see #getUserCode3()
* @generated
*/
void setUserCode3(DetailCode value);
/**
* Returns the value of the '<em><b>Operations</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.etrice.core.room.StandardOperation}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* <br>Operations are the methods of the data class.
*
* <!-- end-model-doc -->
* @return the value of the '<em>Operations</em>' containment reference list.
* @see org.eclipse.etrice.core.room.RoomPackage#getDataClass_Operations()
* @model containment="true"
* @generated
*/
EList<StandardOperation> getOperations();
/**
* Returns the value of the '<em><b>Structors</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.etrice.core.room.ClassStructor}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Structors</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>Structors</em>' containment reference list.
* @see org.eclipse.etrice.core.room.RoomPackage#getDataClass_Structors()
* @model containment="true"
* @generated
*/
EList<ClassStructor> getStructors();
/**
* Returns the value of the '<em><b>Attributes</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.etrice.core.room.Attribute}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* <br>Attributes are the data members of the data class.
*
* <!-- end-model-doc -->
* @return the value of the '<em>Attributes</em>' containment reference list.
* @see org.eclipse.etrice.core.room.RoomPackage#getDataClass_Attributes()
* @model containment="true"
* @generated
*/
EList<Attribute> getAttributes();
} // DataClass
|
