Papyrus model execution framework

Clone this repo:
  1. b38d7c3 Bug 568832 - [MOKA, Designer] Tracepoint view enhancements by Ansgar Radermacher · 3 weeks ago master
  2. 53e3099 [releng] Update to Java 11 by Pauline DEVILLE · 3 weeks ago
  3. 235adad [releng] Reduce lower version for org.eclipse.emf.ecore by Ansgar Radermacher · 3 weeks ago
  4. fb9ce18 [releng] Update Papyrus dependencies by Pauline DEVILLE · 4 weeks ago
  5. dddb0c3 Set of fixes for 2020-06 by jeremie.tatibouet · 3 months ago

Moka

Moka is an open source project that aims to provide the MBSE community with a framework enabling UML based models execution and debugging.

General

Features

Moka provides three key features: Execution, Debugging and Animation.

Execution

The execution feature relies on implementation of OMG Executable UML standards: fUML 1.4, PSCS 1.2 and PSSM 1.0. It enables execution of any UML model conforming to the syntactic subset identified by the union of these standards. The conformance perimeter is therefore limited to classes, composite structures, activities and state machines.

While Moka was initially developped to enable UML based models execution, it's scope is not limited to UML and UML extensions. Indeed Moka execution framework is generic enough to enable development of execution engines supporting any type of EMF based models.

Debugging

Execution is useful but not sufficient to assess / understand what is going on when a modeled system is executed. It is especially true when the modeled systems does not behave as expected. In order to overcome this problem Moka comes with a specialization of the Eclipse debug framework. The Moka debug framework enables the final user to control the execution of a model (e.g., thread suspension) and to observe the state (e.g., variable values) of this later.

While Moka debug feaure was initially developped to provide debugging facilities for UML models execution, it is not limited to this perimeter. Indeed, the debug framework is generic enough to be specialized for any EMF based models debugging.

Animation

The animation feature completes execution and debugging by providing the user with the capability to follow the execution flow. In the context of UML based models, this feature change the visual state of model elements on diagrams (e.g., when a state is entered then its visual representation changes).

While Moka animation feature was initially developped for UML diagrams it is generic enough to be adapted to other graphical frameworks.

Installation

In order to install Moka follows the steps below:

  1. Open Eclipse
  2. Go to Help > Install > Install New Software
  3. Copy this update site URL to the Work with field.
  4. Check Moka Core (Incubation)
  5. Hit the Next button
  6. When the installation process completes then restart Eclipse

Configuration

In order to make Moka usable in your Eclipse, it needs to be configured. The configuration consists in the following steps:

  1. Download Mosquitto from this URL
  2. Install Moquitto on your system
  3. In Eclipse, go to Window > Preferences
  4. Unfold the Papyrus category and select the Simulation item
  5. Add the absolute path to the mosquitto executable file
  6. Specify the port used by Mosquitto
  7. Apply your changes

Architecture

Moka implementation is divided as follows.

  1. Kernel
  2. org.eclipse.papyrus.moka.kernel
  • API to implement an execution engine
  • API to implement an execution engine service
  • API to implement service with MQTT client
  • Extension points to declare engines and services
  1. org.eclipse.papyrus.moka.kernel.debug
  • API to implement a debuggable execution engine
  • API to implement a debug service
  • Implementation of the debug target
  • Implementation of the communication protocol (debug target - engine)
  1. org.eclipse.papyrus.moka.Kernel.animation
  • API to implement an animation service
  • Implemention of a generic animation engine
  1. org.eclipse.papyrus.moka.kernel.scheduling
  • API to implement execution engine specific scheduling
  • API to implement execution engine specific control (e.g., suspend / resume) over tasks
  1. UML
  2. org.eclipse.papyrus.moka.engine.uml
  • UML execution engine implementation
  • Extension point to declare libraries installed at an execution engine
  1. org.eclipse.papyrus.moka.engine.uml.animation
  • UML animation service implementation
  1. org.eclipse.papyrus.moka.engine.uml.debug
  • UML debug service implementation
  1. org.eclipse.papyrus.moka.engine.uml.scheduling
  • UML execution engine specific scheduling
  • UML execution engine specific tasks
  1. org.eclipse.papyrus.moka.fuml
  • Implementation of the fUML 1.4 semantic model
  1. org.eclipse.papyrus.moka.fuml.interfaces
  1. org.eclipse.papyrus.moka.pscs
  • Implementation of the PSCS 1.2 semantic model
  1. org.eclipse.papyrus.moka.pscs.interfaces
  1. org.eclipse.papyrus.moka.pssm
  • Implementation of the PSSM 1.0 semantic model
  1. org.eclipse.papyrus.moka.pssm.interfaces
  1. org.eclipse.papyrus.moka.fuml.standardlibrary
  • Implementation of the fUML 1.4 model library
  1. UI

  2. org.eclipse.papyrus.moka.ui

  3. org.eclipse.papyrus.moka.utils.ui

  4. org.eclipse.papyrus.moka.ui.tracepoint.view

  5. Misc

  6. org.eclipse.papyrus.moka.modeling.utils

  7. org.eclipse.papyrus.moka.pscs.utils

  8. org.eclipse.papyrus.moka.utils

  9. org.eclipse.papyrus.moka.trace

  10. org.eclipse.papyrus.moka.trace.interfaces

  11. org.eclipse.papyrus.moka.trace.model

  12. org.eclipse.papyrus.moka.trace.model