ThinKCharts User Guide

* The wizard asks you for the name of the diagram file and its corresponding model file. These should be the same for both files.[[~[~[image:url:http://trac.rtsys.informatik.uni-kiel.de/trac/kieler/browser/plugins/de.cau.cs.kieler.synccharts/images/thinkcharts-mainmenu.png?format=raw~]~]>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/kieler/browser/plugins/de.cau.cs.kieler.synccharts/images/thinkcharts-mainmenu.png||shape="rect"]]

15

* Use the KIELER main menu to add some default initial syncChart to your canvas to start from. Now you have a new syncChart with a top level state that contains a region. Note that there should only be one top level state in a syncChart.

16

17

== Editing the diagram ==

=== Context Menu ===

[[~[~[image:url:http://trac.rtsys.informatik.uni-kiel.de/trac/kieler/browser/plugins/de.cau.cs.kieler.synccharts/images/thinkcharts-contextmenu.png?format=raw~]~]>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/kieler/browser/plugins/de.cau.cs.kieler.synccharts/images/thinkcharts-contextmenu.png||shape="rect"]]

22

23

* Use the //context menu//(right-click) to add most of the items

24

** **Add Successor State**: Add a state with a transition following the currently selected state.

25

** **Add Predecessor State**: Add a state with a transition with a transition to the currently selected state.

26

** **Upgrade State**: Add a Region into a State and an initial State into that Region. Can be called either on Simple States or on Macro States.

27

** **Downgrade State**: Remove a Region from a State.

28

** **Add Choice**: Add a Conditional Pseudo States with two target States.

29

** **Add Signal**: Add a Signal declaration to a State.

30

** **Add Action/Suspension(% style="color: rgb(0,51,102);" %) (%%)**: Add a State Action (OnEntry, OnInside (will be executed every tick), OnExit) or a Suspension Trigger. The first three may also contain a Trigger (hence a pure effect needs to start with a slash "/"), the latter is only a Trigger and may not contain an effect.

31

** **Connect States**: Add a Transition between the two selected States.

32

** **Flip Transition**: Change source and target of selected Transition.

33

** **Set Transition Target/Set Transition Source**: Change either the target or the source of the currently selected transition to the currently selected State. Requires tp select exactly one Transition and one State.

=== Palette ===

The Palette is only there for old-style drag-and-drop editing. It is discouraged to use the palette to insert states and transitions. Better use the context menu as described above to edit the diagram with Structure-Based Editing operations. It will also automatically use auto-layout to get a nice graphical layout of the diagram.

=== Properties ===

* Use the properties view to change internal attributes of graphical objects

42

* Open by

43

** Window->Show view->Properties or

44

** Right-click in the graphical editor -> Show Properties View

45

* Example attributes to change

46

** Labels and IDs of States

47

** Types and flags of States (Conditional, normal, reference, initial, final...)

48

** Types and flags of Transitions (weak or strong abortion, normal termination, immediate, delay, history...)

=== Labels ===

* Main label properties like IDs or names can be changed by selecting the graphical object and just start typing on the keyboard. E.g. select a Region and start typing; this will edit the Region ID.

53

* Click a textual label multiple times for direct in-place editing of names, e.g.

** State labels

** Signal names

** Transition labels

** Action labels

** Region IDs

----

== Graphical Elements in a ThinKCharts SyncChart ==

== Interface Declaration Parser ==

67

68

* Signals and Variables can be declared in a textual representation for a specific state and this state's subregions.

69

* If you are familiar with Xtext grammars or ENBF see following links for the complete syntax

70

** (% class="source" %)Xtext: (% class="source source source" %)InterfaceDecl.xtext in (% class="source source" %)de.cau.cs.kieler.synccharts.interfacedeclparser(% class="source" %)

71

72

** ENBF: InterfaceDecl.htmlde.cau.cs.kieler.synccharts.interfacedeclparser.

=== Short Sample ===

* signals can be added using the //signal//keyword finished by a semicolon.

77

** there can be an arbitrary number of comma separated signals

78

** inputs are declared by using the keyword //input// (same for //output// and //input output//)

79

* variables are added in a similar way like signals by using the //var//keyword finished by a semicolon.

80

** there can be an arbitrary number of comma separated variables just like for the signals

81

* an initial value is defined by //:=//following directly after the signal's name (care: use quotation marks for the value, as the underlying type is EString)

82

** the value type can be declared directly afterwards with a preceding colon

83

* the combine operator and value type are declared by the keywords //combine// ... //with//

84

** possible combine operators : NONE, +, *, max, min, or, and, host

85

** possible value types : PURE, BOOL, UNSIGNED, INT, FLOAT,HOST

86

* signals and variables for a state's //subregions// are declared starting with region's identifier followed by a colon (//R0: signal...// for region R0)

87

* you can use single line comments //and multi line comments /* */// as you like

88

89

{{{signal A, B, C; // three signals

90

input in1 := "5" : INT; // a signal with initial value

91

output out1 := "10" combine INT with +;

92

input output inout1 combine "uint8_t" with "combine_signals_fancy(x, y)"; // host combine operators can be fancy

93

output sig1, sig2 := "3" combine FLOAT with *;

94

R0: signal reg1, reg2, var var1, var2;

95

R0: var var3, var4;

96

R0: signal reg3, reg4;

97

}}}

98

99

== Action Label Parser ==

100

101

* Action and Transition labels get automatically parsed and checked for correctness by a complex parser.

102

* The label language mainly follows Esterel and E-Studio label Syntax.

103

* For details, see

104

** [[full label syntax grammar in Xtext notation>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/kieler/browser/plugins/de.cau.cs.kieler.synccharts.labelparser/src/de/cau/cs/kieler/synccharts/labelparser/ActionLabel.xtext||shape="rect" class="source"]]

105

** [[full label syntax grammar in EBNF notation>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/kieler/export/HEAD/plugins/de.cau.cs.kieler.xtext.docgenerator/src-gen/de.cau.cs.kieler.synccharts.labelparser.ActionLabel.html||shape="rect" class="export"]].

106

107

==== General Form ====

108

109

{{{Action:

110

(isImmediate?='#')? (delay=INT)? (trigger=BooleanExpression)? ("/" (effects+=Effect (',')? )*)?;

111

}}}

112

113

* Example: # A or B / C, varD:=5 , or more complex:

114

115

{{{A and B and C or D and not E or (43<?F) or (varA = 103) and not (B and (C or D)) / G, H(23) I, varB:=104

116

}}}

117

* isImmediate: flag that indicates that the transition has to be tested immediately after the state has been entered. Especially in the same tick. By default, a transition is only tested beginning from the next tick.

118

* delay: counter that specifies the number of times that the trigger has to be evaluated to true before the transiton is taken. Example: 10 SECOND / ALARM.

119

** Note: immediate and delay are mutual exclusive.

120

* Trigger: A boolean expression that is the guard of the transition (details below)

121

* Effects: A comma- or whitespace-separated list of effects that get executed when the transition is taken (details below).

==== Trigger ====

>Trigger are boolean expressions over Signals and value comparisons that guard actions and transitions. They can comprise the following elements:

126

127

* Simple Signal references:

{{{A

}}}

* Boolean expressions of Signals with usual precedence rules (not, and, or), e.g. these are equal

132

133

{{{A and B or not C and D

134

}}}

135

136

{{{(A and B) or ((not C) and D)

137

}}}

138

* Valued Signals and Variables can be used in conditions in these boolean expressions

139

** Valid comparison operators: = , < , <= , > , >=

140

** Value operator for valued signals: VAL="?", example: ?A

** Examples:

{{{variableX < 5

}}}

{{{?B = 3

}}}

* Comparisons may contain arithmetic expressions with usual precedence rules with the operators +,-,*,/,mod

149

150

{{{?B < (variableX + (2 * ?C))

151

}}}

152

* Comparisons can be mixed into the boolean trigger expressions arbitrarily

153

154

{{{A and (3 > ?B) or ((var5 + 2) = 6)

155

}}}

156

* The **pre**operator will give the value of a signal of the instance of one tick behind, both in value or presence domain

{{{A and pre(B)

}}}

{{{3 < pre(?A)

}}}

==== Effects ====

* Effects get executed when a transition is taken (i.e. when its guard evaluates to true).

167

* They get separated from the trigger by a '/' symbol.

168

* Possible effects are Signal Emissions and Variable Assignments:

169

* Emission of a simple signal:

{{{/ A

}}}

* Emission of value of a valued Signal:

{{{/ A(3)

}}}

* Assignment of a variable:

{{{/ varA := 42

}}}

* Multiple effects get comma- or whitespace separated:

182

183

{{{/ A, B, C(25), varA := 2

184

}}}

185

* New values may use value expressions as explained above:

186

187

{{{/ A(3 + pre(?B)), varC := (varD + 1)

}}}

==== Host Code ====

>If the action label syntax is not expressive enough, you can escape to any host-language, e.g. C, Java or whatever syntax.

193

194

* Use quotes to indicate host code

195

196

{{{'This is host code in the trigger' / 'this in an effect'

197

}}}

198

* It can be mixed with other expressions

199

200

{{{A and 'HostCode' / B, C(23), D('yet another Host Code'), 'EvenMore'

201

}}}

202

* In parantheses the type of host code (e.g. the used language) may be given (optional)

203

204

{{{B or 'MyCConstant'(C) / 'object.execute(xyz)'(Java)

}}}

== Naming ==

* Regions and States have IDs, that should be unique in their context (e.g. state IDs have to be unique within the same Region but not globally)

210

* States also have visible labels which in general is the name of the state. However, this label may be blank. In order to address all states correctly, IDs should not be blank.

211

* An automatic mechanism sets IDs automatically

212

** the ID gets the label of the state where all whitespace is replaced by underscores '_'

213

** an empty label results in an auto-generated ID like "S0", "S1", "S2", ...

== Validation ==

* Finally, you should regularly test if your syncChart is correct. To do this, click on Diagram->Validate. Inconsistencies in your diagram are indicated by little red icons and also an entry in the problems view. Note that the validation may still be incomplete and not be able to point out all errors.

218

* Your diagram gets validated automatically whenever it is saved.

219

* For details on the checks performed see the [[Checkfile in Xtend Check language syntax>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/kieler/browser/plugins/de.cau.cs.kieler.synccharts/model/SyncchartsChecks.chk||shape="rect" class="source"]].

220

221

== Differences to the original SyncCharts ==

222

223

* There is no initial connector, instead a state itself can be initial, by setting the isInitial property to true.

224

* There is no history connector, instead this is a transition property (isHistory).

== Copy & Paste ==

[[~[~[image:url:http://trac.rtsys.informatik.uni-kiel.de/trac/kieler/browser/models/synccharts/copy_paste.png?format=raw~]~]>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/kieler/browser/models/synccharts/copy_paste.png||shape="rect"]]

229

230

Copy & Paste gives some extra functionality, as it allows to copy many graphical objects into many target objects. See the image as an example. In the image, nodes, edges or regions denoted with "S" are selected elements (sources) for the copy operation and "T" are selected elements for the paste operation (targets). Elements without label are just dummy elements.

|(((

Source/Target?

)))|(((

State

)))|(((

Region

)))|(((

Transition

)))

|(((

State

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

244

(((

245

replace, keep all transitions

246

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

247

(((

248

add State to Region

249

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

250

(((

251

insert, old Transition stick with source

)))

|(((

Region

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

256

(((

257

insert

258

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

259

(((

260

replace, if root: create state and insert

261

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

262

(((

263

insert, old Transition stick with source

)))

|(((

Transition

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

268

(((

269

add as selfloop

270

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

271

(((

272

create dummy States and connect

273

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

(((

replace

)))

|(((

States

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

280

(((

281

replace, discard transitions

282

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

283

(((

284

add States to Region

285

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

286

(((

287

insert, old Transition stick with source

)))

|(((

Regions

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

292

(((

293

insert

294

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

295

(((

296

replace, if root: create state and insert

297

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

298

(((

299

insert, old Transition stick with source

)))

|(((

Transitions

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

304

(((

305

add as selfloops

306

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

307

(((

308

create dummy States and connect

309

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

(((

replace with all

)))

|(((

Source/Target?

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

317

(((

318

States

319

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

320

(((

321

Regions

322

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

(((

Transitions

)))

|(((

State

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

329

(((

330

replace each

331

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

332

(((

333

insert into each

334

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

(((

insert into each

)))

|(((

Region

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

341

(((

342

insert into each

343

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

344

(((

345

replace each, if root: do nothing

346

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

(((

insert into each

)))

|(((

Transition

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

353

(((

354

Connect 2 states

355

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

356

(((

357

add two dummy states with transition in each

358

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

(((

replace each

)))

|(((

States

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

365

(((

366

replace each with all

367

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

368

(((

369

insert all into each

370

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

(((

insert into each

)))

|(((

Regions

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

377

(((

378

insert all into each

379

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

380

(((

381

replace each with all

382

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

(((

insert into each

)))

|(((

Transitions

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

389

(((

390

Connect 2 states with all

391

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

392

(((

393

add two dummy states with all transition in each

394

)))|(% style="text-align: right;" %)(% style="text-align: right;" %)

395

(((

396

replace each with all

397

)))

398

399

Wiki source code of ThinKCharts User Guide

Navigation

Quick Links