diff options
Diffstat (limited to 'plugins/org.eclipse.etrice.doc/html/etrice-docse6.html')
| -rw-r--r-- | plugins/org.eclipse.etrice.doc/html/etrice-docse6.html | 782 |
1 files changed, 311 insertions, 471 deletions
diff --git a/plugins/org.eclipse.etrice.doc/html/etrice-docse6.html b/plugins/org.eclipse.etrice.doc/html/etrice-docse6.html index 8e301046d..fc7b1a647 100644 --- a/plugins/org.eclipse.etrice.doc/html/etrice-docse6.html +++ b/plugins/org.eclipse.etrice.doc/html/etrice-docse6.html @@ -1,471 +1,311 @@ -<?xml version="1.0" encoding="iso-8859-1" ?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<!--http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd-->
-<html xmlns="http://www.w3.org/1999/xhtml"
->
-<head><title>Tutorial Blinky (Java)</title>
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-<meta name="generator" content="TeX4ht (http://www.cse.ohio-state.edu/~gurari/TeX4ht/)" />
-<meta name="originator" content="TeX4ht (http://www.cse.ohio-state.edu/~gurari/TeX4ht/)" />
-<!-- xhtml,3,next,html -->
-<meta name="src" content="etrice-doc.tex" />
-<meta name="date" content="2013-06-21 12:20:00" />
-<link rel="stylesheet" type="text/css" href="etrice-doc.css" />
-</head><body
->
-<!--l. 1--><div class="crosslinks"><p class="noindent">[<a
-href="etrice-docse7.html" >next</a>] [<a
-href="etrice-docse5.html" >prev</a>] [<a
-href="etrice-docse5.html#tailetrice-docse5.html" >prev-tail</a>] [<a
-href="#tailetrice-docse6.html">tail</a>] [<a
-href="etrice-docch2.html#etrice-docse6.html" >up</a>] </p></div>
-<h3 class="sectionHead"><span class="titlemark">2.4 </span> <a
- id="x10-350002.4"></a>Tutorial Blinky (Java)</h3>
-<!--l. 3--><p class="noindent" >
-</p>
-<h4 class="subsectionHead"><span class="titlemark">2.4.1 </span> <a
- id="x10-360002.4.1"></a>Scope</h4>
-<!--l. 5--><p class="noindent" >This tutorial describes how to use the <span
-class="ec-lmsso-10">TimingService</span>, how to combine a generated model with manual code
-and how to model a hierarchical state machine. The idea of the tutorial is to switch a LED on and off. The
-behavior of the LED should be: blinking in a one second interval for 5 seconds, stop blinking for 5 seconds,
-blinking, stop,... For this exercise we will use a little GUI class that will be used in more sophisticated tutorials
-too. The GUI simulates a pedestrian traffic crossing. For now, just a simple LED simulation will be used from
-the GUI.
-</p><!--l. 13--><p class="noindent" >After the exercise is created you must copy the GUI to your src directory (see below).
-</p><!--l. 15--><p class="noindent" >The package contains four java classes which implements a small window with a 3-light traffic light which
-simulates the signals for the car traffic and a 2-light traffic light which simulates the pedestrian
-signals.
-</p><!--l. 19--><p class="noindent" >The GUI looks like this:
-</p><!--l. 21--><p class="noindent" ><img
-src="images/020-Blinky08.png" alt="PIC"
- />
-</p><!--l. 24--><p class="noindent" >Within this tutorial we will just toggle the yellow light.
-</p><!--l. 26--><p class="noindent" >You will perform the following steps:
-</p><!--l. 28--><p class="noindent" >
- </p><ol class="enumerate1" >
- <li
- class="enumerate" id="x10-36002x1">create a new model from scratch
- </li>
- <li
- class="enumerate" id="x10-36004x2">define a protocol
- </li>
- <li
- class="enumerate" id="x10-36006x3">create an actor structure
- </li>
- <li
- class="enumerate" id="x10-36008x4">create a hierarchical state machine
- </li>
- <li
- class="enumerate" id="x10-36010x5">use the predefined <span
-class="ec-lmsso-10">TimingService</span>
- </li>
- <li
- class="enumerate" id="x10-36012x6">combine manual code with generated code
- </li>
- <li
- class="enumerate" id="x10-36014x7">build and run the model
- </li>
- <li
- class="enumerate" id="x10-36016x8">open the message sequence chart</li></ol>
-
-
-<!--l. 39--><p class="noindent" >
-</p>
-<h4 class="subsectionHead"><span class="titlemark">2.4.2 </span> <a
- id="x10-370002.4.2"></a>Create a new model from scratch</h4>
-<!--l. 41--><p class="noindent" >Remember the exercise <span
-class="ec-lmsso-10">HelloWorld</span>. Create a new eTrice project and name it <span
-class="ec-lmsso-10">Blinky</span>.
-</p><!--l. 44--><p class="noindent" >To use the GUI please copy the package <span
-class="ec-lmsso-10">org.eclipse.etrice.tutorials.PedLightGUI </span>from <span
-class="ec-lmsso-10">org.eclipse.etrice.tutorials/src</span>
-to your <span
-class="ec-lmsso-10">src </span>directory <span
-class="ec-lmsso-10">Blinky/src</span>. For this tutorial you must remove the error markers by editing the file
-<span
-class="ec-lmsso-10">PedestrianLightWndNoTcp.java</span>. Appropriate comments are provided to remove the error markers for this
-turorial.
-</p><!--l. 49--><p class="noindent" >Open the <span
-class="ec-lmsso-10">Blinky.room </span>file and copy the following code into the file or use content assist to create the
-model.
-
-
-</p>
-<div class="verbatim" id="verbatim-2">
-RoomModel Blinky {
- <br />
- <br />    LogicalSystem System_Blinky {
- <br />        SubSystemRef subsystem : SubSystem_Blinky
- <br />    }
- <br />
- <br />    SubSystemClass SubSystem_Blinky {
- <br />        ActorRef application : BlinkyTop
- <br />    }
- <br />
- <br />    ActorClass BlinkyTop {
- <br />    }
- <br />}
-</div>
-<!--l. 66--><p class="nopar" >
-</p><!--l. 68--><p class="noindent" >
-</p>
-<h4 class="subsectionHead"><span class="titlemark">2.4.3 </span> <a
- id="x10-380002.4.3"></a>Add two additional actor classes</h4>
-<!--l. 70--><p class="noindent" >Position the cursor outside any class definition and right click the mouse within the editor window. From the
-context menu select <span
-class="ec-lmsso-10">Content Assist</span>
-</p><!--l. 73--><p class="noindent" ><img
-src="images/020-Blinky02.png" alt="PIC"
- />
-</p><!--l. 76--><p class="noindent" >Select <span
-class="ec-lmsso-10">ActorClass - actor class skeleton </span>and name it <span
-class="ec-lmsso-10">Blinky</span>.
-</p><!--l. 78--><p class="noindent" ><img
-src="images/020-Blinky01.png" alt="PIC"
- />
-</p><!--l. 81--><p class="noindent" >Repeat the described procedure and name the new actor <span
-class="ec-lmsso-10">BlinkyController</span>.
-</p><!--l. 83--><p class="noindent" >With Ctrl+Shift+F you can beautify the model code.
-</p><!--l. 85--><p class="noindent" >Save the model and visit the outline view.
-</p><!--l. 87--><p class="noindent" >
-</p>
-<h4 class="subsectionHead"><span class="titlemark">2.4.4 </span> <a
- id="x10-390002.4.4"></a>Create a new protocol</h4>
-<!--l. 89--><p class="noindent" >With the help of <span
-class="ec-lmsso-10">Content Assist </span>create a <span
-class="ec-lmsso-10">ProtocolClass </span>and name it <span
-class="ec-lmsso-10">BlinkyControlProtocol</span>. Inside the
-brackets use the <span
-class="ec-lmsso-10">Content Assist </span>(CTRL+Space) to create two incoming messages called <span
-class="ec-lmsso-10">start </span>and
-<span
-class="ec-lmsso-10">stop</span>.
-</p><!--l. 94--><p class="noindent" >The resulting code should look like this:
-</p><!--l. 96--><p class="noindent" ><img
-src="images/020-Blinky03.png" alt="PIC"
- />
-</p><!--l. 99--><p class="noindent" >With Ctrl-Shift+F or selecting <span
-class="ec-lmsso-10">Format </span>from the context menu you can format the text. Note that all elements
-are displayed in the outline view.
-
-
-</p><!--l. 102--><p class="noindent" >
-</p>
-<h4 class="subsectionHead"><span class="titlemark">2.4.5 </span> <a
- id="x10-400002.4.5"></a>Import the Timing Service</h4>
-<!--l. 104--><p class="noindent" >Switching on and off the LED is timing controlled. The timing service is provided from the model library and
-must be imported before it can be used from the model.
-</p><!--l. 107--><p class="noindent" >This is the first time you use an element from the modellib. Make sure that your Java Build Path has the
-appropriate entry to the modellib. Otherwise the jave code, which will be generated from the modellib,
-can not be referenced. (right click to <span
-class="ec-lmsso-10">Blinky </span>and select properties. Select the <span
-class="ec-lmsso-10">Java Build Path</span>
-tab)
-</p><!--l. 112--><p class="noindent" ><img
-src="images/020-Blinky16.png" alt="PIC"
- />
-</p><!--l. 115--><p class="noindent" >After the build path is set up return to the model and navigate the cursor at the beginning of the model and
-import the timing service:
-
-
-</p>
-<div class="verbatim" id="verbatim-3">
-RoomModel Blinky {
- <br />
- <br />    import room.basic.service.timing.* from
- <br />"../../org.eclipse.etrice.modellib/models/TimingService.room"
- <br />
- <br />    LogicalSystem System_Blinky {
- <br />        SubSystemRef subsystem: SubSystem\_Blinky
- <br />    }
- <br />}
- <br />...
-</div>
-<!--l. 130--><p class="nopar" >
-</p><!--l. 133--><p class="noindent" >Make sure that the path fits to your folder structure. The original tutorial code is different due to the folder
-structure.
-</p><!--l. 136--><p class="noindent" >Now it can be used within the model. Right click to <span
-class="ec-lmssbx-10">SubSystem_Blinky </span>within the outline view.
-Select <span
-class="ec-lmsso-10">Edit Structure</span>. The <span
-class="ec-lmsso-10">application </span>is already referenced in the subsystem. Drag and Drop an
-<span
-class="ec-lmsso-10">ActorRef </span>to the <span
-class="ec-lmssbx-10">SubSystem_Blinky </span>and name it <span
-class="ec-lmsso-10">timingService</span>. From the actor class drop down list
-select <span
-class="ec-lmsso-10">room.basic.service.timing.ATimingService</span>. Draw a <span
-class="ec-lmsso-10">LayerConnection </span>from <span
-class="ec-lmsso-10">application </span>to
-each service provision point (SPP) of the <span
-class="ec-lmsso-10">timingService</span>. The resulting structure should look like
-this:
-</p><!--l. 143--><p class="noindent" ><img
-src="images/020-Blinky06.png" alt="PIC"
- />
-</p><!--l. 146--><p class="noindent" >The current version of eTrice does not provide a graphical element for a service access point
-(SAP). Therefore the SAPs to access the timing service must be added in the .room file. Open the
-<span
-class="ec-lmsso-10">Blinky.room </span>file and navigate to the <span
-class="ec-lmsso-10">Blinky </span>actor. Add the following line to the structure of the
-actor:
-
-
-</p>
-<div class="verbatim" id="verbatim-4">
-SAP timer: room.basic.service.timing.PTimeout 
-</div>
-<!--l. 151--><p class="nopar" >
-</p><!--l. 153--><p class="noindent" >Do the same thing for <span
-class="ec-lmsso-10">BlinkyController</span>.
-</p><!--l. 155--><p class="noindent" >The resulting code should look like this:
-</p><!--l. 157--><p class="noindent" ><img
-src="images/020-Blinky07.png" alt="PIC"
- />
-</p><!--l. 161--><p class="noindent" >
-</p>
-<h4 class="subsectionHead"><span class="titlemark">2.4.6 </span> <a
- id="x10-410002.4.6"></a>Finish the model structure</h4>
-<!--l. 163--><p class="noindent" >From the outline view right click to <span
-class="ec-lmsso-10">Blinky </span>and select <span
-class="ec-lmsso-10">Edit Structure</span>. Drag and Drop an <span
-class="ec-lmsso-10">Interface Port </span>to the
-boarder of the <span
-class="ec-lmsso-10">Blinky </span>actor. Note that an interface port is not possible inside the actor. Name the port
-<span
-class="ec-lmsso-10">ControlPort </span>and select <span
-class="ec-lmsso-10">BlinkyControlProtocol </span>from the drop down list. Uncheck <span
-class="ec-lmsso-10">Conjugated </span>and <span
-class="ec-lmsso-10">Is Relay Port</span>.
-Click <span
-class="ec-lmsso-10">ok</span>. The resulting structure should look like this:
-</p><!--l. 169--><p class="noindent" ><img
-src="images/020-Blinky04.png" alt="PIC"
- />
-</p><!--l. 172--><p class="noindent" >Repeat the above steps for the <span
-class="ec-lmsso-10">BlinkyController</span>. Make the port <span
-class="ec-lmsso-10">Conjugated</span>
-</p><!--l. 174--><p class="noindent" >Keep in mind that the protocol defines <span
-class="ec-lmsso-10">start </span>and <span
-class="ec-lmsso-10">stop </span>as incoming messages. <span
-class="ec-lmsso-10">Blinky </span>receives this messages and
-therefore <span
-class="ec-lmsso-10">Blinky</span>’s <span
-class="ec-lmsso-10">ControlPort </span>must be a regular port and <span
-class="ec-lmsso-10">BlinkyController</span>’s <span
-class="ec-lmsso-10">ControlPort </span>must be a
-conjugated port.
-</p><!--l. 179--><p class="noindent" >From the outline view right click <span
-class="ec-lmsso-10">BlinkyTop </span>and select <span
-class="ec-lmsso-10">Edit Structure</span>.
-</p><!--l. 181--><p class="noindent" >Drag and Drop an <span
-class="ec-lmsso-10">ActorRef </span>inside the <span
-class="ec-lmsso-10">BlinkyTop </span>actor. Name it <span
-class="ec-lmsso-10">blinky</span>. From the actor class drop down list
-select <span
-class="ec-lmsso-10">Blinky</span>. Do the same for <span
-class="ec-lmsso-10">controller</span>. Connect the ports via the binding tool. The resulting structure
-should look like this:
-</p><!--l. 185--><p class="noindent" ><img
-src="images/020-Blinky05.png" alt="PIC"
- />
-</p><!--l. 188--><p class="noindent" >
-</p>
-<h4 class="subsectionHead"><span class="titlemark">2.4.7 </span> <a
- id="x10-420002.4.7"></a>Implement the Behavior</h4>
-<!--l. 190--><p class="noindent" >The application should switch on and off the LED for 5 seconds in a 1 second interval, then stop blinking for 5
-seconds and start again. To implement this behavior we will implement two FSMs. One for the 1
-second interval and one for the 5 second interval. The 1 second blinking should be implemented in
-<span
-class="ec-lmsso-10">Blinky</span>. The 5 second interval should be implemented in <span
-class="ec-lmsso-10">BlinkyController</span>. First implement the
-Controller.
-</p><!--l. 196--><p class="noindent" >Right click to <span
-class="ec-lmsso-10">BlinkyController </span>and select <span
-class="ec-lmsso-10">Edit Behavior</span>. Drag and Drop the <span
-class="ec-lmsso-10">Initial Point </span>and two <span
-class="ec-lmsso-10">States </span>into
-the top state. Name the states <span
-class="ec-lmsso-10">on </span>and <span
-class="ec-lmsso-10">off</span>. Use the <span
-class="ec-lmsso-10">Transition </span>tool to draw transitions from <span
-class="ec-lmsso-10">init </span>to <span
-class="ec-lmsso-10">on </span>from <span
-class="ec-lmsso-10">on</span>
-to <span
-class="ec-lmsso-10">off </span>and from <span
-class="ec-lmsso-10">off </span>to <span
-class="ec-lmsso-10">on</span>.
-</p><!--l. 202--><p class="noindent" >Open the transition dialog by double click the arrow to specify the trigger event and the action code of each
-transition. Note that the initial transition does not have a trigger event.
-</p><!--l. 205--><p class="noindent" >The transition dialog should look like this:
-</p><!--l. 207--><p class="noindent" ><img
-src="images/020-Blinky09.png" alt="PIC"
- />
-
-
-</p><!--l. 210--><p class="noindent" >The defined ports will be generated as a member attribute of the actor class from type of the attached
-protocol. So, to send e message you must state <span
-class="ec-lmsso-10">port.message(param);</span>. In this example <span
-class="ec-lmsso-10">ControlPort.start()</span>
-sends the <span
-class="ec-lmsso-10">start </span>message via the <span
-class="ec-lmsso-10">ControlPort </span>to the outside world. Assuming that <span
-class="ec-lmsso-10">Blinky </span>is connected to this
-port, the message will start the one second blinking FSM. It is the same thing with the <span
-class="ec-lmsso-10">timer</span>. The SAP is
-also a port and follows the same rules. So it is clear that <span
-class="ec-lmsso-10">timer.Start(5000); </span>will send the <span
-class="ec-lmsso-10">Start</span>
-message to the timing service. The timing service will send a <span
-class="ec-lmsso-10">timeoutTick </span>message back after
-5000ms.
-</p><!--l. 218--><p class="noindent" >Within each transition the timer will be restarted and the appropriate message will be sent via the
-<span
-class="ec-lmsso-10">ControlPort</span>.
-</p><!--l. 221--><p class="noindent" >The resulting state machine should look like this: (Note that the arrows peak changes if the transition contains
-action code.)
-</p><!--l. 224--><p class="noindent" ><img
-src="images/020-Blinky10.png" alt="PIC"
- />
-</p><!--l. 227--><p class="noindent" >Save the diagram and inspect the <span
-class="ec-lmsso-10">Blinky.room </span>file. The <span
-class="ec-lmsso-10">BlinkyController </span>should look like this:
-</p><!--l. 230--><p class="noindent" ><img
-src="images/020-Blinky11.png" alt="PIC"
- />
-</p><!--l. 233--><p class="noindent" >Now we will implement <span
-class="ec-lmsso-10">Blinky</span>. Due to the fact that <span
-class="ec-lmsso-10">Blinky </span>interacts with the GUI class a view things must to
-be done in the model file.
-</p><!--l. 236--><p class="noindent" >Double click <span
-class="ec-lmsso-10">Blinky </span>in the outline view to navigate to <span
-class="ec-lmsso-10">Blinky </span>within the model file. Add the following code:
-(type it or simply copy it from the tutorial project)
-</p><!--l. 240--><p class="noindent" ><img
-src="images/020-Blinky12.png" alt="PIC"
- />
-</p><!--l. 243--><p class="noindent" ><span
-class="ec-lmsso-10">usercode1 </span>will be generated at the beginning of the file, outside the class definition. <span
-class="ec-lmsso-10">usercode2 </span>will
-be generated within the class definition. The code imports the GUI class and instantiates the
-window class. Attributes for the carLights and pedLights will be declared to easily access the lights
-in the state machine. The Operation <span
-class="ec-lmsso-10">destroyUser() </span>is a predefined operation that will be called
-during shutdown of the application. Within this operation, cleanup of manual coded classes can be
-done.
-</p><!--l. 250--><p class="noindent" >Now design the FSM of <span
-class="ec-lmsso-10">Blinky</span>. Remember, as the name suggested <span
-class="ec-lmsso-10">blinking </span>is a state in which the LED must
-be switched on and off. We will realize that by an hierarchical FSM in which the <span
-class="ec-lmsso-10">blinking </span>state has two sub
-states.
-</p><!--l. 254--><p class="noindent" >Open the behavior diagram of <span
-class="ec-lmsso-10">Blinky </span>by right clicking the <span
-class="ec-lmsso-10">Blinky </span>actor in the outline view. Create two states
-named <span
-class="ec-lmsso-10">blinking </span>and <span
-class="ec-lmsso-10">off</span>. Right click to <span
-class="ec-lmsso-10">blinking </span>and create a subgraph.
-</p><!--l. 258--><p class="noindent" ><img
-src="images/020-Blinky13.png" alt="PIC"
- />
-</p><!--l. 261--><p class="noindent" >Create the following state machine. The trigger events between <span
-class="ec-lmsso-10">on </span>and <span
-class="ec-lmsso-10">off </span>are the <span
-class="ec-lmsso-10">timeoutTick </span>from the <span
-class="ec-lmsso-10">timer</span>
-port.
-</p><!--l. 264--><p class="noindent" ><img
-src="images/020-Blinky14.png" alt="PIC"
- />
-</p><!--l. 267--><p class="noindent" >Create entry code for both states by right clicking the state and select <span
-class="ec-lmsso-10">Edit State...</span>
-</p><!--l. 269--><p class="noindent" >Entry code of <span
-class="ec-lmsso-10">on </span>is:
-
-
-</p>
-<div class="verbatim" id="verbatim-5">
-timer.Start(1000);
- <br />carLights.setState(TrafficLight3.YELLOW);
-</div>
-<!--l. 274--><p class="nopar" >
-</p><!--l. 277--><p class="noindent" >Entry code of <span
-class="ec-lmsso-10">off </span>is:
-
-
-</p>
-<div class="verbatim" id="verbatim-6">
-timer.Start(1000);
- <br />carLights.setState(TrafficLight3.OFF);
-</div>
-<!--l. 282--><p class="nopar" >
-</p><!--l. 284--><p class="noindent" >Navigate to the Top level state by double clicking the <span
-class="ec-lmsso-10">/blinking </span>state. Create the following state
-machine:
-</p><!--l. 287--><p class="noindent" ><img
-src="images/020-Blinky15.png" alt="PIC"
- />
-</p><!--l. 290--><p class="noindent" >The trigger event from <span
-class="ec-lmsso-10">off </span>to <span
-class="ec-lmsso-10">blinking </span>is the <span
-class="ec-lmsso-10">start </span>event from the <span
-class="ec-lmsso-10">ControlPort</span>.The trigger event from <span
-class="ec-lmsso-10">blinking</span>
-to <span
-class="ec-lmsso-10">off </span>is the <span
-class="ec-lmsso-10">stop </span>event from the <span
-class="ec-lmsso-10">ControlPort</span>. Note: The transition from <span
-class="ec-lmsso-10">blinking </span>to <span
-class="ec-lmsso-10">off </span>is a so called group
-transition. This is a outgoing transition from a super state (state with sub states) without specifying the
-concrete leave state (state without sub states). An incoming transition to a super state is called history
-transition.
-</p><!--l. 297--><p class="noindent" >Action code of the init transition is:
-
-
-</p>
-<div class="verbatim" id="verbatim-7">
-carLights = light.getCarLights();
- <br />pedLights = light.getPedLights();
- <br />carLights.setState(TrafficLight3.OFF);
- <br />pedLights.setState(TrafficLight2.OFF);
-</div>
-<!--l. 304--><p class="nopar" >
-</p><!--l. 306--><p class="noindent" >Action code from <span
-class="ec-lmsso-10">blinking </span>to <span
-class="ec-lmsso-10">off </span>is:
-
-
-</p>
-<div class="verbatim" id="verbatim-8">
-timer.Kill();
- <br />carLights.setState(TrafficLight3.OFF);
-</div>
-<!--l. 311--><p class="nopar" >
-</p><!--l. 313--><p class="noindent" >The model is complete now. You can run and debug the model as described in getting started. Have
-fun.
-</p><!--l. 315--><p class="noindent" >The complete model can be found in /org.eclipse.etrice.tutorials/model/Blinky.
-</p><!--l. 317--><p class="noindent" >
-</p>
-<h4 class="subsectionHead"><span class="titlemark">2.4.8 </span> <a
- id="x10-430002.4.8"></a>Summary</h4>
-<!--l. 319--><p class="noindent" >Run the model and take a look at the generated MSCs. Inspect the generated code to understand the runtime
-model of eTrice. Within this tutorial you have learned how to create a hierarchical FSM with group transitions
-and history transitions and you have used entry code. You are now familiar with the basic features of eTrice.
-The further tutorials will take this knowledge as a precondition.
-
-
-</p>
-<!--l. 1--><div class="crosslinks"><p class="noindent">[<a
-href="etrice-docse7.html" >next</a>] [<a
-href="etrice-docse5.html" >prev</a>] [<a
-href="etrice-docse5.html#tailetrice-docse5.html" >prev-tail</a>] [<a
-href="etrice-docse6.html" >front</a>] [<a
-href="etrice-docch2.html#etrice-docse6.html" >up</a>] </p></div>
-<!--l. 1--><p class="noindent" ><a
- id="tailetrice-docse6.html"></a> </p>
-</body></html>
+<?xml version="1.0" encoding="iso-8859-1" ?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<!--http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd--> +<html xmlns="http://www.w3.org/1999/xhtml" +> +<head><title>HelloWorld for Java</title> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> +<meta name="generator" content="TeX4ht (http://www.cse.ohio-state.edu/~gurari/TeX4ht/)" /> +<meta name="originator" content="TeX4ht (http://www.cse.ohio-state.edu/~gurari/TeX4ht/)" /> +<!-- xhtml,3,next,html --> +<meta name="src" content="etrice-doc.tex" /> +<meta name="date" content="2013-07-04 15:04:00" /> +<link rel="stylesheet" type="text/css" href="etrice-doc.css" /> +</head><body +> +<!--l. 1--><div class="crosslinks"><p class="noindent">[<a +href="etrice-docse7.html" >next</a>] [<a +href="etrice-docse5.html" >prev</a>] [<a +href="etrice-docse5.html#tailetrice-docse5.html" >prev-tail</a>] [<a +href="#tailetrice-docse6.html">tail</a>] [<a +href="etrice-docch2.html#etrice-docse6.html" >up</a>] </p></div> +<h3 class="sectionHead"><span class="titlemark">2.4 </span> <a + id="x10-310002.4"></a>HelloWorld for Java</h3> +<!--l. 3--><p class="noindent" > +</p> +<h4 class="subsectionHead"><span class="titlemark">2.4.1 </span> <a + id="x10-320002.4.1"></a>Scope</h4> +<!--l. 5--><p class="noindent" >In this tutorial you will build your first very simple eTrice model. The goal is to learn the work +flow of eTrice and to understand a few basic features of ROOM. You will perform the following +steps: +</p><!--l. 8--><p class="noindent" > + </p><ol class="enumerate1" > + <li + class="enumerate" id="x10-32002x1">create a new model from scratch + </li> + <li + class="enumerate" id="x10-32004x2">add a very simple state machine to an actor + </li> + <li + class="enumerate" id="x10-32006x3">generate the source code + </li> + <li + class="enumerate" id="x10-32008x4">run the model + </li> + <li + class="enumerate" id="x10-32010x5">open the message sequence chart</li></ol> +<!--l. 16--><p class="noindent" >Make sure that you have set up the workspace as described in <span +class="ec-lmsso-10">Setting up the workspace</span>. +</p><!--l. 18--><p class="noindent" > +</p> +<h4 class="subsectionHead"><span class="titlemark">2.4.2 </span> <a + id="x10-330002.4.2"></a>Create a new model from scratch</h4> +<!--l. 20--><p class="noindent" >The easiest way to create a new eTrice Project is to use the eclipse project wizard. From the eclipse file menu +select <span +class="ec-lmssbx-10">File->New->Project </span>and create a new eTrice project and name it <span +class="ec-lmssbx-10">HelloWorld</span>. +</p><!--l. 23--><p class="noindent" ><img +src="images/015-HelloWorld10.png" alt="PIC" + /> +</p><!--l. 26--><p class="noindent" >The wizard creates everything that is needed to create, build and run an eTrice model. The resulting project +should look like this: +</p><!--l. 29--><p class="noindent" ><img +src="images/015-HelloWorld11.png" alt="PIC" + /> +</p><!--l. 32--><p class="noindent" >Within the model directory the model file <span +class="ec-lmsso-10">HelloWorld.room </span>was created. Open the <span +class="ec-lmsso-10">HelloWorld.room </span>file +and delete the contents of the file. Open the content assist with Ctrl+Space and select <span +class="ec-lmsso-10">model</span> +<span +class="ec-lmsso-10">skeleton</span>. +</p><!--l. 36--><p class="noindent" ><img +src="images/015-HelloWorld12.png" alt="PIC" + /> + + +</p><!--l. 39--><p class="noindent" >Edit the template variables by typing the new names and jumping with Tab from name to name. +</p><!--l. 41--><p class="noindent" >The resulting model code should look like this: +</p> +<!--l. 43--> +<div class="lstlisting" id="listing-1"><span class="label"><a + id="x10-33001r1"></a><span +class="ec-lmss-8x-x-62">1</span></span><span +class="ec-lmssbx-10x-x-90">RoomModel</span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9">HelloWorld</span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9">{</span><span +class="ec-lmtt-9"> </span><br /><span class="label"><a + id="x10-33002r2"></a><span +class="ec-lmss-8x-x-62">2</span></span><span +class="ec-lmtt-9"> </span><br /><span class="label"><a + id="x10-33003r3"></a><span +class="ec-lmss-8x-x-62">3</span></span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9"> </span><span +class="ec-lmssbx-10x-x-90">LogicalSystem</span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9">System_HelloWorld</span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9">{</span><span +class="ec-lmtt-9"> </span><br /><span class="label"><a + id="x10-33004r4"></a><span +class="ec-lmss-8x-x-62">4</span></span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9"> </span><span +class="ec-lmssbx-10x-x-90">SubSystemRef</span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9">subsystem</span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9">:</span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9">SubSystem_HelloWorld</span><span +class="ec-lmtt-9"> </span><br /><span class="label"><a + id="x10-33005r5"></a><span +class="ec-lmss-8x-x-62">5</span></span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9">}</span><span +class="ec-lmtt-9"> </span><br /><span class="label"><a + id="x10-33006r6"></a><span +class="ec-lmss-8x-x-62">6</span></span><span +class="ec-lmtt-9"> </span><br /><span class="label"><a + id="x10-33007r7"></a><span +class="ec-lmss-8x-x-62">7</span></span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9"> </span><span +class="ec-lmssbx-10x-x-90">SubSystemClass</span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9">SubSystem_HelloWorld</span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9">{</span><span +class="ec-lmtt-9"> </span><br /><span class="label"><a + id="x10-33008r8"></a><span +class="ec-lmss-8x-x-62">8</span></span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9"> </span><span +class="ec-lmssbx-10x-x-90">ActorRef</span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9">application</span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9">:</span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9">HelloWorldTop</span><span +class="ec-lmtt-9"> </span><br /><span class="label"><a + id="x10-33009r9"></a><span +class="ec-lmss-8x-x-62">9</span></span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9">}</span><span +class="ec-lmtt-9"> </span><br /><span class="label"><a + id="x10-33010r10"></a><span +class="ec-lmss-8x-x-62">10</span></span><span +class="ec-lmtt-9"> </span><br /><span class="label"><a + id="x10-33011r11"></a><span +class="ec-lmss-8x-x-62">11</span></span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9"> </span><span +class="ec-lmssbx-10x-x-90">ActorClass</span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9">HelloWorldTop</span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9">{</span><span +class="ec-lmtt-9"> </span><br /><span class="label"><a + id="x10-33012r12"></a><span +class="ec-lmss-8x-x-62">12</span></span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9"> </span><span +class="ec-lmtt-9">}</span><span +class="ec-lmtt-9"> </span><br /><span class="label"><a + id="x10-33013r13"></a><span +class="ec-lmss-8x-x-62">13</span></span><span +class="ec-lmtt-9">}</span> +</div> +<!--l. 59--><p class="noindent" >The goal of eTrice is to describe distributed systems on a logical level. In the current version not all +elements will be used. But as prerequisite for further versions the following elements can be defined: +</p> + <ul class="itemize1"> + <li class="itemize">the <span +class="ec-lmsso-10">LogicalSystem </span>(currently optional) + </li> + <li class="itemize">at least one <span +class="ec-lmsso-10">SubSystemClass </span>(mandatory) + </li> + <li class="itemize">at least one <span +class="ec-lmsso-10">ActorClass </span>(mandatory)</li></ul> +<!--l. 67--><p class="noindent" >The <span +class="ec-lmsso-10">LogicalSystem </span>represents the complete distributed system and contains at least one <span +class="ec-lmsso-10">SubSystemRef</span>. The +<span +class="ec-lmsso-10">SubSystemClass </span>represents an address space and contains at least one <span +class="ec-lmsso-10">ActorRef</span>. The <span +class="ec-lmsso-10">ActorClass </span>is the +building block of which an application will be built of. It is in general a good idea to define a top level actor +that can be used as reference within the subsystem. +</p><!--l. 72--><p class="noindent" >The outline view of the textual ROOM editor shows the main modeling elements in an easy to navigate +tree. +</p><!--l. 74--><p class="noindent" ><img +src="images/015-HelloWorld02.png" alt="PIC" + /> +</p><!--l. 78--><p class="noindent" > +</p> +<h4 class="subsectionHead"><span class="titlemark">2.4.3 </span> <a + id="x10-340002.4.3"></a>Create a state machine</h4> +<!--l. 80--><p class="noindent" >We will implement the Hello World code on the initial transition of the <span +class="ec-lmsso-10">HelloWorldTop </span>actor. Therefore open +the state machine editor by right clicking the <span +class="ec-lmsso-10">HelloWorldTop </span>actor in the outline view and select <span +class="ec-lmsso-10">Edit</span> +<span +class="ec-lmsso-10">Behavior</span>. +</p><!--l. 84--><p class="noindent" ><img +src="images/015-HelloWorld03.png" alt="PIC" + /> +</p><!--l. 87--><p class="noindent" >The state machine editor will be opened. Drag and drop an <span +class="ec-lmsso-10">Initial Point </span>from the tool box to the diagram into +the top level state. Drag and drop a <span +class="ec-lmsso-10">State </span>from the tool box to the diagram. Confirm the dialogue with +<span +class="ec-lmsso-10">ok</span>. Select the <span +class="ec-lmsso-10">Transition </span>in the tool box and draw the transition from the <span +class="ec-lmsso-10">Initial Point </span>to the +State. Open the transition dialogue by double clicking the transition arrow and fill in the action +code. + + +</p> +<div class="verbatim" id="verbatim-1"> +System.out.println("Hello World !"); +</div> +<!--l. 95--><p class="nopar" > +</p><!--l. 97--><p class="noindent" >The result should look like this: +</p><!--l. 99--><p class="noindent" ><img +src="images/015-HelloWorld04.png" alt="PIC" + /> +</p><!--l. 102--><p class="noindent" >Save the diagram and inspect the model file. Note that the textual representation was created after saving the +diagram. +</p><!--l. 105--><p class="noindent" ><img +src="images/015-HelloWorld05.png" alt="PIC" + /> +</p><!--l. 109--><p class="noindent" > +</p> +<h4 class="subsectionHead"><span class="titlemark">2.4.4 </span> <a + id="x10-350002.4.4"></a>Build and run the model</h4> +<!--l. 111--><p class="noindent" >Now the model is finished and source code can be generated. The project wizard has created a launch +configuration that is responsible for generating the source code. From <span +class="ec-lmsso-10">HelloWorld/ </span>right click +<span +class="ec-lmssbx-10">gen_HelloWorld.launch </span>and run it as gen_HelloWorld. All model files in the model directory will be +generated. +</p><!--l. 116--><p class="noindent" ><img +src="images/015-HelloWorld06.png" alt="PIC" + /> +</p><!--l. 119--><p class="noindent" >The code will be generated to the src-gen directory. The main function will be contained in +<span +class="ec-lmssbx-10">SubSystem_HelloWorldRunner.java</span>. Select this file and run it as Java application. +</p><!--l. 122--><p class="noindent" ><img +src="images/015-HelloWorld07.png" alt="PIC" + /> +</p><!--l. 126--><p class="noindent" >The Hello World application starts and the string will be printed on the console window. To stop the +application the user must type <span +class="ec-lmssbx-10">quit </span>in the console window. +</p><!--l. 129--><p class="noindent" ><img +src="images/015-HelloWorld08.png" alt="PIC" + /> +</p><!--l. 132--><p class="noindent" > +</p> +<h4 class="subsectionHead"><span class="titlemark">2.4.5 </span> <a + id="x10-360002.4.5"></a>Open the Message Sequence Chart</h4> +<!--l. 134--><p class="noindent" >During runtime the application produced a MSC and wrote it to a file. Open +HelloWorld/tmp/log/SubSystem_HelloWorld_Async.seq using Trace2UML (it is open source and can be +obtained from http://trace2uml.tigris.org/). You should see something like this: +</p><!--l. 138--><p class="noindent" ><img +src="images/015-HelloWorld09.png" alt="PIC" + /> +</p><!--l. 142--><p class="noindent" > +</p> +<h4 class="subsectionHead"><span class="titlemark">2.4.6 </span> <a + id="x10-370002.4.6"></a>Summary</h4> +<!--l. 144--><p class="noindent" >Now you have generated your first eTrice model from scratch. You can switch between diagram editor and +model (.room file) and you can see what will be generated during editing and saving the diagram files. You +should take a look at the generated source files to understand how the state machine is generated and the life +cycle of the application. The next tutorials will deal with more complex hierarchies in structure and +behavior. + + +</p> +<!--l. 1--><div class="crosslinks"><p class="noindent">[<a +href="etrice-docse7.html" >next</a>] [<a +href="etrice-docse5.html" >prev</a>] [<a +href="etrice-docse5.html#tailetrice-docse5.html" >prev-tail</a>] [<a +href="etrice-docse6.html" >front</a>] [<a +href="etrice-docch2.html#etrice-docse6.html" >up</a>] </p></div> +<!--l. 1--><p class="noindent" ><a + id="tailetrice-docse6.html"></a> </p> +</body></html> |