How to debug

2015-12-28T07:46:24Z

Smadar:

Debugging is by default enabled whenever you play out. To disable/enable debugging, check the corresponding flag in the 'Play-Out' properties by right-clicking your project and choosing properties-->PlayGo-->Play-Out-->General tab-->Debug flag:

[[File:Playout.properties.general.jpg|800px|Playout.properties.general.jpg]] When playing-out you can see information about the LSC execution in the 'Play-Out' view, and you can set breakpoints directly on the LSC diagram or in the Java code.

== Play-Out View ==

[[File:PlayoutView.jpg|800px|PlayoutView.jpg]] The Play-Out view displays the information logged at runtime by the [[The Tracer|Tracer]]. Each line represents an explicit or implicit event that occurred during execution. The information is grouped by events. The icon at each line defines the type of information it provides: [[File:Event.gif]] - information about the event that occurred in the system and triggered the steps included in this sub tree. Contains the event signature. [[File:Cut.gif]] - information about the cut change. Includes the name of the LSC, the sequence of locations that constitute the current cut, and whether the cut is hot or cold. [[File:Binding.gif]] - information about a binding of a lifeline. Includes the type of lifeline and the name of the bounded instance. [[File:Completion.gif]] - information about LSC completion/finish. [[File:ViolationHot.gif]] - information about a hot violation. [[File:ViolationCold.gif]] - information about a cold violation. Upon clicking an entry in the view, a graphical indication is displayed on the diagram. For example, when clicking a 'cut change' entry, the cut is drawn on the diagram. [[File:PlayoutView.cutChange.jpg|800px|PlayoutView.cutChange.jpg]] The information provided in the play-out view can be filtered using the filters provided in the view's toolbar: [[File:PlayoutView.filters.png|800px|PlayoutView.filters.png]]

== Applying breakpoints ==

Breakpoints can be applied at runtime on the diagram, as well as in the Java code.

On the diagram, set a breakpoint by right-clicking a message and choosing 'Toggle Breakpoint':

[[File:LSCEditor.breakpoint.png|800px|LSCEditor.breakpoint.png]]

 Applying a breakpoint in the Java code is done in the standard way (e.g., right-clicking the left-hand side-bar of a source line and choosing 'Toggle Breakpoint').

In both cases, the execution will stop when reaching a breakpoint. Once stopped, it can be resumed by clicking the resume button in the toolbar of the Debug view: [[File:DebugView.jpg|800px|DebugView.jpg]]
 
'''[[Troubleshoot#Play-out does not stop at breakpoint|Troubleshoot...]]'''

How to debug

2015-12-28T07:43:57Z

Smadar: /* Applying breakpoints */

Debugging is by default enabled whenever you play out.
To disable/enable debugging, check the corresponding flag in the 'Play-Out' properties by
right-clicking your project and choosing properties-->PlayGo-->Play-Out-->General tab-->Debug flag:

[[Image:playout.properties.general.jpg|800px]]
 
When playing-out you can see information about the LSC execution in the 'Play-Out' view, and you can set breakpoints directly on the LSC diagram or in the Java code.

==Play-Out View==
[[Image:playoutView.jpg|800px]]
 
The Play-Out view displays the information logged at runtime by the [[The_Tracer | Tracer]]. Each line represents an explicit or implicit event that occurred during execution. The information is grouped by events. The icon at each line defines the type of information it provides: 
[[Image:event.gif]] - information about the event that occurred in the system and triggered the steps included in this sub tree. Contains the event signature. 
[[Image:cut.gif]] - information about the cut change. Includes the name of the LSC, the sequence of locations that constitute the current cut, and whether the cut is hot or cold. 
[[Image:binding.gif]] - information about a binding of a lifeline. Includes the type of lifeline and the name of the bounded instance. 
[[Image:completion.gif]] - information about LSC completion/finish. 
[[Image:violationHot.gif]] - information about a hot violation. 
[[Image:violationCold.gif]] - information about a cold violation. 
 
Upon clicking an entry in the view, a graphical indication is displayed on the diagram. For example, when clicking a 'cut change' entry, the cut is drawn on the diagram.
[[Image:playoutView.cutChange.jpg|800px]] 
The information provided in the play-out view can be filtered using the filters provided in the view's toolbar: 
[[Image:playoutView.filters.png|800px]]

== Applying breakpoints==
Breakpoints can be applied at runtime on the diagram, as well as in the Java code.

On the diagram, set a breakpoint by right-clicking a message and choosing 'Toggle Breakpoint':

[[Image:LSCEditor.breakpoint.png | 800px]]

 
Applying a breakpoint in the Java code is done in the standard way (e.g., right-clicking the left-hand side-bar of a source line and choosing 'Toggle Breakpoint').

In both cases, the execution will stop when reaching a breakpoint. Once stopped, it can be resumed by clicking the resume button in the toolbar of the Debug view:
[[Image:debugView.jpg|800px]]

[[Troubleshoot#Play-out_does_not_stop_at_breakpoint|Troubleshoot...]]

Troubleshoot

2015-12-28T07:41:37Z

Smadar: /* Play-out does not stop at breakpoint */

== Unable to create LSC project ==

If you cannot find the 'New LSC Project' command in the 'File' menu, you may not be working with the PlayGo perspective. It is recommended to work with the provided PlayGo [http://www.eclipse.org/articles/using-perspectives/PerspectiveArticle.html perspective]. Working with the PlayGo perspective provides shortcuts to some operations (e.g., create a new LSC Project) and some views (e.g., the system model view). To change the active perspective to the PlayGo perspective, click the 'Open Perspective' button on the toolbar, select 'Other...' and select 'PlayGo':

[[Image:Open.perspective.jpg|800px]]

== Play-out failure ==

'''Problem:''' Play-out fails. '''Solution:''' 
#PlayGo supports Java 7. Make sure you have the right version of Java installed, or [[Download PlayGo | download]] PlayGo package that includes the required Java Runtime Environment.
#Re-compile the LSC project by selecting and choosing Project->Build All, from the menu bar. In case the problem persists, make sure the S2A aspects code was generated. To generate aspects: 
##Select the LSC project.
##Press the 'S2A Clean' button on the toolbar.
##Press the 'Build with S2A' button on the toolbar.
##To make sure Eclipse loaded the newly generated aspects, refresh the project directory by selecting the project, right-clicking it and selecting 'Refresh'

If the new aspects are still not in place, there may be something wrong with your [[S2A Configuration|Play-Out Configuration]].

== Error when launching PlayGo ==

'''Problem''': When launching PlayGo, you get an error message: "The PlayGo executable launcher was unable to locate its companion shared library". '''Solution''': This error occurs when extracting the downloaded zip file using the Windows 7 default unzip program. Use WinZip or any other program to extract this file.

== During play-out an event is executed in a loop ==

'''Problem''': During play-out, an enabled event is executed multiple times although it was expected to be executed once. '''Solution''': This may happen if the event has an argument that is an object (rather than a primitive type), and that the object's class is missing the implementation of the method 'equals'. Add an implementation of the 'equals' method and play-out again. '''Explanation''': During play-out, S2A chooses an enabled event from a list of enabled events, based on the selected strategy. After executing the event, S2A advances the cut of all relevant LSCs. The process of advancing a cut is done by searching for a match between the executed event with the enabled event in all live copies, and with minimal events in all LSCs. The matching process tries to match the event name as well as its argument values. Non-primitive argument values are compared using the 'equals' method.

== Play-out does not stop at breakpoint ==
'''Problem''': You set a breakpoint on either the LSC or the Java code, but PlayGo does not stop when expected. 
'''Solution''': From the toolbar, select Windows -> Preference -> PlayGo and check the 'Enable Java Debug' flag:
 

[[Image:enableJavaDebug.png|600px]]

2015-12-20T11:50:33Z

Smadar:

The phone example demonstrates the creation of LSCs using [[PlayGo Feature List#Natural language play-in|NL play-in]]. It uses the default system model GUI created automatically by PlayGo. It was later augmented with a manually created Java swing GUI to make the application more user-friendly. [[File:Systemmodel GUI.png]]

The automatically created system model GUI.

== Requirements ==

For each requirement, we present the requirement in [[PlayGo Feature List#Natural language play-in|natural language]] with no additional explanation, since the text is straightforward. Additionally, we present the LSC diagram created and comments on the creation process, when necessary.

{| width="100%" border="1" align="left" cellpadding="1" cellspacing="1"
|-
! scope="col" width="10%" | Name
! scope="col" width="50%" | Requirement in Natural Language Text
! scope="col" width="35" | Comments
! scope="col" width="5%" | LSC
|-
| Lock and Unlock
| when the user clicks the star and the user clicks the end, if the display state is "Time" then the display state changes to "num" otherwise if the display state is "num" and the chip content is "" then the display state changes to "Time"
| Time state is considered to be the lock state, in which the phone displays the time and accepts calls. Num state is the unlock state, in which the user can also dial. '''''Testing scenario''''': Click the star button and then click the end button, the phone starts as "Time" and should become "num". Change it back to "Time".
| [[File:PhoneLSC01.png|thumb|left|PhoneLSC01.png]]
|-
| rowspan="2" style="vertical-align:top;hrizontal-align:center;" | Back Color Changes
| when the display state changes to "num" then the display backcolor changes to "pink"
| rowspan="2" style="vertical-align:center;" | '''''Testing scenario''''': Change states between time, num and off, and see that the color changes to gray, pink and dark gray respectively.
| [[File:PhoneLSC2.png|thumb|left|PhoneLSC2.png]]
|-
| when the display state changes, if the display state is "Time" then the display backcolor changes to "gray" otherwise if the display state is "off" then the display backcolor changes to "darkGray"
| [[File:PhoneLSC03.png|thumb|left|PhoneLSC03.png]]
|-
| Dial
| when the user clicks any Cnumber, if the display state is "num" and the chip content is "" then the display concatenates the Cnumber value
|
Concatenate is a function implemented in Java, that concatenates the digits. It overrides the generated code of the display class. See code in playgo.systemmode.classes.

  '''''Testing scenario''''':Click the number buttons and check the numbers that appear on the display.

| [[File:PhoneLSC04.png|thumb|left|PhoneLSC04.png]]
|-
| Clear
| when the user clicks the clear, if the chip content is "" then the display clears
|
Clear is a function implemented in Java, that clears the last digit. It overrides the generated code of the display class. See code in playgo.systemmode.classes.

 '''''Testing scenario''''':With the phone in num state (unlocked, display in pink color), dial some numbers and then press the c button, the last digit will be cleared.

| [[File:PhoneLSC07.png|thumb|left|PhoneLSC07.png]]
|-
| End
| when the user clicks the end then the chip clears and the memory clears and the display shows "" and the speaker sound turns "off"
| '''''Testing scenario''''':Press the end button to clear all numbers from the display. Also, check to see that upon pressing the end, the chip content clears, the memory clears and the speaker change to off.
| [[File:PhoneLSC05.png|thumb|left|PhoneLSC05.png]]
|-
| Power
| when the user clicks the power, if the display state is not "off" and the chip content is "" then the display state changes to "off" and the display Text changes to "" otherwise the display state changes to "num"
|
The off state is when the user switches off the phone, in which case the user can’t dial or accept a call.

  '''''Testing scenario''''':Pressing the p button will make the phone turn to off.

| [[File:PhoneLSC06.png|thumb|left|PhoneLSC06.png]]
|-
| rowspan="5" style="vertical-align:top;hrizontal-align:center;" | Call
| when the user clicks the call, if the display length is not "1" then the chip content is set to the display Text
| rowspan="5" | When the env gets any call from the chip, the env responses to the chip either by “busy” and the call is not connected, or by “ack“ and the call is connected. '''''To generate an external call from the Env'''''- right-click the Env object in system model and choose 'call other object'. After that right-click the receive method of the chip object and choose 'call message'. When required, provide the argument “ack” or “Busy”. '''''Testing scenario''''':Dial some digits (not a single digit, since that will activate the speed dial feature for the digit dialed), then press the call button. Depending on the response “busy” or “ack”(set the response from the env) the display will show “busy” or “connected“ and the speaker sound will stop.
| [[File:PhoneLSC08.png|thumb|left|PhoneLSC08.png]]
|-
| when the chip content is set, if the chip content is not "Busy" and the chip content is not "" and the chip content is not "incomingcall" and the chip content is not "ack" and the chip content is not "connected" then the chip makecall to the env and the speaker sound turns "ringout"
| [[File:PhoneLSC11.png|thumb|left|PhoneLSC11.png]]
|-
| when the env receives "ack" to the chip, if the chip content is "ack" then the display shows "connected" and the speaker sound turns "off"
| [[File:PhoneLSC010.png|thumb|left|PhoneLSC010.png]]
|-
| when the env receives "busy" to the chip, if the chip content is "busy" then the display shows "busy" and the speaker sound turns "off"
| [[File:PhoneLSC0011.png|thumb|left|PhoneLSC0011.png]]
|-
| when the user clicks the call and one second elapses, if the speaker sound is "ringout" then the display shows "busy" and the speaker sound changes to "off"
| [[File:PhoneLSC24.png|thumb|left|PhoneLSC24.png]]
|-
| rowspan="3" style="vertical-align:top;hrizontal-align:center;" | SpeedDial
| when the user clicks any Cnumber and the user clicks the call, if the display length is "1" then the memory retreives the Cnumber value and the display shows the memory value
| rowspan="3" | Retreive is a function defined in memory class. It reads values from an xml file and stores the number corresponding to each speed dial digit. '''''Testing scenario''''': Dial a single digit, then press the call button. Check that the saved number corresponding to the digit is displayed and that the call is forwarded to the number.
| [[File:LSC012.png|thumb|left|LSC012.png]]
|-
| when the memory value changes then the chip content changes to the memory value
| [[File:PhoneLSC013.png|thumb|left|PhoneLSC013.png]]
|-
| when the memory value changes then the display shows the memory value
| [[File:PhoneLSC18.png|thumb|left|PhoneLSC18.png]]
|-
| rowspan="3" style="vertical-align:top;hrizontal-align:center;" | Speaker
| when the speaker sound turns to "ringout" then the speaker plays.
| rowspan="3" style="vertical-align:center;" | '''''Testing scenario''''':Dial some digits and click call. The speaker should play the playout tone. Then click the end, which makes the speaker turn off and the tone played stops. Set an incoming call from the env to the chip and check that the speaker plays ring tone. Click the end button to stop the tone.
| [[File:PhoneLSC14.png|thumb|left|PhoneLSC14.png]]
|-
| when the speaker sound turns "off" then the speaker stops
| [[File:PhoneLSC15.png|thumb|left|PhoneLSC15.png]]
|-
| when the speaker sound turns to "ringing" then the speaker rings
| [[File:PhoneLSC16.png|thumb|left|PhoneLSC16.png]]
|-
| rowspan="3" style="vertical-align:top;hrizontal-align:center;" | Incomingcall
| when the env receives "incomingcall" to the chip, if the chip content is "incomingcall" then the display shows “incomingcall” and the display state changes to "num" and the speaker sound turns to "ringing"
| rowspan="3" | To generate an external call from the Env, right-click the Env object in the system model and choose 'call other object'. After that right-click the receive method of the chip object and choose 'call message'. When prompted, provide the argument “incomingcall”. '''''Testing scenario''''': when the env sets “incomingcall” to the chip, the display will show the “incomingcall” and the speaker will start playing ‘playing’ tone. Click the end or call to turn the speaker to off when the display text is “incoming”
| [[File:PhoneLSC12.png|thumb|left|PhoneLSC12.png]]
|-
| when the user clicks the call, if the display Text is "incomingcall" then the speaker sound turns "off"
| [[File:PhoneLSC17.png|thumb|left|PhoneLSC17.png]]
|-
| when the user clicks the call, if the display Text is "incomingcall" then the display Text changes to connected
| [[File:PhoneLSC20.png|thumb|left|PhoneLSC20.png]]
|-
| rowspan="2" | Clock
| when the Clock ticks, if the display state is "Time" then the display shows the Clock stringTime
| rowspan="2" |
| [[File:PhoneLSC23.png|thumb|left|PhoneLSC23.png]]
|-
| when the display state changes to "Time" then the display shows the Clock stringTime
| [[File:PhoneLSC22.png|thumb|left|PhoneLSC22.png]]
|}

== ==
== Phone LSC project ==

To work with the phone application, you can create it in your PlayGo workspace:

#[[Download PlayGo|Download PlayGo]].
#From the 'File' menu choose New-->Example....-->PlayGo Examples-->Phone
#Click the 'Finish' button.
#The phone example project is now part of your workspace. You can start playing with it. For details refer to [[How to Play-Out|how to play out]] and [[How to Play-In|how to play in]].

2015-12-20T11:29:57Z

Smadar:

How to Play In

2015-07-08T12:28:42Z

Smadar: