Changes for page SCCharts Development

Last modified by Richard Kreissig on 2023/09/14 10:04

From version < 73.1 >

edited by Richard Kreissig
on 2023/09/14 09:16

To version < 69.2 >

edited by Alexander Schulz-Rosengarten
on 2023/07/11 10:37

Change comment: Update document after refactoring.

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Author

@@ -1,1 +1,1 @@
--XWiki.stu230980
++XWiki.als

Content

@@ -1,3 +1,6 @@
++{{layout}}
++{{layout-section ac:type="single"}}
++{{layout-cell}}
  This is a light-weight tutorial for developing transformations/additions for SCCharts in KIELER. It will use Eclipse, EMF, and Xtend and therefore, finishing the corresponding tutorials could prove useful. However, they are not a strict requirement for this tutorial.
  {{warning title="Outdated!"}}
@@ -4,6 +4,7 @@
  The KiCo part "Model-to-Model Transformations with KiCo" is outdated. We will update this tutorials in the near future.
  {{/warning}}
++\\
@@ -16,9 +16,13 @@
  == Required Software ==
  As you're going to develop for KIELER SCCharts, we recommend to use the Oomph setup as described in [[doc:KIELER.Getting Eclipse]] (Oomph Setup). However, you could also install all componentes by yourself. Please consult the other tutorials if you want to do that. You would need to install the Modeling Tools and the Xtext SDK.
++{{/layout-cell}}
++{{/layout-section}}
++{{layout-section ac:type="three_equal"}}
++{{layout-cell}}
++\\
--
  Additionally, install the** EcoreViz** from the **Ecore Model Visualization** category from the **OpenKieler** update site: [[http:~~/~~/rtsys.informatik.uni-kiel.de/~~~~kieler/updatesite/nightly-openkieler/>>url:http://rtsys.informatik.uni-kiel.de/~~kieler/updatesite/nightly-openkieler/||rel="nofollow" shape="rect"]]. For this, choose //Install New Software...// in the //Help// tab.
  Due to the ongoing migration you have to install a workaround for EcoreViz to function. You have to install the KLighD diagram view directly from [[http:~~/~~/rtsys.informatik.uni-kiel.de/~~~~kieler/updatesite/release_pragmatics_2016-02/>>url:http://rtsys.informatik.uni-kiel.de/~~kieler/updatesite/release_pragmatics_2016-02/||shape="rect"]]. Select the features
@@ -27,14 +27,25 @@
  * KIELER Lightweight Diagrams Generic Diagram View.
  (This step should be obsolete in the near future.)
++{{/layout-cell}}
++{{layout-cell}}
++\\
  [[image:attach:InstallEcoreViz.png]]
++\\
++{{/layout-cell}}
++{{layout-cell}}
++\\
  [[image:attach:InstallKLighDFeatures.png]]
++{{/layout-cell}}
++{{/layout-section}}
++{{layout-section ac:type="single"}}
++{{layout-cell}}
  == Recommended Tutorials ==
  We recommend that you have completed the following tutorials before diving into this one (or at least sweep over them). However, this is not a strict requirement.
@@ -51,7 +51,7 @@
  When developing within the KIELER semantics team, you will most likely be confronted with Xtext and [[doc:KIELER.Lightweight Diagrams (KLighD)]]. The following tutorials may be helpful but not required for this tutorial.
--1. [[doc:KIELER.Development.Tutorials.Xtext and Xtend.Xtext 2 - Creating a Grammar from Scratch.WebHome]]
++1. [[doc:KIELER.Tutorials.Xtext and Xtend.Xtext 2 - Creating a Grammar from Scratch.WebHome]]
 . [[doc:KIELER.Development.Tutorials.Diagrams and Layout.Lightweight Diagrams (KLighD).WebHome]]
  == Finding Documentation ==
@@ -62,16 +62,21 @@
  Additionally, the following list will give a short overview over the most important publications:
--* (% style="color:#000000" %)**Main paper:**(%%)
--(% style="color:#000000" %)Reinhard von Hanxleden and Björn Duderstadt and Christian Motika and Steven Smyth and Michael Mendler and Joaquín Aguado and Stephen Mercer and Owen O’Brien. SCCharts: Sequentially Constructive Statecharts for Safety-Critical Applications. In (% class="cmti-10" %)Proc. ACM SIGPLAN Conference on Programming Language Design(%%) (% class="cmti-10" %)and Implementation (PLDI’14)(%%), Edinburgh, UK, June 2014. ACM.  [[pdf>>url:http://rtsys.informatik.uni-kiel.de/~~biblio/downloads/papers/pldi14.pdf||shape="rect"]](% style="color:#000000" %), (%%)[[talk>>url:http://rtsys.informatik.uni-kiel.de/~~biblio/downloads/talks/pldi14-talk.pdf||shape="rect"]](% style="color:#000000" %), (%%)[[bib>>url:http://rtsys.informatik.uni-kiel.de/~~biblio/cgi-bin/bibcgi.cgi?key=vonHanxledenDM+14||shape="rect"]]
++* (% style="color: rgb(0,0,0);" %)**Main paper:**
++Reinhard von Hanxleden and Björn Duderstadt and Christian Motika and Steven Smyth and Michael Mendler and Joaquín Aguado and Stephen Mercer and Owen O’Brien. SCCharts: Sequentially Constructive Statecharts for Safety-Critical Applications. In (% class="cmti-10" %)Proc. ACM SIGPLAN Conference on Programming Language Design(%%) (% class="cmti-10" %)and Implementation (PLDI’14)(%%), Edinburgh, UK, June 2014. ACM.  [[pdf>>url:http://rtsys.informatik.uni-kiel.de/~~biblio/downloads/papers/pldi14.pdf||shape="rect"]](% style="color: rgb(0,0,0);" %), (%%)[[talk>>url:http://rtsys.informatik.uni-kiel.de/~~biblio/downloads/talks/pldi14-talk.pdf||shape="rect"]](% style="color: rgb(0,0,0);" %), (%%)[[bib>>url:http://rtsys.informatik.uni-kiel.de/~~biblio/cgi-bin/bibcgi.cgi?key=vonHanxledenDM+14||shape="rect"]]
  * **SLIC Compilation:**
--(% style="color:#000000" %)Christian Motika and Steven Smyth and Reinhard von Hanxleden. Compiling SCCharts—A Case-Study on Interactive Model-Based Compilation. In (% class="cmti-10" %)Proceedings of(%%) (% class="cmti-10" %)the 6th International Symposium on Leveraging Applications of Formal(%%) (% class="cmti-10" %)Methods, Verification and Validation (ISoLA 2014)(%%), volume 8802 of (% class="cmti-10" %)LNCS(%%), page 443–462, Corfu, Greece, October 2014.  The [[original publication>>url:http://dx.doi.org/10.1007/978-3-662-45234-9||shape="rect"]](% style="color:#000000" %) is available at (%%)[[http:~~/~~/link.springer.com>>url:http://link.springer.com/||shape="rect"]](% style="color:#000000" %). (%%)[[pdf>>url:http://rtsys.informatik.uni-kiel.de/~~biblio/downloads/papers/isola14.pdf||shape="rect"]](% style="color:#000000" %), (%%)[[bib>>url:http://rtsys.informatik.uni-kiel.de/~~biblio/cgi-bin/bibcgi.cgi?key=MotikaSvH14||shape="rect"]]
++(% style="color: rgb(0,0,0);" %)Christian Motika and Steven Smyth and Reinhard von Hanxleden. Compiling SCCharts—A Case-Study on Interactive Model-Based Compilation. In (% class="cmti-10" %)Proceedings of(%%) (% class="cmti-10" %)the 6th International Symposium on Leveraging Applications of Formal(%%) (% class="cmti-10" %)Methods, Verification and Validation (ISoLA 2014)(%%), volume 8802 of (% class="cmti-10" %)LNCS(%%), page 443–462, Corfu, Greece, October 2014.  The [[original publication>>url:http://dx.doi.org/10.1007/978-3-662-45234-9||shape="rect"]](% style="color: rgb(0,0,0);" %) is available at (%%)[[http:~~/~~/link.springer.com>>url:http://link.springer.com/||shape="rect"]](% style="color: rgb(0,0,0);" %). (%%)[[pdf>>url:http://rtsys.informatik.uni-kiel.de/~~biblio/downloads/papers/isola14.pdf||shape="rect"]](% style="color: rgb(0,0,0);" %), (%%)[[bib>>url:http://rtsys.informatik.uni-kiel.de/~~biblio/cgi-bin/bibcgi.cgi?key=MotikaSvH14||shape="rect"]]
  * **Theoretical Foundations:**
--(% style="color:#000000" %)Reinhard von Hanxleden and Michael Mendler and Joaquín Aguado and Björn Duderstadt and Insa Fuhrmann and Christian Motika and Stephen Mercer and Owen O’Brien and Partha Roop. Sequentially Constructive Concurrency—A Conservative Extension of the Synchronous Model of Computation. (% class="cmti-10" %)ACM Transactions on Embedded Computing(%%) (% class="cmti-10" %)Systems, Special Issue on Applications of Concurrency to System Design(%%), 13(4s):144:1–144:26, July 2014.  [[pdf>>url:http://rtsys.informatik.uni-kiel.de/~~biblio/downloads/papers/tecs14.pdf||shape="rect"]](% style="color:#000000" %), (%%)[[bib>>url:http://rtsys.informatik.uni-kiel.de/~~biblio/cgi-bin/bibcgi.cgi?key=vonHanxledenMA+14||shape="rect"]]
++(% style="color: rgb(0,0,0);" %)Reinhard von Hanxleden and Michael Mendler and Joaquín Aguado and Björn Duderstadt and Insa Fuhrmann and Christian Motika and Stephen Mercer and Owen O’Brien and Partha Roop. Sequentially Constructive Concurrency—A Conservative Extension of the Synchronous Model of Computation. (% class="cmti-10" %)ACM Transactions on Embedded Computing(%%) (% class="cmti-10" %)Systems, Special Issue on Applications of Concurrency to System Design(%%), 13(4s):144:1–144:26, July 2014.  [[pdf>>url:http://rtsys.informatik.uni-kiel.de/~~biblio/downloads/papers/tecs14.pdf||shape="rect"]](% style="color: rgb(0,0,0);" %), (%%)[[bib>>url:http://rtsys.informatik.uni-kiel.de/~~biblio/cgi-bin/bibcgi.cgi?key=vonHanxledenMA+14||shape="rect"]]
  * **Overview and High-Level Transformations in Detail:**
--(% style="color:#000000" %)Reinhard von Hanxleden and Björn Duderstadt and Christian Motika and Steven Smyth and Michael Mendler and Joaquín Aguado and Stephen Mercer and Owen O’Brien. SCCharts: Sequentially Constructive Statecharts for Safety-Critical Applications. Technical Report 1311, Christian-Albrechts-Universität zu Kiel, Department of Computer Science, December 2013. ISSN 2192-6247.  (%%)[[pdf>>url:http://rtsys.informatik.uni-kiel.de/~~biblio/downloads/papers/report-1311.pdf||shape="rect"]](% style="color:#000000" %), (%%)[[bib>>url:http://rtsys.informatik.uni-kiel.de/~~biblio/cgi-bin/bibcgi.cgi?key=vonHanxledenDM+13b||shape="rect"]]
++(% style="color: rgb(0,0,0);" %)Reinhard von Hanxleden and Björn Duderstadt and Christian Motika and Steven Smyth and Michael Mendler and Joaquín Aguado and Stephen Mercer and Owen O’Brien. SCCharts: Sequentially Constructive Statecharts for Safety-Critical Applications. Technical Report 1311, Christian-Albrechts-Universität zu Kiel, Department of Computer Science, December 2013. ISSN 2192-6247.  (%%)[[pdf>>url:http://rtsys.informatik.uni-kiel.de/~~biblio/downloads/papers/report-1311.pdf||shape="rect"]](% style="color: rgb(0,0,0);" %), (%%)[[bib>>url:http://rtsys.informatik.uni-kiel.de/~~biblio/cgi-bin/bibcgi.cgi?key=vonHanxledenDM+13b||shape="rect"]]
++\\
++{{/layout-cell}}
++{{/layout-section}}
++{{layout-section ac:type="two_right_sidebar"}}
++{{layout-cell}}
  = The SCCharts Metamodel =
  Navigate to the {{code language="none"}}models{{/code}} 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.
@@ -85,10 +85,10 @@
  ==== Model Task ====
  * (((
--(% style="line-height:1.42857" %)Answer the following questions
++(% style="line-height: 1.42857;" %)Answer the following questions
 . How do you describe a superstate in the model?
--1. Outline the relationship between states, regions, transitions, and valued objects.
++1. Outline the relationship between states, regions, transitions, and valued objects.\\
 . Name the class of the root element of an SCChart.
 . What is a valued object?
 . How do you get the type of an interface variable?
@@ -102,18 +102,25 @@
  *1. Now, navigate to the //Super State: Strong Abort Transition //example. Write down (on paper) how the model of that SCCharts looks like.
  *1. And finally a more sophisticated model: Write down the model of ABO (from [[doc:KIELER.Examples]]).
--{{info title="
--KLighD Screenshots"}}
++\\
++
++{{info title="KLighD Screenshots"}}
  By the way: You can //right-click// on the Diagram View surface and select //Save as image...// to create a screenshot!
  {{/info}}
++{{/layout-cell}}
++{{layout-cell}}
  [[image:attach:sccharts_metamodel.png]]
  [[image:attach:sccharts_metamodel_treeEditor.png]]
  [[image:attach:KLighDSaveAsImage.png]]
++{{/layout-cell}}
++{{/layout-section}}
--= Creating SCCharts Models Programmatically =
++{{layout-section ac:type="single"}}
++{{layout-cell}}
++= Creating SCCharts Models Programmatically  =
  == Creating a Test Project ==
@@ -208,23 +208,27 @@
  File extensions are important! They define the parser/serializer that EMF uses. Always use the file extension that is defined for a particular model.
  {{/info}}
  )))
++{{/layout-cell}}
++{{/layout-section}}
++{{layout-section ac:type="two_right_sidebar"}}
++{{layout-cell}}
  ==== Model Creation Task ====
  You are now equipped with the fundamentals you need to create models programmatically. Let's try it:
--* (% style="line-height:1.42857" %)The code fragments listed above do not suffice to create a grammatically correct model. Try to generate a model that corresponds with the serialized model listed on the right side.
--*1. (% style="line-height:1.42857" %)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.
++* (% style="line-height: 1.42857;" %)The code fragments listed above do not suffice to create a grammatically correct model. Try to generate a model that corresponds with the serialized model listed on the right side.
++*1. (% style="line-height: 1.42857;" %)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.
  *1. Execute the main method.
  *1. (((
--(% style="line-height:1.42857" %)Inspect your SCT file. (Press F5 to refresh your file view.)
++(% style="line-height: 1.42857;" %)Inspect your SCT file. (Press F5 to refresh your file view.)
--{{info title="Kext Warning"}}
++{{note title="Kext Warning"}}
  It is possible that kext generates a Null Pointer Exception when you save your model this way. This is a known issue. We're working on it. Just ignore it for now.
--{{/info}}
++{{/note}}
  )))
  * Now, create a new Java class and proceed as before to generate a model of ABO in the {{code language="none"}}main(){{/code}} method.
--* (% style="line-height:1.42857" %)Start your SCChart Editor Eclipse instance and load your SCT file. KLighD should now be able to visualize your ABO correctly.
++* (% style="line-height: 1.42857;" %)Start your SCChart Editor Eclipse instance and load your SCT file. KLighD should now be able to visualize your ABO correctly.(%%)\\
  *1. For this, open tab //Run// and select// Run Configurations...//
  *1. Create a new //Eclipse Application// and name it appropriately.
  *1. As product select {{code language="none"}}de.cau.cs.kieler.core.product.product{{/code}}.
@@ -231,8 +231,11 @@
  *1. Click //Run// (or //Debug// if you opened// Debug Configuration...//)
  *1. Create a new project and add you generated model.
--{{code language="java" title="
--Root.sct"}}
++\\
++{{/layout-cell}}
++
++{{layout-cell}}
++{{code language="java" title="Root.sct"}}
  scchart Root {
    initial state Init
    --> Init with true;
@@ -240,7 +240,11 @@
  {{/code}}
  [[image:attach:RunConfiguration.png]]
++{{/layout-cell}}
++{{/layout-section}}
++{{layout-section ac:type="two_right_sidebar"}}
++{{layout-cell}}
  = Model-to-Model Transformations with KiCo =
  You can use the [[Kieler Compiler>>url:http://rtsys.informatik.uni-kiel.de/confluence/display/KIELER/Kieler+Compiler||shape="rect"]] (KiCo) to handle all the model input/output tasks and concentrate on the actual transformation. If you executed the **Model Creation Task correctly**, you should now have a complete running SCT Editor instance that looks like the one on the right. You should see the //KIELER Compiler Selection// n the lower right part of the working space. Here you can select specific transformations that will be applied to the actual model. Simply select a transformation to test it.
@@ -248,9 +248,15 @@
  == Creating a new Transformation ==
  Now, you're going to write your own transformation with **Xtend** *drumroll*, a programming language that looks very similar to Java, but which adds some very convenient features. Xtend code compiles to Java and and was developed using Xtext. In fact, once you gain experience working with Xtend you will probably appreciate the power of Xtext even more. Xtend is particularly useful to browse & modify EMF models. You get the point... we like it. :)
++{{/layout-cell}}
++{{layout-cell}}
  [[image:attach:KielerSCTEditor.png]]
++{{/layout-cell}}
++{{/layout-section}}
++{{layout-section ac:type="two_right_sidebar"}}
++{{layout-cell}}
  ==== Transformation Creation Task ====
  * Create your first transformation...
@@ -295,7 +295,15 @@
  You should really think about some constants here. You can also look at the sccharts transformation and features constants in the sccharts plugin.
  {{/info}}
  )))
++{{/layout-cell}}
++{{layout-cell}}
++\\
++{{/layout-cell}}
++{{/layout-section}}
++
++{{layout-section ac:type="two_right_sidebar"}}
++{{layout-cell}}
  * KiCo must know about the new feature and also about your new transformation.
  *1. Add a new Xtend class with Feature as superclass. Add all unimplemented methods. Also set** sccharts.doubleStates** as Id.
  *1. Go to the Extension tab inside your plugin configuration.
@@ -309,9 +309,15 @@
  *111. preferred: (leave it blank)
  *1. {{note title="Plugin Tasks"}}In general it is bad to mix non-ui plugins/tasks with ui plugin/tasks because (in the context of KiCo) even if you're not working with an active UI your transformations should work (e.g. a command line compiler). To keep this tutorial simple, you can add this dependency to your plugin nevertheless. However, you shouldn't do this in real products. Always keep the UI separated.{{/note}}If you start your KIELER instance now, you should get a new compilation chain which has only one transformation: yours, which doesn't do anything.
  * If you want to rename your feature in the Compiler Selection (without changing its Id), override the {{code language="none"}}getName{{/code}} method and return a new name. Rename your feature appropriately.
++{{/layout-cell}}
++{{layout-cell}}
  [[image:attach:KielerSCTEditorOwnTransformation.png]]
++{{/layout-cell}}
++{{/layout-section}}
++{{layout-section ac:type="two_right_sidebar"}}
++{{layout-cell}}
  * Now, fill your transformation with life:
  *1. Inside your transformation class, add a new method with the following signature: {{code language="none"}}def State transform(State rootState, KielerCompilerContext context){{/code}}. This transformation will be executed if the feature is selected in the Compiler Selection.
  *1. (((
@@ -346,11 +346,15 @@
  Extensions are also just classes. You can add your own to improve the structure of your own projects. In KIELER all extensions end with "Extensions"; except SCChartsExtension for legacy reasons. This will be renamed in after the next snapshot to SCChartsExtensions. So, if you're going to add new extensions to the project, please name them accordingly.
  {{/note}}
  )))
++{{/layout-cell}}
++{{layout-cell}}
  [[image:attach:KielerSCTEditorOwnTransformationOlolo.png]]
++{{/layout-cell}}
++{{/layout-section}}
--
--
++{{layout-section ac:type="two_right_sidebar"}}
++{{layout-cell}}
  * Extend your transformation so that it is applied on all states (except the root state). Try your new transformation with ABO. The result should look like the example on the right.
  == The existing Compilation Chain ==
@@ -361,11 +361,22 @@
  //We will add more content to this subsection in the future...//
++\\
++{{/layout-cell}}
++{{layout-cell}}
  [[image:attach:ABODoubleStates.png]]
++\\
++\\
++\\
++{{/layout-cell}}
++{{/layout-section}}
++
++{{layout-section ac:type="single"}}
++{{layout-cell}}
  = Model-to-Model Transformations between Metamodels =
  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). When transforming to another metamodel, you're always generating a new model. So there is no in-place transformation. Both is possible. Just make sure that you know what you're doing.
@@ -411,13 +411,23 @@
  [[image:attach:abo_scg_HandleA.png]]
  )))
  )))
++{{/layout-cell}}
++{{/layout-section}}
++{{layout-section ac:type="two_equal"}}
++{{layout-cell}}
  The next figure depicts the direct mapping from normalized SCCharts to their corresponding SCG.
  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,
++{{/layout-cell}}
++{{layout-cell}}
  [[image:attach:sccharts-scg.png]]
++{{/layout-cell}}
++{{/layout-section}}
++{{layout-section ac:type="two_right_sidebar"}}
++{{layout-cell}}
  ==== Transformation Creation Task 2 ====
  Write a transformation that transforms your normalized version of ABO's HandleA into its corresponding SCG.
@@ -430,6 +430,15 @@
  *1. Optimize the given SCG and compare the result with the previous one.
  *1. Make sure that the two SCGs are still semantically identical.
++\\
  Congratulations! You finished the SCCharts Development Tutorial. Ask your supervisor for further instructions!
++\\
++{{/layout-cell}}
++
++{{layout-cell}}
++\\
++{{/layout-cell}}
++{{/layout-section}}
++{{/layout}}

Changes for page SCCharts Development

Summary

Details

Navigation

Quick Links