/SCA

JPL Statechart Autocoder Rev. 2

Primary LanguageHTMLOtherNOASSERTION

JPL Statechart Autocoder (SCA) Rev. 2 Repository (NO FLIGHT CODE ALLOWED)

Last Update: 1 Nov. 2016

The Statechart Autocoder (SCA) was developed at the Jet Propulsion Laboratory in Pasadena, CA. SCA is a tool that takes UML Statecharts (essentially Harel Statecharts) as input, in the form of XMI, and generates state machine code implementations in a variety of languages. The tool is designed to receive UML statecharts created in the MagicDraw CASE (Computer Aided Software Engineering) tool developed and sold by No Magic Inc. MagicDraw is a commercially available CASE tool and not open source, however, a trial version can be downloaded from MagicDraw® Demo. Note the current release of SCA (as of Oct 31, 2016) now supports XMI produced by MagicDraw up to version 18.0

SCA can generate C, C++, and Python implementations of state machines. In addition SCA can also generate Promela for verification of designs. The Promela is still very experimental. The C and C++ state machines use the multi-threaded state machine framework called Quantum Framework and developed by Miro Samek. We distribute older versions of the Quantum Framework, which are known to work with the C and C++ code we generate, but the official source code and license information is from (http://www.state-machine.com/). Our Python Framework was developed at JPL is our own implementation of Samek's Quantum Framework in native Python with some GUI hooks added which will be explained later.

Getting Started

  1. Download the .zip archive and unzip, or git clone this repository.

  2. Environment setup:

  • Define SCA_ROOT
  • If csh do this setenv SCA_ROOT ./SCA
  • If bash do this export SCA_ROOT=./SCA
  • If csh: cd $SCA_ROOT/QF_Py/bin; source cshrc.sh
  • If bash: cd $SCA_ROOT/QF_Py/bin; source bashrc.sh
  1. Next, compile autocoder by doing this:
cd $SCA_ROOT/autocoder
ant clean all
  1. Finally, autocode something; typically, create an autocode subdirectory and autocode model output into that path:
  • C: cd $SCA_ROOT/QF_C/test/Calculator/autocode ; java -jar $SCA_ROOT/autocoder/autocoder.jar -c ../Calculator.xml
  • C++: cd $SCA_ROOT/QF_Cpp/test/Calculator/autocode ; java -jar $SCA_ROOT/autocoder/autocoder.jar -cpp ../Calculator.xml
  • Python: cd $SCA_ROOT/QF_Py/test/Calculator/autocode ; java -jar $SCA_ROOT/autocoder/autocoder.jar -python ../Calculator.xml
  • Promela: cd $SCA_ROOT/Spin/test/Calculator/autocode ; java -jar $SCA_ROOT/autocoder/autocoder.jar -promela ../Calculator.xml
  1. Unit tests can be run by executing:
cd $SCA_ROOT/QF_Py/bin
allsuites.py

All tests for C, C++, Python should pass, however some spin unit tests fail.

Directory Structure

To Be Completed.

History

To Be Completed.

Collaboration

To Be Completed.