Changes for page SCCharts Development

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

From version < 49.1 >

edited by ssm
on 2016/04/22 17:08

To version < 22.1 >

edited by ssm
on 2016/04/22 15:39

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Objects (1 modified, 0 added, 0 removed)
- Confluence.Code.ConfluencePageClass[0]

Details

Page properties

Content

@@ -1,7 +1,7 @@
  {{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.
++This is a light-weight tutorial for developing 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.
@@ -13,7 +13,7 @@
  == 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.
++As you're going to develop for KIELER SCCharts we recommend to use the semantic 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}}
@@ -102,24 +102,21 @@
  ==== Model Task ====
--* (((
--(% style="line-height: 1.42857;" %)Answer the following questions
++1. Answer the following questions
++11. How do you describe a superstate in the model?
++11. Outline the relationship between states, regions, transitions, and valued objects.\\
++11. Name the class of the root element of an SCChart.
++11. What is a valued object?
++11. How do you get the type of an interface variable?
++11. What other metamodels are needed for the SCCharts metamodel and write down which one is needed for what?
++1. Write down (on paper, text editor, etc) how the following SCChart models look like
++11. Open the wiki page that explains the [[doc:KIELER.Textual SCCharts Language SCT]].
++11. Search the //SCChart, Initial State, State, Transition and Immediate Transition //example and ...
++111. write down (on paper or text editor, etc) how the model of that SCChart looks like.
++111. The user now marks C as final. What has to be changed in the model? What semantic problem do you see?
++11. Now, navigate to the //Super State: Strong Abort Transition //example. Write down (on paper) how the model of that SCCharts looks like.
++11. And finally a more sophisticated model: Write down the model of ABO (from [[doc:KIELER.Examples]]).
--1. How do you describe a superstate in the model?
--1. Outline the relationship between states, regions, transitions, and valued objects.\\
--1. Name the class of the root element of an SCChart.
--1. What is a valued object?
--1. How do you get the type of an interface variable?
--1. What other metamodels are needed for the SCCharts metamodel and write down which one is needed for what?
--)))
--* Write down (on paper, text editor, etc) how the following SCChart models look like
--*1. Open the wiki page that explains the [[doc:KIELER.Textual SCCharts Language SCT]].
--*1. Search the //SCChart, Initial State, State, Transition and Immediate Transition //example and ...
--*11. write down (on paper or text editor, etc) how the model of that SCChart looks like.
--*11. The user now marks C as final. What has to be changed in the model? What semantic problem do you see?
--*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"}}
@@ -144,10 +144,10 @@
  We need a project for testing. Do the following:
--* If you used the standard KIELER Oomph installation setup, create a new Working Set named Tutorial in the Package Explorer. Then...
--* Create a new empty //Plug-In Project//.
--* Add the project that contains the sccharts metamodel as a dependency of your new project through the //Plugin Manifest Editor//.
--* 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.
++1. If you used the standard KIELER Oomph installation setup, create a new Working Set named Tutorial in the Package Explorer. Then...
++1. Create a new empty //Plug-In Project//.
++1. Add the project that contains the sccharts metamodel as a dependency of your new project through the //Plugin Manifest Editor//.
++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.
  == Creating a Model ==
@@ -193,7 +193,7 @@
  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:
--* (((
++1. (((
  Add a dependency to the {{code language="none"}}com.google.inject, org.eclipse.core.resources, {{/code}}and{{code language="none"}} de.cau.cs.kieler.sccharts.text{{/code}} plug-ins.
  {{info title="Additional Dependencies"}}
@@ -200,7 +200,7 @@
  Don't worry. You will be experienced enough to add mandatory dependencies quickly in the future. However, for now just add the dependencies to proceed with the tutorial.
  {{/info}}
  )))
--* (((
++1. (((
  Use something like the following code to save the model from above:
  {{code language="java"}}
@@ -242,23 +242,23 @@
  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.
--*1. Execute the main method.
--*1. (((
--(% style="line-height: 1.42857;" %)Inspect your SCT file. (Press F5 to refresh your file view.)
++1. 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.
++11. Run the {{code language="none"}}main(){{/code}} method by right-clicking its class and selecting (% style="line-height: 1.42857;" %)//Run as//(%%) -> (% style="line-height: 1.42857;" %)//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.
++11. Execute the main method.
++11. (((
++Inspect your SCT file. (Press F5 to refresh your file view.)
  {{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.
  {{/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.(%%)\\
--*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}}.
--*1. Click //Run// (or //Debug// if you opened// Debug Configuration...//)
--*1. Create a new project and add you generated model.
++1. Now, create a new Java class and proceed as before to generate a model of ABO in the {{code language="none"}}main(){{/code}} method.
++1. Start your SCChart Editor Eclipse instance and load your SCT file. KLighD should now be able to visualize your ABO correctly.
++11. For this, open tab //Run// and select// Run Configurations...//
++11. Create a new //Eclipse Application// and name it appropriately.
++11. As product select {{code language="none"}}de.cau.cs.kieler.core.product.product{{/code}}.
++11. Click //Run// (or //Debug// if you opened// Debug Configuration...//)
++11. Create a new project and add you generated model.
  {{/layout-cell}}
@@ -279,29 +279,22 @@
  {{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.
++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.
  == 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}}
++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}}
--[[image:attach:KielerSCTEditor.png]]
--{{/layout-cell}}
--{{/layout-section}}
++
--{{layout-section ac:type="two_right_sidebar"}}
--{{layout-cell}}
  ==== Transformation Creation Task ====
--* Create your first transformation...
--*1. Create a new project within your tutorial working set as before.
--*1. Add plugin dependencies to {{code language="none"}}de.cau.cs.kieler.kico{{/code}} and {{code language="none"}}de.cau.cs.kieler.sccharts{{/code}}.
--*1. Create a new //Xtend class// in you package and name it "DoubleStates" and use {{code language="none"}}AbstractProductionTransformation{{/code}} as superclass.
--*1. Here, you can automatically add the missing Xtend files by using the quickfix //Add Xtend lib to class path. //Alternatively you can simply add {{code language="none"}}com.google.guava{{/code}}, {{code language="none"}}org.eclipse.xtext.xbase.lib{{/code}}, {{code language="none"}}org.eclipse.xtend.lib{{/code}}, and {{code language="none"}}org.eclipse.xtend.lib.macro{{/code}} to you plugin dependencies.
--*1. Click on //Add unimplemented methods//.
--*1. (((
++1. Therefore, create a new project within your tutorial working set as before.
++1. Add plugin dependencies to {{code language="none"}}de.cau.cs.kieler.kico{{/code}} and {{code language="none"}}de.cau.cs.kieler.sccharts{{/code}}.
++1. Create a new //Xtend class// in you package and name it "DoubleStates" and use {{code language="none"}}AbstractProductionTransformation{{/code}} as superclass.
++1. Here, you can automatically add the missing Xtend files by using the quickfix //Add Xtend lib to class path. //Alternatively you can simply add {{code language="none"}}com.google.guava{{/code}}, {{code language="none"}}org.eclipse.xtext.xbase.lib{{/code}}, {{code language="none"}}org.eclipse.xtend.lib{{/code}}, and {{code language="none"}}org.eclipse.xtend.lib.macro{{/code}} to you plugin dependencies.
++1. Click on //Add unimplemented methods//.
++1. (((
  Now, you should have a class similar to the following one.
  {{code language="java"}}
@@ -330,47 +330,29 @@
  * 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, {{code language="none"}}def create {{/code}}methods might offer a better alternative...
  {{/info}}
  )))
--* (((
--As you can see, it is mandatory to add an id for the transformation and another id of the feature that this transformation produces. Name your transformation **tutorial.doubleStates **and the id of feature you want to produce is **sccharts.doubleStates**.
++1. (((
++As you can see, it is mandatory to add an id for the transformation and another id of the feature that this transformation produces. Name your transformation **tutorial.doubleStates **and the id of feature you want to produce is **sccharts.doubleStates**.
  {{info title="Programming Guidelines"}}
  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.
--*11. Add a new Extension Point de.cau.cs.kieler.kico.feature. Create a new  featureClass and point it to your new feature class.
--*11. Also add a new Extension Point de.cau.cs.kieler.kico.transformation. Create a new productionTransformationClass and point it to your transformation class.
--*11. Finally, you have to link your transformation to the SCT Editor. Add the Extension point de.cau.cs.kieler.kico.ui.transformation. Create an editor link and fill in the following values:
--*111. editor: {{code language="none"}}de.cau.cs.kieler.sccharts.text.sct.Sct{{/code}}
--*111. features: sccharts.doubleStates
--*111. label: Tutorial Compilation
--*111. priority: 101
--*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. (((
++1. KiCo must know about the new feature and also about your new transformation.
++11. Add a new Xtend class with Feature as superclass. Add all unimplemented methods. Also set** sccharts.doubleStates** as Id.
++11. Go to the Extension tab inside your plugin configuration.
++111. Add a new Extension Point de.cau.cs.kieler.kico.feature. Create a new  featureClass and point it to your new feature class.
++111. Also add a new Extension Point de.cau.cs.kieler.kico.transformation. Create a new productionTransformationClass and point it to your transformation class.
++111. Finally, you have to link your transformation to the SCT Editor. Add the Extension point de.cau.cs.kieler.kico.ui.transformation. Create an editor link and fill in the following values:
++1111. editor: de.cau.cs.kieler.sccharts.text.sct.Sct
++1111. features: sccharts.doubleStates
++1111. label: Tutorial Compilation
++1111. priority: 101
++1111. preferred: (leave it blank)
++11. {{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.
++1. If you want to rename your feature in the Compiler Selection (without changing its Id), override the getName method and return a new name. Rename your feature appropriately.
++1. Now, fill your transformation with life:
++11. Inside your transformation class, add a new method with the following signature: def State transform(State rootState, KielerCompilerContext context). This transformation will be executed if the feature is selected in the Compiler Selection.
++11. (((
  Add thew following body to the function and try to understand the Xtend code. Import unknown class via code assist.
  {{code language="java" title="transform"}}
@@ -386,10 +386,10 @@
      }
  {{/code}}
  )))
--*1. When selecting your transformation, the SCChart gets transformed and looks like the version on the right.
--* Extend the transformation so that the transition is split up in two and connected via a transient state meaning that the original transformation should point to the new state and a new immediate transformation then points to the original target state. Try it out.
--* (((
--Xtend supports extensions that can be used to extend the function set of you classes (i.e. models). Add {{code language="none"}}com.google.inject{{/code}} to the dependencies of your plugin. Now, add the following code fragment to the beginning of your class.
++11. When selecting your transformation, the SCChart gets transformed and looks like the version on the right.
++1. Extend the transformation so that the transition is split up in two and connected via a transient state meaning that the original transformation should point to the new state and a new immediate transformation then points to the original target state. Try it out.
++1. (((
++Xtend supports extensions that can be used to extend the function set of you classes (i.e. models). Add {{code language="none"}}com.google.inject{{/code}} to the dependencies of your plugin. Now, add the following code fragment to the beginning of your class.
  {{code language="java" title="Code injection"}}
      @Inject
@@ -396,23 +396,14 @@
      extension SCChartsExtension
  {{/code}}
--There are several Extensions classes within the KIELER project that extend the functionality of various classes. Basically, there are one or more for each metamodel (e.g. SCCharts, SCG, KExpressions, etc). You don't want to invent the wheel again. Use these methods. For example: there is a method that gives you all contained states of a state in a list: {{code language="none"}}getAllContainedStatesList{{/code}}. You can use it on your {{code language="none"}}rootState{{/code}}: {{code language="none"}}rootState.allContainedStatesList{{/code}}. There are also several convenient methods for creating model elements so that you don't have to use the factories directly.
++There are several Extensions classes within the KIELER project that extend the functionality of various classes. Basically, there are one or more for each metamodel (e.g. SCCharts, SCG, KExpressions, etc). You don't want to invent the wheel again. Use these methods. For example: there is a method that gives you all contained states of a state in a list: {{code language="none"}}getAllContainedStatesList{{/code}}. You can use it on your {{code language="none"}}rootState{{/code}}: {{code language="none"}}rootState.allContainedStatesList{{/code}}.
  {{note title="Extensions Naming Scheme"}}
  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}}
++1. 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.
--{{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 ==
  Congratulations. You added and executed your own KiCo transformation. Nevertheless, often you want to extend the existing compilation chain. To do this, you proceed as before but instead of creating your own compilation chain, you must modify the existing chains (e.g. the netlist compilation in de.cau.cs.kieler.sccharts.ui). To add a specific transformation at a specific point in the chain, you must tell KiCo what features are required for the transformation. For that you must override the method getRequiredFeatureIds and return a set with all required features.
@@ -425,7 +425,7 @@
  {{/layout-cell}}
  {{layout-cell}}
--[[image:attach:ABODoubleStates.png]]
++[[image:attach:KielerSCTEditor.png]]
@@ -432,6 +432,64 @@
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++[[image:attach:KielerSCTEditorOwnTransformation.png]]
++
++[[image:attach:KielerSCTEditorOwnTransformationOlolo.png]]
++
++
++
++
++
++
++
++
++
++
++
++
++
++[[image:attach:ABODoubleStates.png]]
  {{/layout-cell}}
  {{/layout-section}}
@@ -493,16 +493,14 @@
  Write a transformation that transforms your normalized version of ABO's HandleA into its corresponding SCG.
--* Proceed as before. Create a new plugin (or copy your last one) Make sure, you also add de.cau.cs.kieler.scg to your dependencies.
--* Write a transformation that is able to transform {{code language="none"}}ABO_norm_HandleA{{/code}} into its corresponding SCG.
--* **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.
--* Check your SCG semantically. Is there anything you could improve/optimize?
--*1. Write a second transformation (just as before) and add it to the transformation chain right after the transformation you already added.
--*1. Optimize the given SCG and compare the result with the previous one.
--*1. Make sure that the two SCGs are still semantically identical.
++1. Proceed as before. Create a new plugin (or copy your last one) Make sure, you also add de.cau.cs.kieler.scg to your dependencies.
++1. Write a transformation that is able to transform {{code language="none"}}ABO_norm_HandleA{{/code}} into its corresponding SCG.
++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.
++1. Check your SCG semantically. Is there anything you could improve/optimize?
++11. Write a second transformation (just as before) and add it to the transformation chain right after the transformation you already added.
++11. Optimize the given SCG and compare the result with the previous one.
++11. Make sure that the two SCGs are still semantically identical.
--
--
  Congratulations! You finished the SCCharts Development Tutorial. Ask your supervisor for further instructions!

Confluence.Code.ConfluencePageClass[0]

Id

@@ -1,1 +1,1 @@
--16810426
++16810374

URL

@@ -1,1 +1,1 @@
--https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/TUT/pages/16810426/SCCharts Development
++https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/TUT/pages/16810374/SCCharts Development

Changes for page SCCharts Development

Summary

Details

Navigation

Quick Links