Changes for page SCCharts Development

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

From version < 17.1 >

edited by ssm
on 2016/04/21 17:19

To version < 20.1 >

edited by ssm
on 2016/04/22 14:40

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

@@ -135,18 +135,6 @@
  {{layout-section ac:type="single"}}
  {{layout-cell}}
--
--{{/layout-cell}}
--{{/layout-section}}
--
--{{layout-section ac:type="single"}}
--{{layout-cell}}
--
--{{/layout-cell}}
--{{/layout-section}}
--
--{{layout-section ac:type="single"}}
--{{layout-cell}}
  = Creating SCCharts Models Programmatically  =
  == Creating a Test Project ==
@@ -153,6 +153,7 @@
  We need a project for testing. Do the following:
++1. 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.
@@ -159,12 +159,12 @@
  == Creating a Model ==
--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:
++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:
  {{code language="java"}}
  SCChartsFactory sccFactory = SCChartsFactory.eINSTANCE;
--State state = sccFactory .createState();
--Transition transition = sccFactory .createTransition();
++State state = sccFactory.createState();
++Transition transition = sccFactory.createTransition();
  {{/code}}
  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.
@@ -171,13 +171,13 @@
  {{code language="java"}}
  KExpressionsFactory kFactory = KExpressionsFactory.eINSTANCE;
--BooleanValue boolValue = kFactory.createBooleanValue();
++BoolValue boolValue = kFactory.createBoolValue();
  {{/code}}
  For all simple attributes, there are getter and setter methods:
  {{code language="java"}}
--state.setId("Root");
++state.setId("Init");
  boolValue.setValue(true);
  {{/code}}
@@ -190,15 +190,25 @@
  List references (multiplicity of > 1) have only a list getter, which is used to manipulate the list:
  {{code language="java"}}
--state.outgoingTransitions.add(transition);
++state.getOutgoingTransitions().add(transition);
  {{/code}}
++{{info title="Plugin Dependencies"}}
++You may have noticed that is was not necessary to add a dependency for the kexpressions classes. The SCCharts plugin reexports the dependencies of the other EMF metamodels. Look at the plugin.xml in the SCCharts plugin in the dependency tab for more information.
++{{/info}}
++
  == Saving a Model ==
  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"}}org.eclipse.emf.ecore.xmi{{/code}} plug-in.
 . (((
++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"}}
++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"}}
@@ -205,10 +205,10 @@
  // Create a resource set.
  ResourceSet resourceSet = new ResourceSetImpl();
--// Register the default resource factory -- only needed for stand-alone!
--// this tells EMF to use XML to save the model
--resourceSet.getResourceFactoryRegistry().getExtensionToFactoryMap().put(
--    Resource.Factory.Registry.DEFAULT_EXTENSION, new SCTResourceFactoryImpl());
++// Register the resource factory -- only needed for stand-alone!
++SctStandaloneSetup.doSetup();
++
++
  // Get the URI of the model file.
  URI fileURI = URI.createFileURI(new File("myABO.sct").getAbsolutePath());
@@ -226,18 +226,172 @@
      /* error handling */
  }
  {{/code}}
++
++{{info title="File Extensions"}}
++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 ====
--With these information out of the way, on we go to some model creation:
++You are now equipped with the fundamentals you need to create models programmatically. Let's try it:
--1. Programmatically create a valid model of ABO in the {{code language="none"}}main(){{/code}} method.
--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.
--1. Execute the main method.
--1. Inspect your SCT file.
++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}}
++)))
++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.
 . 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}}
++
++{{layout-cell}}
++{{code language="java" title="Root.sct"}}
++scchart Root {
++  initial state Init
++  --> Init with true;
++}
++{{/code}}
++
++[[image:attach:RunConfiguration.png]]
++{{/layout-cell}}
++{{/layout-section}}
++
++{{layout-section ac:type="two_right_sidebar"}}
++{{layout-cell}}
++= Model-to-Model Transformation 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.
++
++== 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. :)
++
++
++
++Transformation Creation Task
++
++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"}}
++package tutorial.transformation
++
++import de.cau.cs.kieler.kico.transformation.AbstractProductionTransformation
++
++class DoubleStates extends AbstractProductionTransformation {
++
++    override getProducedFeatureId() {
++        throw new UnsupportedOperationException("TODO: auto-generated method stub")
++    }
++
++    override getId() {
++        throw new UnsupportedOperationException("TODO: auto-generated method stub")
++    }
++
++}
++{{/code}}
++)))
++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}}
++)))
++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. 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.
++
++
++{{/layout-cell}}
++
++{{layout-cell}}
++[[image:attach:KielerSCTEditor.png]]
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++
++[[image:attach:KielerSCTEditorOwnTransformation.png]]
++{{/layout-cell}}
++{{/layout-section}}
++
++{{layout-section ac:type="single"}}
++{{layout-cell}}
  = Transforming SCCharts =
  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.

Confluence.Code.ConfluencePageClass[0]

Id

@@ -1,1 +1,1 @@
--16810316
++16810368

URL

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

Changes for page SCCharts Development

Summary

Details

Navigation

Quick Links