Difference between revisions of "Wristwatch Example"

From WeizmannWiki
Jump to: navigation, search
(→‎Download the Wristwatch Example)
 
(93 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
We will present each of the requirements text, and the LSC created from them. 
+
The wristwatch example is taken from <ref>D. Harel. "On Visual Formalisms", Commun. ACM, 31(5):514–530, 1988.</ref>, and is a simplified version of the original statecharts watch example of <ref>D. Harel, "Statecharts: A Visual Formalism for Complex Systems", Sci. Comput. Programming 8, 231-274, 1987.</ref>. Generally, the watch displays the time and can switch between different displays that show (and allow changes to) the alarm, date, time and stopwatch. It has an option for turning on the light, and an alarm that beeps when the set time is reached. The following examples demonstrate many constructs in the LSC language and the way they were created in natural lanague play-in. The model was originally described in <ref>M. Gordon and D. Harel. Generating executable scenarios fromfckLRnatural language. In Proc. 10th Int. Conf. on Computational Linguistics and Intelligent Text Processing, CICLing’09, pages 456–467. Springer-Verlag, 2009.</ref>.
  
 
== Requirements  ==
 
== Requirements  ==
Line 5: Line 5:
 
=== Watch Modes  ===
 
=== Watch Modes  ===
  
−
when the user clicks the d_button, if the display mode is time, the display mode changes to date, otherwise if the display mode is date, the display mode changes to time.&nbsp;[[Image:WatchModes.png|thumb|left|30px|LSC]]  
+
{| width="100%" border="1" align="left" cellpadding="1" cellspacing="1"
 +
|-
 +
! scope="col" width="70%" | Natural Language Text
 +
! scope="col"  width = "15%" | Comments
 +
! scope="col" width="15%" | LSC
 +
|-
 +
| when the user clicks the d_button, if the display mode is "time", the display mode changes to "date", otherwise if the display mode is "date", the display mode changes to "time".
 +
| Demonstrates if-else.
 +
| [[Image:WatchModes.png|thumb|left|x50px|LSC]]
 +
|-
 +
| when the user clicks the a_button, if the display mode is "time", the display mode changes to "alarm", otherwise if the display mode is "alarm", the display mode changes to "chime", otherwise if the display mode is "chime", the display mode changes to "stopwatch", otherwise if the display mode is "stopwatch", the display mode changes to "time".
 +
|
 +
| [[Image:Modes.png|thumb|left|x50px|LSC]]
 +
|-
 +
| when the user clicks the c_button , if the display mode is "alarm" then the display mode changes to "alarm minutes" , otherwise if the display mode is "alarm minutes" then the display mode changes to "alarm hours" , otherwise if the display mode is "alarm hours" then the display mode changes to "alarm".
 +
|
 +
| [[Image:ModesAlarm.png|thumb|left|x50px|LSC]]
 +
|-
 +
| when the user clicks the b_button, if the display mode is “alarm minutes”, the display mode changes to "alarm".
 +
|
 +
| [[Image:ModeAlarmEnd.png|thumb|left|x50px|LSC]]
 +
|-
 +
| when the user clicks the b_button, if the display mode is “alarm hours” , the display mode changes to "alarm".
 +
|
 +
| [[Image:ModeAlarmHoursEnd.png|thumb|left|x50px|LSC]]
 +
|-
 +
| when the user clicks the a_button , if the display mode is "alarm minutes" , the alarm increases in one minute , otherwise if the display mode is "alarm hours" , the alarm increases by one hour.
 +
|
 +
| [[Image:IncreaseTime.png|thumb|left|x50px|LSC]]
 +
|-
 +
| when the user clicks the c_button , if the display mode is "time" , the display mode changes to "update" and the update type changes to "seconds".
 +
|
 +
| [[Image:UpdateSeconds.png|thumb|left|x50px|LSC]]
 +
|}
  
−
when the user clicks the a_button, if the display mode is time, the display mode changes to alarm, otherwise if the display mode is alarm, the display mode changes to chime, otherwise if the display mode is chime, the display mode changes to stopwatch, otherwise if the display mode is stopwatch, the display mode changes to time.
+
=== Updates  ===
  
−
Here we will add Michal's wrist watch example.  
+
{| width="100%" border="1" align="left" cellpadding="1" cellspacing="1"
 +
|-
 +
! scope="col" width="70%" | Natural Language Text
 +
! scope="col"  width = "15%" | Comments
 +
! scope="col" width="15%" | LSC
 +
|-
 +
| when the user clicks the c_button , if the update type is "seconds" , the update type changes to "minutes" otherwise if the update type is "minutes" , the update type changes to "hours" otherwise if the update type is "hours" , the update type changes to "date" otherwise if the update type is "date", the display mode changes to "time" and the update type changes to "none".
 +
|
 +
| [[Image:UpdateType.png|thumb|left|x50px|LSC]]
 +
|-
 +
| when the update type changes , if the update type equals "seconds" , the display blinks seconds , otherwise if the update type equals "minutes" , the display blinks minutes , otherwise the display blinks none.
 +
|
 +
| [[Image:UpdateTypeBlink.png|thumb|left|x50px|LSC]]
 +
|-
 +
| when the update type changes, the display mode changes to "update".
 +
|
 +
| [[Image:TypeChangeUpdate.png|thumb|left|x50px|LSC]]
 +
|}
  
−
Should have a link from the Example Page.
+
=== Time  ===
  
−
== Download the Wrist Watch Example ==
+
{| width="100%" border="1" align="left" cellpadding="1" cellspacing="1"
 +
|-
 +
! scope="col" width="70%" | Natural Language Text
 +
! scope="col" width = "15%" | Comments
 +
! scope="col" width="15%" | LSC
 +
|-
 +
| when the clock ticks, the time increases by one second.
 +
|
 +
| [[Image:TimeTicks.png|thumb|left|x50px|LSC]]
 +
|-
 +
| when the time value changes, if the display mode is "time", the display text changes to time value.
 +
| Demonstrates a property change as a trigger.
 +
| [[Image:ShowTime.png|thumb|left|x50px|LSC]]
 +
|}
  
−
The following zip files contain...
+
=== Light  ===
  
−
[[Media:WristWatchExampleSwingGUI.zip|WristWatchExampleSwingGUI.zip]] <br> [[Media:WristWatchExampleSystemModelGUI.zip|WristWatchExampleSystemModelGUI.zip]]  
+
{| width="100%" border="1" align="left" cellpadding="1" cellspacing="1"
 +
|-
 +
! scope="col" width="70%" | Natural Language Text
 +
! scope="col"  width = "15%" | Comments
 +
! scope="col" width="15%" | LSC
 +
|-
 +
| when the user clicks the b_button, if the light state is on , the light state turns to off , otherwise if the light state is off , the light state turns to on.
 +
|
 +
| [[Image:LightState.png|thumb|left|x50px|LSC]]
 +
|}
  
−
== Installation Instructions  ==
+
<br>
  
−
#Extract the downloaded file. The zip includes an executable jar and a properties file - ToDO: extend this and add image of the extracted folder.  
+
=== Alarm  ===
−
#Double click the jar and start playing
+
 
 +
{| width="100%" border="1" align="left" cellpadding="1" cellspacing="1"
 +
|-
 +
! scope="col" width="70%" | Natural Language Text
 +
! scope="col"  width = "15%" | Comments
 +
! scope="col" width="15%" | LSC
 +
|-
 +
| when the time value changes , if the time value equals the alarm value and the alarm state is enabled then the beeper state turns to on.
 +
|
 +
| [[Image:AlarmState.png|thumb|left|x50px|LSC]]
 +
|-
 +
| when the user clicks the d_button , if the display mode is "alarm" , if the alarm state is enabled , the alarm state changes to disabled otherwise the alarm state changes to enabled.
 +
|
 +
| [[Image:EnableAlarm.png|thumb|left|x50px|LSC]]
 +
|-
 +
| when the display mode changes , if the display mode equals "alarm minutes" , the display blinks minutes , otherwise if the display mode equals "alarm hours" , the display blinks hours , otherwise the display blinks none.
 +
|
 +
| [[Image:BlinkAlarm.png|thumb|left|x50px|LSC]]
 +
|-
 +
| when the beeper state changes to on, as long as the beeper state is on and two seconds elapse, the beeper beeps, the display mode may not change.
 +
| Demonstrates loop and forbidden element.
 +
| [[Image:AlarmBeep.png|thumb|left|x50px|LSC]]
 +
|-
 +
| when the user clicks any WButton , the beeper state turns to off.
 +
| Demonstrates symbolic \ non-deterministic objects.
 +
| [[Image:AlarmOff.png|thumb|left|x50px|LSC]]
 +
|-
 +
| when the display mode changes to "alarm", the display text changes to the alarm value.
 +
|
 +
| [[Image:AlarmDisplay.png|thumb|left|x50px|LSC]]
 +
|}
 +
 
 +
=== Date  ===
 +
 
 +
{| width="100%" border="1" align="left" cellpadding="1" cellspacing="1"
 +
|-
 +
! scope="col" width="70%" | Natural Language Text
 +
! scope="col"  width = "15%" | Comments
 +
! scope="col" width="15%" | LSC
 +
|-
 +
| when the display mode changes to "date", the display text changes to the date value.
 +
|
 +
| [[Image:DisplayDate.png|thumb|left|x50px|LSC]]
 +
|}
 +
 
 +
<br>&nbsp;<br>
 +
 
 +
== Wristwatch Example  ==
 +
 
 +
Below is a download of the wristwatch final application, as well as instructions for creating the wristwatch example in PlayGo.
 +
 
 +
=== Wristwatch final application (runnable jar)  ===
 +
 
 +
[https://weizmann.box.com/s/vm7kdsj3689wnqkpk22i Runnable Wristwatch with Swing GUI] <br><br>
 +
 
 +
To run the wristwatch, simply extract the downloaded zip and double click the jar file.
 +
 
 +
=== Wristwatch LSC project  ===
 +
 
 +
To work with the wristwatch application, you can create it in your PlayGo workspace:
 +
 
 +
#[[Download PlayGo|Download PlayGo]].
 +
#From the 'File' menu choose New-->Example....-->PlayGo Examples-->Wristwatch
 +
#Click the 'Finish' button.
 +
#The wristwatch example project is now part of your workspace. You can start playing with it. For details refer to&nbsp;[[How%20to%20Play-Out | how to play out]] and [[How_to_Play-In|how to play in]].
 +
 
 +
== References  ==
 +
 
 +
<references />

Latest revision as of 11:53, 20 December 2015

The wristwatch example is taken from [1], and is a simplified version of the original statecharts watch example of [2]. Generally, the watch displays the time and can switch between different displays that show (and allow changes to) the alarm, date, time and stopwatch. It has an option for turning on the light, and an alarm that beeps when the set time is reached. The following examples demonstrate many constructs in the LSC language and the way they were created in natural lanague play-in. The model was originally described in [3].

Requirements

Watch Modes

Natural Language Text Comments LSC
when the user clicks the d_button, if the display mode is "time", the display mode changes to "date", otherwise if the display mode is "date", the display mode changes to "time". Demonstrates if-else.
LSC
when the user clicks the a_button, if the display mode is "time", the display mode changes to "alarm", otherwise if the display mode is "alarm", the display mode changes to "chime", otherwise if the display mode is "chime", the display mode changes to "stopwatch", otherwise if the display mode is "stopwatch", the display mode changes to "time".
LSC
when the user clicks the c_button , if the display mode is "alarm" then the display mode changes to "alarm minutes" , otherwise if the display mode is "alarm minutes" then the display mode changes to "alarm hours" , otherwise if the display mode is "alarm hours" then the display mode changes to "alarm".
LSC
when the user clicks the b_button, if the display mode is “alarm minutes”, the display mode changes to "alarm".
LSC
when the user clicks the b_button, if the display mode is “alarm hours” , the display mode changes to "alarm".
LSC
when the user clicks the a_button , if the display mode is "alarm minutes" , the alarm increases in one minute , otherwise if the display mode is "alarm hours" , the alarm increases by one hour.
LSC
when the user clicks the c_button , if the display mode is "time" , the display mode changes to "update" and the update type changes to "seconds".
LSC

Updates

Natural Language Text Comments LSC
when the user clicks the c_button , if the update type is "seconds" , the update type changes to "minutes" otherwise if the update type is "minutes" , the update type changes to "hours" otherwise if the update type is "hours" , the update type changes to "date" otherwise if the update type is "date", the display mode changes to "time" and the update type changes to "none".
LSC
when the update type changes , if the update type equals "seconds" , the display blinks seconds , otherwise if the update type equals "minutes" , the display blinks minutes , otherwise the display blinks none.
LSC
when the update type changes, the display mode changes to "update".
LSC

Time

Natural Language Text Comments LSC
when the clock ticks, the time increases by one second.
LSC
when the time value changes, if the display mode is "time", the display text changes to time value. Demonstrates a property change as a trigger.
LSC

Light

Natural Language Text Comments LSC
when the user clicks the b_button, if the light state is on , the light state turns to off , otherwise if the light state is off , the light state turns to on.
LSC


Alarm

Natural Language Text Comments LSC
when the time value changes , if the time value equals the alarm value and the alarm state is enabled then the beeper state turns to on.
LSC
when the user clicks the d_button , if the display mode is "alarm" , if the alarm state is enabled , the alarm state changes to disabled otherwise the alarm state changes to enabled.
LSC
when the display mode changes , if the display mode equals "alarm minutes" , the display blinks minutes , otherwise if the display mode equals "alarm hours" , the display blinks hours , otherwise the display blinks none.
LSC
when the beeper state changes to on, as long as the beeper state is on and two seconds elapse, the beeper beeps, the display mode may not change. Demonstrates loop and forbidden element.
LSC
when the user clicks any WButton , the beeper state turns to off. Demonstrates symbolic \ non-deterministic objects.
LSC
when the display mode changes to "alarm", the display text changes to the alarm value.
LSC

Date

Natural Language Text Comments LSC
when the display mode changes to "date", the display text changes to the date value.
LSC


 

Wristwatch Example

Below is a download of the wristwatch final application, as well as instructions for creating the wristwatch example in PlayGo.

Wristwatch final application (runnable jar)

Runnable Wristwatch with Swing GUI

To run the wristwatch, simply extract the downloaded zip and double click the jar file.

Wristwatch LSC project

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

  1. Download PlayGo.
  2. From the 'File' menu choose New-->Example....-->PlayGo Examples-->Wristwatch
  3. Click the 'Finish' button.
  4. The wristwatch example project is now part of your workspace. You can start playing with it. For details refer to  how to play out and how to play in.

References

  1. ↑ D. Harel. "On Visual Formalisms", Commun. ACM, 31(5):514–530, 1988.
  2. ↑ D. Harel, "Statecharts: A Visual Formalism for Complex Systems", Sci. Comput. Programming 8, 231-274, 1987.
  3. ↑ M. Gordon and D. Harel. Generating executable scenarios fromfckLRnatural language. In Proc. 10th Int. Conf. on Computational Linguistics and Intelligent Text Processing, CICLing’09, pages 456–467. Springer-Verlag, 2009.
Retrieved from "https://wiki.weizmann.ac.il/playgo/index.php?title=Wristwatch_Example&oldid=1429"