documentation/nightly/standalone-generators.html - gerrit/www.eclipse.org/etrice - Git at Google

 <!DOCTYPE html>
 <html lang="en">
 <head>
 <meta charset="utf-8">
 <meta http-equiv="X-UA-Compatible" content="IE=edge">
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
 <title>eTrice Documentation</title>

 <!-- Bootstrap -->
 <link rel="stylesheet" type="text/css" href="css/bootstrap.min.css"/>
 <link rel="stylesheet" type="text/css" href="css/metisMenu.min.css"/>
 <link rel="stylesheet" type="text/css" href="css/font-awesome.min.css"/>
 <link rel="stylesheet" type="text/css" href="css/prettify.css"/>
 <link rel="stylesheet" type="text/css" href="css/custom.css"/>
 <link rel="stylesheet" type="text/css" href="css/custom-common.css"/>

 <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
 <!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
 <!--[if lt IE 9]>
 <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
 <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
 <![endif]-->

 </head>
 <body>

 <!-- Fixed navbar -->
 <nav class="navbar navbar-default navbar-static-top" role="navigation">
 <div class="container">
 <div class="navbar-header">
 <a class="navbar-brand" style="padding-bottom: 2px; padding-top: 4px;" href="introduction.html"><img style="height: 100%;" src="images/logo/etrice-logo-interim.png"></a>
 </div>
 <div id="navbar" class="collapse navbar-collapse">
 <ul class="nav navbar-nav">
 <li class="active"><a href="introduction.html">Online Documentation</a></li>
 <li><a href="http://www.eclipse.org/forums/eclipse.etrice">Newsgroup</a></li>
 <li><a href="https://www.eclipse.org/etrice/">eTrice Home</a></li>
 <li><a href="https://www.eclipse.org/etrice/download.php">Downloads</a></li>

 <li><a href="https://git.eclipse.org/c/etrice/org.eclipse.etrice.git/">Git repository</a></li>

 </ul>
 </div><!--/.nav-collapse -->
 </div>
 </nav>


 <div class="container">
 <div class="row">
 <div class="col-sm-3">
 <div id="sidebar" role="navigation">
 <ul class="nav metismenu" id="sidebarMenu">
 <li><a href="introduction.html" aria-expanded="false">Introduction <span class="fa arrow"></span></a>
 <ul class="nav" aria-expanded="false">
 <li><a href="introduction.html#etrice-overview" aria-expanded="false">eTrice Overview <span class="fa arrow"></span></a>
 <ul class="nav" aria-expanded="false">
 <li><a href="introduction.html#what-is-etrice-">What is eTrice?</a></li>


 <li><a href="introduction.html#reduction-of-complexity">Reduction of Complexity</a></li>


 </ul>
 </li>


 <li><a href="introduction.html#introduction-room-language" aria-expanded="false">Introduction ROOM Language <span class="fa arrow"></span></a>
 <ul class="nav" aria-expanded="false">
 <li><a href="introduction.html#scope-of-room">Scope of ROOM</a></li>


 <li><a href="introduction.html#basic-concepts">Basic Concepts</a></li>


 <li><a href="introduction.html#execution-models">Execution Models</a></li>


 </ul>
 </li>


 </ul>
 </li>


 <li><a href="tutorials.html" aria-expanded="false">Tutorials <span class="fa arrow"></span></a>
 <ul class="nav" aria-expanded="false">
 <li><a href="tutorials.html#working-with-the-tutorials">Working with the tutorials</a></li>


 <li><a href="tutorials.html#getting-started-c">Getting Started C</a></li>


 <li><a href="tutorials.html#getting-started-c-">Getting Started C++</a></li>


 <li><a href="tutorials.html#getting-started-java">Getting Started Java</a></li>


 <li><a href="tutorials.html#tutorial-ping-pong-java-c-and-c-" aria-expanded="false">Tutorial Ping Pong Java, C and C++ <span class="fa arrow"></span></a>
 <ul class="nav" aria-expanded="false">
 <li><a href="tutorials.html#scope">Scope</a></li>


 <li><a href="tutorials.html#create-the-structure">Create the structure</a></li>


 <li><a href="tutorials.html#implement-the-behavior">Implement the Behavior</a></li>


 <li><a href="tutorials.html#summary">Summary</a></li>


 </ul>
 </li>


 <li><a href="tutorials.html#troubleshooting">Troubleshooting</a></li>


 </ul>
 </li>


 <li><a href="standalone-generators.html">Standalone Generators</a></li>


 <li><a href="examples.html" aria-expanded="false">Examples <span class="fa arrow"></span></a>
 <ul class="nav" aria-expanded="false">
 <li><a href="examples.html#the-c-examples-project" aria-expanded="false">The C examples project <span class="fa arrow"></span></a>
 <ul class="nav" aria-expanded="false">
 <li><a href="examples.html#traffic-light-step-1">Traffic light - step 1</a></li>


 <li><a href="examples.html#traffic-light-step-2">Traffic light - step 2</a></li>


 <li><a href="examples.html#traffic-light-step-3">Traffic light - step 3</a></li>


 <li><a href="examples.html#traffic-light-step-4">Traffic light - step 4</a></li>


 <li><a href="examples.html#features">Features</a></li>


 </ul>
 </li>


 <li><a href="examples.html#the-java-examples-project" aria-expanded="false">The Java examples project <span class="fa arrow"></span></a>
 <ul class="nav" aria-expanded="false">
 <li><a href="examples.html#dynamic-actors-1">Dynamic Actors 1</a></li>


 <li><a href="examples.html#dynamic-actors-2">Dynamic Actors 2</a></li>


 <li><a href="examples.html#dynamic-actors-3">Dynamic Actors 3</a></li>


 <li><a href="examples.html#dynamic-actors-4">Dynamic Actors 4</a></li>


 <li><a href="examples.html#dynamic-actors-5">Dynamic Actors 5</a></li>


 <li><a href="examples.html#dynamic-actors-6">Dynamic Actors 6</a></li>


 <li><a href="examples.html#dynamic-actors-7">Dynamic Actors 7</a></li>


 <li><a href="examples.html#dynamic-actors-8">Dynamic Actors 8</a></li>


 <li><a href="examples.html#dynamic-actors-9">Dynamic Actors 9</a></li>


 </ul>
 </li>


 </ul>
 </li>


 <li><a href="room-concepts.html" aria-expanded="false">ROOM Concepts <span class="fa arrow"></span></a>
 <ul class="nav" aria-expanded="false">
 <li><a href="room-concepts.html#actors">Actors</a></li>


 <li><a href="room-concepts.html#protocols">Protocols</a></li>


 <li><a href="room-concepts.html#ports">Ports</a></li>


 <li><a href="room-concepts.html#dataclass">DataClass</a></li>


 <li><a href="room-concepts.html#layering">Layering</a></li>


 <li><a href="room-concepts.html#finite-state-machines">Finite State Machines</a></li>


 </ul>
 </li>


 <li><a href="etrice-features.html" aria-expanded="false">eTrice Features <span class="fa arrow"></span></a>
 <ul class="nav" aria-expanded="false">
 <li><a href="etrice-features.html#model-navigation" aria-expanded="false">Model Navigation <span class="fa arrow"></span></a>
 <ul class="nav" aria-expanded="false">
 <li><a href="etrice-features.html#from-model-to-behavior-to-structure">From Model to Behavior to Structure</a></li>


 <li><a href="etrice-features.html#model-navigation">Model Navigation</a></li>


 <li><a href="etrice-features.html#navigating-behavior-diagrams">Navigating Behavior Diagrams</a></li>


 <li><a href="etrice-features.html#navigating-structure-diagrams">Navigating Structure Diagrams</a></li>


 </ul>
 </li>


 <li><a href="etrice-features.html#etrice-java-projects" aria-expanded="false">eTrice Java Projects <span class="fa arrow"></span></a>
 <ul class="nav" aria-expanded="false">
 <li><a href="etrice-features.html#eclipse-jdt-build">Eclipse JDT Build</a></li>


 </ul>
 </li>


 <li><a href="etrice-features.html#automatic-diagram-layout-with-kieler" aria-expanded="false">Automatic Diagram Layout with KIELER <span class="fa arrow"></span></a>
 <ul class="nav" aria-expanded="false">
 <li><a href="etrice-features.html#overview">Overview</a></li>


 <li><a href="etrice-features.html#performing-automatic-layout">Performing Automatic Layout</a></li>


 <li><a href="etrice-features.html#layout-options">Layout Options</a></li>


 <li><a href="etrice-features.html#configuring-layout-options">Configuring Layout Options</a></li>


 <li><a href="etrice-features.html#special-layout-options">Special Layout Options</a></li>


 <li><a href="etrice-features.html#further-references">Further References</a></li>


 </ul>
 </li>


 <li><a href="etrice-features.html#annotations" aria-expanded="false">Annotations <span class="fa arrow"></span></a>
 <ul class="nav" aria-expanded="false">
 <li><a href="etrice-features.html#annotation-type-definitions">Annotation Type Definitions</a></li>


 <li><a href="etrice-features.html#usage-and-effect-of-the-pre-defined-annotations">Usage and Effect of the Pre-defined Annotations</a></li>


 </ul>
 </li>


 <li><a href="etrice-features.html#enumerations">Enumerations</a></li>


 <li><a href="etrice-features.html#etrice-models-and-their-relations" aria-expanded="false">eTrice Models and Their Relations <span class="fa arrow"></span></a>
 <ul class="nav" aria-expanded="false">
 <li><a href="etrice-features.html#the-room-model">The ROOM Model</a></li>


 <li><a href="etrice-features.html#the-config-model">The Config Model</a></li>


 <li><a href="etrice-features.html#the-physical-model">The Physical Model</a></li>


 <li><a href="etrice-features.html#the-mapping-model">The Mapping Model</a></li>


 </ul>
 </li>


 <li><a href="etrice-features.html#interface-contracts" aria-expanded="false">Interface Contracts <span class="fa arrow"></span></a>
 <ul class="nav" aria-expanded="false">
 <li><a href="etrice-features.html#defining-contracts">Defining Contracts</a></li>


 <li><a href="etrice-features.html#contract-monitor-generation">Contract Monitor Generation</a></li>


 </ul>
 </li>


 <li><a href="etrice-features.html#interrupt-events">Interrupt Events</a></li>


 </ul>
 </li>


 <li><a href="feature-reference.html" aria-expanded="false">Feature Reference <span class="fa arrow"></span></a>
 <ul class="nav" aria-expanded="false">
 <li><a href="feature-reference.html#roomlanguage" aria-expanded="false">ROOMLanguage <span class="fa arrow"></span></a>
 <ul class="nav" aria-expanded="false">
 <li><a href="feature-reference.html#configmodel">ConfigModel</a></li>


 <li><a href="feature-reference.html#logicalmodel" aria-expanded="false">LogicalModel <span class="fa arrow"></span></a>
 <ul class="nav" aria-expanded="false">
 <li><a href="feature-reference.html#actorclass">ActorClass</a></li>


 <li><a href="feature-reference.html#actorref">ActorRef</a></li>


 <li><a href="feature-reference.html#annotation">Annotation</a></li>


 <li><a href="feature-reference.html#annotationtype">AnnotationType</a></li>


 <li><a href="feature-reference.html#attribute">Attribute</a></li>


 <li><a href="feature-reference.html#binding">Binding</a></li>


 <li><a href="feature-reference.html#cpbranchtransition">CPBranchTransition</a></li>


 <li><a href="feature-reference.html#choicepoint">ChoicePoint</a></li>


 <li><a href="feature-reference.html#communicationtype">CommunicationType</a></li>


 <li><a href="feature-reference.html#continuationtransition">ContinuationTransition</a></li>


 <li><a href="feature-reference.html#dataclass">DataClass</a></li>


 <li><a href="feature-reference.html#datatype">DataType</a></li>


 <li><a href="feature-reference.html#entrypoint">EntryPoint</a></li>


 <li><a href="feature-reference.html#enumeration">Enumeration</a></li>


 <li><a href="feature-reference.html#executiontype">ExecutionType</a></li>


 <li><a href="feature-reference.html#exitpoint">ExitPoint</a></li>


 <li><a href="feature-reference.html#externalendport">ExternalEndPort</a></li>


 <li><a href="feature-reference.html#externaltype">ExternalType</a></li>


 <li><a href="feature-reference.html#inheritance">Inheritance</a></li>


 <li><a href="feature-reference.html#initialtransition">InitialTransition</a></li>


 <li><a href="feature-reference.html#internalendport">InternalEndPort</a></li>


 <li><a href="feature-reference.html#layerconnection">LayerConnection</a></li>


 <li><a href="feature-reference.html#logicalsystem">LogicalSystem</a></li>


 <li><a href="feature-reference.html#operation">Operation</a></li>


 <li><a href="feature-reference.html#port">Port</a></li>


 <li><a href="feature-reference.html#portclass">PortClass</a></li>


 <li><a href="feature-reference.html#primitivetype">PrimitiveType</a></li>


 <li><a href="feature-reference.html#protocolclass">ProtocolClass</a></li>


 <li><a href="feature-reference.html#refinedstate">RefinedState</a></li>


 <li><a href="feature-reference.html#relayport">RelayPort</a></li>


 <li><a href="feature-reference.html#replication">Replication</a></li>


 <li><a href="feature-reference.html#sap">SAP</a></li>


 <li><a href="feature-reference.html#spp">SPP</a></li>


 <li><a href="feature-reference.html#serviceimplementation">ServiceImplementation</a></li>


 <li><a href="feature-reference.html#simplestate">SimpleState</a></li>


 <li><a href="feature-reference.html#state">State</a></li>


 <li><a href="feature-reference.html#stategraphnode">StateGraphNode</a></li>


 <li><a href="feature-reference.html#statemachine">StateMachine</a></li>


 <li><a href="feature-reference.html#subsystemclass">SubSystemClass</a></li>


 <li><a href="feature-reference.html#subsystemref">SubSystemRef</a></li>


 <li><a href="feature-reference.html#trpoint">TrPoint</a></li>


 <li><a href="feature-reference.html#transition">Transition</a></li>


 <li><a href="feature-reference.html#transitionpoint">TransitionPoint</a></li>


 <li><a href="feature-reference.html#triggeredtransition">TriggeredTransition</a></li>


 </ul>
 </li>


 <li><a href="feature-reference.html#mappingmodel">MappingModel</a></li>


 <li><a href="feature-reference.html#physicalmodel">PhysicalModel</a></li>


 </ul>
 </li>


 <li><a href="feature-reference.html#modeleditors" aria-expanded="false">ModelEditors <span class="fa arrow"></span></a>
 <ul class="nav" aria-expanded="false">
 <li><a href="feature-reference.html#graphicalbehavioreditor">GraphicalBehaviorEditor</a></li>


 <li><a href="feature-reference.html#graphicalstructureeditor" aria-expanded="false">GraphicalStructureEditor <span class="fa arrow"></span></a>
 <ul class="nav" aria-expanded="false">
 <li><a href="feature-reference.html#actorrefpropertydialog">ActorRefPropertyDialog</a></li>


 <li><a href="feature-reference.html#portpropertydialog">PortPropertyDialog</a></li>


 <li><a href="feature-reference.html#spppropertydialog">SPPPropertyDialog</a></li>


 <li><a href="feature-reference.html#structureeditorpalette">StructureEditorPalette</a></li>


 </ul>
 </li>


 <li><a href="feature-reference.html#textualroomeditor" aria-expanded="false">TextualROOMEditor <span class="fa arrow"></span></a>
 <ul class="nav" aria-expanded="false">
 <li><a href="feature-reference.html#outlineview">OutlineView</a></li>


 </ul>
 </li>


 </ul>
 </li>


 <li><a href="feature-reference.html#codegenerators" aria-expanded="false">CodeGenerators <span class="fa arrow"></span></a>
 <ul class="nav" aria-expanded="false">
 <li><a href="feature-reference.html#ccodegenerator">CCodeGenerator</a></li>


 <li><a href="feature-reference.html#cppcodegenerator">CPPCodeGenerator</a></li>


 <li><a href="feature-reference.html#generationoptions">GenerationOptions</a></li>


 <li><a href="feature-reference.html#javacodegenerator">JavaCodeGenerator</a></li>


 <li><a href="feature-reference.html#msclogging">MSCLogging</a></li>


 </ul>
 </li>


 </ul>
 </li>


 <li><a href="Dave-Integration.html" aria-expanded="false">Dave Integration <span class="fa arrow"></span></a>
 <ul class="nav" aria-expanded="false">
 <li><a href="Dave-Integration.html#dave-etrice-toolchain-tutorial" aria-expanded="false">DAVE-eTrice Toolchain Tutorial <span class="fa arrow"></span></a>
 <ul class="nav" aria-expanded="false">
 <li><a href="Dave-Integration.html#introduction">Introduction</a></li>


 <li><a href="Dave-Integration.html#getting-started-without-operating-system">Getting Started without Operating System</a></li>


 <li><a href="Dave-Integration.html#getting-started-with-freertos">Getting Started with FreeRTOS</a></li>


 </ul>
 </li>


 </ul>
 </li>


 <li><a href="ResourceRequirements.html">Resource Requirements</a></li>


 <li><a href="developers-reference.html" aria-expanded="false">Developer's Reference <span class="fa arrow"></span></a>
 <ul class="nav" aria-expanded="false">
 <li><a href="developers-reference.html#etrice-tool-developer-s-reference" aria-expanded="false">eTrice Tool Developer’s Reference <span class="fa arrow"></span></a>
 <ul class="nav" aria-expanded="false">
 <li><a href="developers-reference.html#architecture" aria-expanded="false">Architecture <span class="fa arrow"></span></a>
 <ul class="nav" aria-expanded="false">
 <li><a href="developers-reference.html#editor-and-generator-components">Editor and Generator Components</a></li>


 <li><a href="developers-reference.html#the-abstract-finite-state-machine-concept">The Abstract Finite State Machine Concept</a></li>


 <li><a href="developers-reference.html#runtimes">Runtimes</a></li>


 <li><a href="developers-reference.html#unit-tests">Unit Tests</a></li>


 </ul>
 </li>


 <li><a href="developers-reference.html#component-overview" aria-expanded="false">Component Overview <span class="fa arrow"></span></a>
 <ul class="nav" aria-expanded="false">
 <li><a href="developers-reference.html#room-language-overview">Room Language Overview</a></li>


 <li><a href="developers-reference.html#config-language-overview">Config Language Overview</a></li>


 <li><a href="developers-reference.html#aggregation-layer-overview">Aggregation Layer Overview</a></li>


 <li><a href="developers-reference.html#generator-overview">Generator Overview</a></li>


 </ul>
 </li>


 </ul>
 </li>


 </ul>
 </li>


 <li><a href="release-notes.html" aria-expanded="false">Release Notes <span class="fa arrow"></span></a>
 <ul class="nav" aria-expanded="false">
 <li><a href="release-notes.html#2-0-0-migration">2.0.0 Migration</a></li>


 </ul>
 </li>


 </ul>
 </div>
 </div>
 <span class="version pull-right">version 3.x</span></p>
 <div class="col-sm-9">
 <h1><a href="#standalone-generators" name="standalone-generators"></a>Standalone Generators</h1>
 <p>The eTrice generators can be called from the command line. This is useful e.g. if they should participate in a build process driven by command line tools like make.</p>
 <p>The generators are distributed as self contained jars and can be called using</p>
 <p><code>java -jar &lt;the generator.jar&gt; [arguments]</code>.</p>
 <p>The options for the Java generator are</p>
 <pre><code>org.eclipse.etrice.generator.java.Main [-saveGenModel &lt;genmodel path&gt;] [-genDocu] [-lib]
 [-noexit] [-saveGenModel &lt;genmodel path&gt;] [-inc] [-genDir &lt;generation directory&gt;]
 [-genInfoDir &lt;generation info directory&gt;] [-genDocDir &lt;gen documentation directory&gt;]
 [-debug] [-msc_instr] [-gen_as_verbose] [-help] [-persistable]
 [-storeDataObj] &lt;list of model file paths&gt;

       &lt;list of model file paths&gt;         # model file paths may be specified as
                                          # e.g. C:\path\to\model\mymodel.room
       -genDocu                           # if specified documentation is created
       -lib                               # if specified all classes are generated
                                          # and no instances
       -noexit                            # if specified the JVM is not exited
       -saveGenModel &lt;genmodel path&gt;      # if specified the generator model will
                                          # be saved to this location
       -inc                               # if specified the generation is incremental
       -genDir &lt;generation directory&gt;     # the directory for generated files
       -genInfoDir &lt;generation info dir&gt;  # the directory for generated info files
       -genDocDir &lt;gen documentation dir&gt; # the directory for generated documentation files
       -debug                             # if specified create debug output
       -msc_instr                         # generate instrumentation for MSC generation
       -gen_as_verbose                    # generate instrumentation for verbose console output
       -help                              # display this help text

       -persistable                       # if specified make actor classes persistable
       -storeDataObj                      # if specified equip actor classes with
                                          # store/restore using POJOs
 </code></pre>
 <p>The options for the C generator are</p>
 <pre><code>org.eclipse.etrice.generator.c.Main [-saveGenModel &lt;genmodel path&gt;] [-genDocu] [-lib]
 [-noexit] [-saveGenModel &lt;genmodel path&gt;] [-inc] [-genDir &lt;generation directory&gt;]
 [-genInfoDir &lt;generation info directory&gt;] [-genDocDir &lt;gen documentation directory&gt;]
 [-debug] [-msc_instr] [-gen_as_verbose] [-help] [-persistable]
 [-storeDataObj] &lt;list of model file paths&gt;

       &lt;list of model file paths&gt;         # model file paths may be specified as
                                          # e.g. C:\path\to\model\mymodel.room
       -genDocu                           # if specified documentation is created
       -lib                               # if specified all classes are generated
                                          # and no instances
       -noexit                            # if specified the JVM is not exited
       -saveGenModel &lt;genmodel path&gt;      # if specified the generator model will
                                          # be saved to this location
       -inc                               # if specified the generation is incremental
       -genDir &lt;generation directory&gt;     # the directory for generated files
       -genInfoDir &lt;generation info dir&gt;  # the directory for generated info files
       -genDocDir &lt;gen documentation dir&gt; # the directory for generated documentation files
       -debug                             # if specified create debug output
       -msc_instr                         # generate instrumentation for MSC generation
       -gen_as_verbose                    # generate instrumentation for verbose console output
       -help                              # display this help text
 </code></pre>
 <hr>
 <p><a href="#navbar">back to top</a> <span class="version pull-right">version 3.x</span></p>
 </div>
 </div>
 </div>

 <!-- jQuery (necessary for Bootstrap's JavaScript plugins) -->
 <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
 <!-- Include all compiled plugins (below), or include individual files as needed -->
 <script src="js/bootstrap.min.js"></script>
 <script src="js/metisMenu.min.js"></script>
 <script src="js/prettify.js"></script>
 <script src="js/custom.js"></script>
 </body>
 </html>