AF3_Plugins_Description.md

+TK2 and AF3 Plugins Description
+===============================
+
+TK2
+---
+
+The [fortiss tooling kernel
+version 2](Tooling\_Kernel\_Plugins\_Description) (TK2) comprises the following plugins:
+
+<table>
+<thead>
+<tr class="header">
+<th>Plugin</th>
+<th>Description</th>
+<th><strong>Responsibility</strong></th>
+<th></th>
+</tr>
+</thead>
+<tbody>
+<tr class="odd">
+<td></td>
+<td></td>
+<td><span style="color:red;">Primary</span></td>
+<td><span style="color:green;">Secondary</span></td>
+</tr>
+<tr class="even">
+<td>tooling.common</td>
+<td>Base imports and common utilities.</td>
+<td><span style="color:red;">AD</span></td>
+<td><span style="color:green;">SB</span></td>
+</tr>
+<tr class="odd">
+<td>tooling.graphicsGL</td>
+<td>GL-based common infrastructure.</td>
+<td><span style="color:red;">FH</span></td>
+<td><span style="color:green;">JE</span></td>
+</tr>
+<tr class="even">
+<td>tooling.kernel</td>
+<td>The kernel infrastructure implementation.</td>
+<td><span style="color:red;">SB</span></td>
+<td><span style="color:green;">JE</span></td>
+</tr>
+<tr class="odd">
+<td>tooling.base</td>
+<td>Base implementations shared by modeling tools.</td>
+<td><span style="color:red;">SB</span></td>
+<td><span style="color:green;">JE</span></td>
+</tr>
+<tr class="even">
+<td>spiderchart.ui</td>
+<td>Base implementation for spider charts.</td>
+<td><span style="color:red;">JE</span></td>
+<td><span style="color:green;">SB</span></td>
+</tr>
+</tbody>
+</table>
+
+AF3
+---
+
+The following plugins are currently integrated into the *AF3 Phoenix*
+product:
+
+<table>
+<thead>
+<tr class="header">
+<th>Plugin</th>
+<th>Description</th>
+<th><strong>Responsibility</strong></th>
+<th></th>
+</tr>
+</thead>
+<tbody>
+<tr class="odd">
+<td></td>
+<td></td>
+<td><span style="color:red;">Primary</span></td>
+<td><span style="color:green;">Secondary</span></td>
+</tr>
+<tr class="even">
+<td>com.microsoft.z3</td>
+<td>Microsoft Z3 libraries, Java bindings and utilities</td>
+<td>{color:red} JE</td>
+<td>{color:green} MV</td>
+</tr>
+<tr class="odd">
+<td>eu.fbk.af3.tools.diagram</td>
+<td>Possibly removed</td>
+<td>{color:red} ?</td>
+<td>{color:green} ?</td>
+</tr>
+<tr class="even">
+<td>af3.allocation</td>
+<td>Deployments between hierarchical platforms layers (logical, task, partition, HW platform architecture)</td>
+<td><span style="color:red;">SB</span></td>
+<td><span style="color:green;">AD</span></td>
+</tr>
+<tr class="odd">
+<td>af3.component</td>
+<td>Component language with code behavior specifications.</td>
+<td><span style="color:red;">AB</span></td>
+<td><span style="color:green;">FH</span></td>
+</tr>
+<tr class="even">
+<td>af3.cosimulation</td>
+<td></td>
+<td>{color:red} TM</td>
+<td><span style="color:green;">JE</span></td>
+</tr>
+<tr class="odd">
+<td>af3.exploration</td>
+<td></td>
+<td><span style="color:red;">AD</span></td>
+<td><span style="color:green;">JE</span></td>
+</tr>
+<tr class="even">
+<td>af3.exploration.smt</td>
+<td></td>
+<td><span style="color:red;">MV</span></td>
+<td><span style="color:green;">JE</span></td>
+</tr>
+<tr class="odd">
+<td>af3.expression</td>
+<td>Expression and action language (functional and imperative).</td>
+<td><span style="color:red;">FH</span></td>
+<td><span style="color:green;">AB</span></td>
+</tr>
+<tr class="even">
+<td>af3.generator.common</td>
+<td>Common code for Java and C code generation.</td>
+<td><span style="color:red;">FH</span></td>
+<td><span style="color:green;">AB</span></td>
+</tr>
+<tr class="odd">
+<td>af3.mira</td>
+<td>Requirements modeling and analysis.</td>
+<td>refactoring 09.12.</td>
+<td></td>
+</tr>
+<tr class="even">
+<td>af3.mode</td>
+<td>Mode automata for component behavior specification.</td>
+<td><span style="color:red;">FH</span></td>
+<td><span style="color:green;">TC</span></td>
+</tr>
+<tr class="odd">
+<td><del>af3.msc</del></td>
+<td><del>Message sequence charts.</del></td>
+<td>—</td>
+<td>—</td>
+</tr>
+<tr class="even">
+<td><del>af3.ocra</del></td>
+<td><del>OCRA-based verification.</del></td>
+<td>—</td>
+<td>—</td>
+</tr>
+<tr class="odd">
+<td>af3.operatorpanel</td>
+<td>Operator panel specifications.</td>
+<td><span style="color:red;">FH</span></td>
+<td><span style="color:green;">TC</span></td>
+</tr>
+<tr class="even">
+<td>af3.partition</td>
+<td>Vendor-independent partition architecture model</td>
+<td><span style="color:red;">SB</span></td>
+<td><span style="color:green;">AD</span></td>
+</tr>
+<tr class="odd">
+<td>af3.platform</td>
+<td>Platform modeling framework and <em>Generic Platform</em> model</td>
+<td><span style="color:red;">SB</span></td>
+<td><span style="color:green;">FH</span></td>
+</tr>
+<tr class="even">
+<td>af3.platform.hierarchic</td>
+<td>Generic hierarchical platform.</td>
+<td><span style="color:red;">SB</span></td>
+<td>AD</td>
+</tr>
+<tr class="odd">
+<td>af3.project</td>
+<td>Project collecting all design specifications.</td>
+<td><span style="color:red;">FH</span></td>
+<td><span style="color:green;">AB</span></td>
+</tr>
+<tr class="even">
+<td>af3.rcapplication</td>
+<td>AutoFOCUS 3 application.</td>
+<td><span style="color:red;">AD</span></td>
+<td><span style="color:green;">FH</span></td>
+</tr>
+<tr class="odd">
+<td>af3.rchelp</td>
+<td>AutoFOCUS 3 online hel</td>
+<td><span style="color:red;">SB</span></td>
+<td><span style="color:green;">JE</span></td>
+</tr>
+<tr class="even">
+<td><del>af3.refinement</del></td>
+<td><del>Modeling of abstract to concrete model refinements.</del></td>
+<td>—</td>
+<td>—</td>
+</tr>
+<tr class="odd">
+<td>af3.safety</td>
+<td>Modeling of safety properties</td>
+<td><span style="color:red;">AD</span></td>
+<td><span style="color:green;">JE</span></td>
+</tr>
+<tr class="even">
+<td>af3.safetycases</td>
+<td>Specification of safety cases.</td>
+<td><span style="color:red;">CC</span></td>
+<td><span style="color:green;">SB?</span></td>
+</tr>
+<tr class="odd">
+<td>af3.schedule</td>
+<td>Modeling resource and system schedules</td>
+<td><span style="color:red;">SB</span></td>
+<td><span style="color:green;">JE</span></td>
+</tr>
+<tr class="even">
+<td><del>af3.specification</del></td>
+<td><del>Modeling of verification specifications.</del></td>
+<td>—</td>
+<td>—</td>
+</tr>
+<tr class="odd">
+<td>af3.state</td>
+<td>State automata for component behavior specification.</td>
+<td><span style="color:red;">FH</span></td>
+<td><span style="color:green;">TM</span></td>
+</tr>
+<tr class="even">
+<td>af3.task</td>
+<td>Vendor-independent task architecture model</td>
+<td><span style="color:red;">JE</span></td>
+<td><span style="color:green;">SB</span></td>
+</tr>
+<tr class="odd">
+<td><del>af3.testing</del></td>
+<td><del>Base implementation of testing models and various generation methods.</del></td>
+<td>—</td>
+<td>—</td>
+</tr>
+<tr class="even">
+<td>af3.timing</td>
+<td>Modeling of temporal requirements and properties</td>
+<td><span style="color:red;">AD</span></td>
+<td><span style="color:green;">TM</span></td>
+</tr>
+<tr class="odd">
+<td><del>af3.tools</del></td>
+<td><del>Common code for external tool integrations.</del></td>
+<td>—</td>
+<td>—</td>
+</tr>
+<tr class="even">
+<td><del>pragmatictransformation</del></td>
+<td>—</td>
+<td>—</td>
+<td>—</td>
+</tr>
+</tbody>
+</table>
+
+Plugins which are planned to be added in 2.17
+---------------------------------------------
+
+<table>
+<thead>
+<tr class="header">
+<th>Plugin</th>
+<th>Description</th>
+<th><strong>Responsibility</strong></th>
+<th></th>
+</tr>
+</thead>
+<tbody>
+<tr class="odd">
+<td></td>
+<td></td>
+<td><span style="color:red;">Primary</span></td>
+<td><span style="color:green;">Secondary</span></td>
+</tr>
+<tr class="even">
+<td>org.fortiss.variability</td>
+<td></td>
+<td>AB</td>
+<td>?</td>
+</tr>
+<tr class="odd">
+<td>org.fortiss.af3.variability</td>
+<td></td>
+<td>AB</td>
+<td>?</td>
+</tr>
+<tr class="even">
+<td>org.fortiss.af3.variability.ui</td>
+<td></td>
+<td>AB</td>
+<td>?</td>
+</tr>
+<tr class="odd">
+<td>org.fortiss.af3.variability.featuremodel</td>
+<td></td>
+<td>AB</td>
+<td>?</td>
+</tr>
+<tr class="even">
+<td>org.fortiss.af3.variability.featuremodel.ui</td>
+<td></td>
+<td>AB</td>
+<td>?</td>
+</tr>
+<tr class="odd">
+<td>org.fortiss.af3.exploration.alg</td>
+<td>MOEA DSE</td>
+<td>AD</td>
+<td>?</td>
+</tr>
+</tbody>
+</table>
+
+Additional Plugins
+------------------
+
+The following plugins are currently not integrated into the AF3 Phoenix
+product.
+
+<table>
+<thead>
+<tr class="header">
+<th>Plugin</th>
+<th>Description</th>
+<th><strong>Responsibility</strong></th>
+<th></th>
+</tr>
+</thead>
+<tbody>
+<tr class="odd">
+<td></td>
+<td></td>
+<td><span style="color:red;">Primary</span></td>
+<td><span style="color:green;">Secondary</span></td>
+</tr>
+<tr class="even">
+<td>af3.exploration.alg</td>
+<td></td>
+<td><span style="color:red;">AD</span></td>
+<td><span style="color:green;">?</span></td>
+</tr>
+<tr class="odd">
+<td>af3.obcsa</td>
+<td></td>
+<td><span style="color:red;">SZ?</span></td>
+<td><span style="color:green;">?</span></td>
+</tr>
+<tr class="even">
+<td>af3.reuse</td>
+<td></td>
+<td><span style="color:red;">AB</span></td>
+<td></td>
+</tr>
+<tr class="odd">
+<td>af3.security</td>
+<td></td>
+<td><span style="color:red;">VN</span></td>
+<td></td>
+</tr>
+<tr class="even">
+<td>af3.sim.behavior</td>
+<td>(To be merged with cosimulation)</td>
+<td></td>
+<td></td>
+</tr>
+<tr class="odd">
+<td>af3.variability</td>
+<td></td>
+<td><span style="color:red;">AB</span></td>
+<td><span style="color:green;">SA</span></td>
+</tr>
+<tr class="even">
+<td>conti</td>
+<td></td>
+<td><span style="color:red;">JE</span></td>
+<td></td>
+</tr>
+<tr class="odd">
+<td>variability</td>
+<td></td>
+<td><span style="color:red;">AB</span></td>
+<td><span style="color:green;">SA</span></td>
+</tr>
+</tbody>
+</table>
+
+AF3 Plugins Conventions
+=======================
+
+Naming conventions
+------------------
+
+We distinguish consistently between plugins concerning the AF3 modeling
+language and its user interface implementation.  
+The naming convention is
+
+    org.fortiss.af3.the_plugin
+
+  
+for the language (meta-model, semantic functionality), and
+
+    org.fortiss.af3.the_plugin.ui
+
+  
+for the presentation and user interaction implementation.
+
+Top-level Packages
+------------------
+
+The modeling language plugins will adhere to the following list of
+top-level packages.
+
+**model**: The EMF meta-model classes. This package is usually found in
+*generated-src* folder.  
+**annotations**: Implementation related to the annotation framework.  
+**compose**: Implementations of compositors.  
+**constraint**: Implementations of constraints.  
+**generator**: Implementations of generators (if the language supports
+that). Target language identifier is usually the next level of package
+names, e.g. **generator.java**.  
+**prototypes**: Implementation of prototypes.  
+**simulator**: Implementations of a simulator backend (if the language
+supports that).  
+**utils**: Utility classes and methods. Classes in this package only
+contain static implementations.
+
+The user interface plugins will adhere to the following list of
+top-level elements.
+
+**editor**: Implementations of editors.  
+**editpart**: Implementations of graphical editors’ parts.  
+**handler**: Implementations of model element handlers.  
+**properties**: Implementations of property sections.  
+**simulator**: Implementations of a simulator front-end (if the language
+supports that).  
+**utils**: Utility classes and methods. Classes in this package only
+contain static implementations.
+