Changes for page SCCharts Development

Last modified by Richard Kreissig on 2023/09/14 10:04
<
From version < 3.1 >
edited by ssm
on 2016/04/18 16:16
To version < 4.1 >
edited by ssm
on 2016/04/18 17:33
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -48,7 +48,7 @@
48 48  
49 49  = The SCCharts Metamodel =
50 50  
51 -Navigate to the models folder of the plugin de.cau.cs.kieler.sccharts. Here, open the sccharts.ecore and right-click on the sccharts.ecore file and select Visualize Ecore Model. Since you also installed EcoreViz from the OpenKieler Suite, you should now see a graphical representation of the SCCharts metamodel. Every SCChart will be a model describing the characteristics of this metamodel.
51 +Navigate to the models folder of the plugin {{code language="none"}}de.cau.cs.kieler.sccharts{{/code}}. Here, open the {{code language="none"}}sccharts.ecore{{/code}} and right-click on the {{code language="none"}}sccharts.ecore{{/code}} file and select //Visualize Ecore Model//. Since you also installed **EcoreViz** from the OpenKieler Suite, you should now see a graphical representation of the SCCharts metamodel. Every SCChart will be a model of this metamodel.
52 52  
53 53  IMAGE
54 54  
... ... @@ -62,4 +62,337 @@
62 62  11. The user now marks C as final. What has to be changed in the model? What semantic problem do you see?
63 63  1. (% style="line-height: 1.42857;" %)Now, navigate to the //Super State: Strong Abort Transition //example. Write down (on paper) what the model of that SCCharts looks like.
64 64  1. And finally a more sophisticated model: Write down the model of ABO (from [[doc:KIELER.Examples]]).
65 +
66 += Creating SCCharts Models Programmatically =
67 +
68 +== Creating a Test Project ==
69 +
70 +We need a project for testing. Do the following:
71 +
72 +1. Create a new empty //Plug-In Project//.
73 +1. Add the project that contains the sccharts metamodel as a dependency of your new project through the //Plugin Manifest Editor//.
74 +1. Create a simple Java class that implements a main method. Hint: In a new Java class, simply type main and hit Ctrl+Space. Eclipse content assist will create the method for you.
75 +
76 +== Creating a Model ==
77 +
78 +To create a model programmatically you cannot directly use the Java classes generated for the model. Instead, the main package contains interfaces for all of your model object classes. The {{code language="none"}}impl{{/code}} package contains the actual implementation and the {{code language="none"}}util{{/code}} package contains some helper classes. Do not instantiate objects directly by manually calling {{code language="none"}}new{{/code}}. EMF generates a Factory to create new objects. The factory itself uses the singleton pattern to get access to it:
79 +
80 +{{code language="java"}}
81 +SCChartsFactory sccFactory = SCChartsFactory.eINSTANCE;
82 +State state = sccFactory .createState();
83 +Transition transition = sccFactory .createTransition();
84 +{{/code}}
85 +
86 +Important: The SCCharts grammar is build on top of several other grammars. Therefore, not all language objects can be found in the SCCharts factory. For example, all expression elements are part of the KExpressions grammar and hence, have their own factory. If you need other factories, don't forget to add the corresponding plugin to your plugin dependency list.
87 +
88 +{{code language="java"}}
89 +KExpressionsFactory kFactory = KExpressionsFactory.eINSTANCE;
90 +BooleanValue boolValue = kFactory.createBooleanValue();
91 +{{/code}}
92 +
93 +For all simple attributes, there are getter and setter methods:
94 +
95 +{{code language="java"}}
96 +state.setId("Root");
97 +boolValue.setValue(true);
98 +{{/code}}
99 +
100 +Simple references (multiplicity of 1) also have getters and setters:
101 +
102 +{{code language="java"}}
103 +transition.setTrigger(boolValue);
104 +{{/code}}
105 +
106 +List references (multiplicity of > 1) have only a list getter, which is used to manipulate the list:
107 +
108 +{{code language="java"}}
109 +state.outgoingTransitions.add(transition);
110 +{{/code}}
111 +
112 +== Saving a Model ==
113 +
114 +EMF uses the [[Eclipse Resource concept>>url:http://help.eclipse.org/juno/topic/org.eclipse.platform.doc.isv/guide/resInt.htm?cp=2_0_10||rel="nofollow" shape="rect" class="external-link"]] to save models to files and load models from files. It can use different //Resource Factories// that determine how exactly models are serialized. We will use the [[XMIResourceFactoryImpl>>url:http://download.eclipse.org/modeling/emf/emf/javadoc/2.8.0/org/eclipse/emf/ecore/xmi/impl/XMIResourceFactoryImpl.html||rel="nofollow" shape="rect" class="external-link"]] to save our models to XML files:
115 +
116 +1. Add a dependency to the {{code language="none"}}org.eclipse.emf.ecore.xmi{{/code}} plug-in.
117 +1. (((
118 +Use something like the following code to save the model from above:
119 +
120 +{{code language="java"}}
121 +// Create a resource set.
122 +ResourceSet resourceSet = new ResourceSetImpl();
123 +
124 +// Register the default resource factory -- only needed for stand-alone!
125 +// this tells EMF to use XML to save the model
126 +resourceSet.getResourceFactoryRegistry().getExtensionToFactoryMap().put(
127 + Resource.Factory.Registry.DEFAULT_EXTENSION, new SCTResourceFactoryImpl());
128 +// Get the URI of the model file.
129 +URI fileURI = URI.createFileURI(new File("myABO.sct").getAbsolutePath());
130 +
131 +// Create a resource for this file.
132 +Resource resource = resourceSet.createResource(fileURI);
133 +
134 +// Add the model objects to the contents.
135 +resource.getContents().add(myModel);
136 +
137 +// Save the contents of the resource to the file system.
138 +try
139 +{
140 + resource.save(Collections.EMPTY_MAP); // the map can pass special saving options to the operation
141 +} catch (IOException e) {
142 + /* error handling */
143 +}
144 +{{/code}}
145 +)))
146 +
147 +==== Model Creation Task ====
148 +
149 +With these information out of the way, on we go to some model creation:
150 +
151 +1. Programmatically create a valid model of ABO in the {{code language="none"}}main(){{/code}} method.
152 +1. Run the {{code language="none"}}main(){{/code}} method by right-clicking its class and selecting //Run as// -> //Java Application//. Note that this runs your {{code language="none"}}main(){{/code}} method as a simple Java program, not a complete Eclipse application. EMF models can be used in any simple Java context, not just in Eclipse applications.
153 +1. Execute the main method.
154 +1. Inspect your SCT file.
155 +1. Start your SCChart Editor Eclipse instance and load your SCT file. KLighD should now be able to visualize your ABO correctly.
156 +
157 += Transforming SCCharts =
158 +
159 +Transformations from one model to another may be performed within the same metamodel or from metamodel to a different metamodel. Both methods are used in KIELER and in principle they do not really differ in implementation. Nevertheless, if working within the same metamodel you should keep in mind that you're potentially changing the actual model instead of changing another instance (after copying). Both is possible. Just make sure that you know what you're doing.
160 +
161 +Now, you're going to transform the normalized form of HandleA from ABO to an SCG. The Sequentially Constructive Graph is a control-flow graph which can be seen as another representation of the same program. The SCG of the normalized version of ABO's HandleA is depicted on the right.
162 +
163 +|(((
164 +{{code}}
165 +scchart ABO_norm_HandleA {
166 + input output bool A;
167 + input output bool B;
168 + output bool O1;
169 + output bool O2;
170 + region HandleA:
171 + initial state WaitA
172 + --> _S immediate with A
173 + --> _Pause immediate;
174 + final state DoneA;
175 + state _S
176 + --> _S2 immediate with / B = true;
177 + state _S2
178 + --> DoneA immediate with / O1 = true;
179 + state _Pause
180 + --> _Depth;
181 + state _Depth
182 + --> _S immediate with A
183 + --> _Pause immediate;
184 +}
185 +{{/code}}
186 +)))|(((
187 +[[image:attach:abo_norm_HandleA.png]]
188 +)))|(% colspan="1" %)(% colspan="1" %)
189 +(((
190 +[[image:attach:abo_scg_HandleA.png]]
191 +)))
192 +
193 +The next figure depicts the direct mapping from normalized SCCharts to their corresponding SCG.
194 +
195 +[[image:attach:sccharts-scg.png]]
196 +
197 +Inspect the metamodel of the SCGs in plugin de.cau.cs.kieler.scg. SCGs are used for analyses and optimization and include a lot of additional elements. However, for this tutorial it should be sufficient to look at the SCGraph class, its nodes attribute, the important node classes and the controlflow class. Important nodes for this SCG are entry, exit, assignment, conditional,
198 +
199 +==== Transformation Task ====
200 +
201 +Write a transformation that transforms your normalized version of ABO's HandleA into its corresponding SCG.
202 +
203 +1. (((
204 +**Writing a Model Transformation**
205 +
206 +This time we want you to integrate your transformation into your SCCharts Editor instance. Therefore,...
207 +(% style="color: rgb(51,51,51);line-height: 1.66667;" %)\\
208 +
209 +1. Add a new package 
210 +
211 +{{code language="none"}}
212 +<project>.transformations
213 +{{/code}} to your project.
214 +1. Add an //Xtend Class// to the new package.
215 +1. If you notice that your new class is marked with an error marker because of a missing dependency of the new plug-in project to 
216 +
217 +{{code language="none"}}
218 +org.eclipse.xtext.xbase.lib, 
219 +{{/code}}you can hover over the error with your mouse and have Eclipse add all libraries required by Xtend to your project.
220 +1.
221 +
222 +Define an entry method for the transformation that takes an SCChart program instance as an argument and returns an SCG {{code language="none"}}Program{{/code}}. You can use the following (incomplete) method as a starting point:
223 +
224 +(((
225 +(% class="syntaxhighlighter sh-confluence nogutter java" %)
226 +(((
227 +
228 +
229 +|(((
230 +(% class="container" title="Hint: double-click to select code" %)
231 +(((
232 +(% class="line number1 index0 alt2" %)
233 +(((
234 +{{code language="none"}}
235 +/**
236 +{{/code}}
237 +)))
238 +
239 +(% class="line number2 index1 alt1" %)
240 +(((
241 +{{code language="none"}}
242 + 
243 +{{/code}}
244 +
245 +{{code language="none"}}
246 +* Transforms a given SCCharts program into an SCG.
247 +{{/code}}
248 +)))
249 +
250 +(% class="line number3 index2 alt2" %)
251 +(((
252 +{{code language="none"}}
253 + 
254 +{{/code}}
255 +
256 +{{code language="none"}}
257 +*
258 +{{/code}}
259 +)))
260 +
261 +(% class="line number4 index3 alt1" %)
262 +(((
263 +{{code language="none"}}
264 +*/
265 +{{/code}}
266 +)))
267 +
268 +(% class="line number8 index7 alt1" %)
269 +(((
270 +{{code language="none"}}
271 +def SCGraph transform(State rootState) {
272 +{{/code}}
273 +)))
274 +
275 +(% class="line number9 index8 alt2" %)
276 +(((
277 +{{code language="none"}}
278 +    
279 +{{/code}}
280 +
281 +{{code language="none"}}
282 +// Create the SCG
283 +{{/code}}
284 +)))
285 +
286 +(% class="line number10 index9 alt1" %)
287 +(((
288 +{{code language="none"}}
289 +    
290 +{{/code}}
291 +
292 +{{code language="none"}}
293 +val scg = SCGraphFactory::eINSTANCE.createSCGraph()
294 +{{/code}}
295 +)))
296 +
297 +(% class="line number11 index10 alt2" %)
298 +(((
299 +{{code language="none"}}
300 +  
301 +{{/code}}
302 +)))
303 +
304 +(% class="line number12 index11 alt1" %)
305 +(((
306 +{{code language="none"}}
307 +    
308 +{{/code}}
309 +
310 +{{code language="none"}}
311 +// TODO: Your transformation code
312 +{{/code}}
313 +)))
314 +
315 +(% class="line number13 index12 alt2" %)
316 +(((
317 +{{code language="none"}}
318 +  
319 +{{/code}}
320 +)))
321 +
322 +(% class="line number14 index13 alt1" %)
323 +(((
324 +{{code language="none"}}
325 +    
326 +{{/code}}
327 +
328 +{{code language="none"}}
329 +// Return the transformed program
330 +{{/code}}
331 +)))
332 +
333 +(% class="line number15 index14 alt2" %)
334 +(((
335 +{{code language="none"}}
336 +    scg
337 +{{/code}}
338 +)))
339 +
340 +(% class="line number16 index15 alt1" %)
341 +(((
342 +{{code language="none"}}
343 +}
344 +{{/code}}
345 +)))
346 +)))
347 +)))
348 +
349 +
350 +)))
351 +)))
352 +
353 +(((
354 +(% class="syntaxhighlighter nogutter java" %)
355 +(((
356 +There's a few points to note here:
357 +)))
358 +)))
359 +
65 65  \\
361 +
362 +1.
363 +1*. Lines in Xtend code don't have to and with a semicolon.
364 +1*. We have been explicit about the method's return type, but we could have easily omitted it, letting Xtend infer the return type.
365 +1*. The keyword 
366 +
367 +{{code language="none"}}
368 +val
369 +{{/code}} declares a constant, while 
370 +
371 +{{code language="none"}}
372 +var
373 +{{/code}} declares a variable. Try to make do with constants where possible.
374 +1*. The methods you call should be declared as 
375 +
376 +{{code language="none"}}
377 +def private
378 +{{/code}} since they are implementation details and shouldn't be called by other classes.
379 +1*. You may be tempted to add a few global variables that hold things like a global input variable or a pointer to the current state. While you could to that, 
380 +
381 +{{code language="none"}}
382 +def create 
383 +{{/code}}methods might offer a better alternative...
384 +\\
385 +1. Replace the TODO with an transformation code that takes an extended BF program and transforms it into an semantically equivalent BF program that only uses standard BF instructions. 
386 +HINT: Some of the extended BF commands can only be expressed by standard operations if you can write to other cells. Therefore you are allowed to perform side effects on the tape.
387 +1. Open the //Plug-In Manifest Editor// and switch to the Runtime tab. Add the package containing your transformation to the list of exported packages. (You may have to check the //Show non-Java packages// option in the //Exported Packages// dialog to see the package.)
388 +\\
389 +)))
390 +1. **Verify your generated SCG**. If you added your transformation correctly, the SCG should be displayed automatically as soon as selected. If your SCG looks like the SCG depicted earlier, then everything is fine.
391 +1. Check your SCG semantically. Is there anything you could improve/optimize? 
392 +11. Write a second transformation (just as before) and add it to the transformation chain right after the transformation you already added.
393 +11. Optimize the given SCG and compare the result with the previous one.
394 +11. Make sure that the two SCGs are still semantically identical.
395 +
396 +Congratulations! You finished the SCCharts Development Tutorial. Ask your supervisor for further instructions!
397 +
398 +
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -16810207
1 +16810255
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/TUT/pages/16810207/SCCharts Development
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/TUT/pages/16810255/SCCharts Development

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage