Wiki source code of Project Guidelines
Version 9.1 by stu114053 on 2017/05/16 18:27
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | = Project Management = | ||
| 2 | |||
| 3 | The general project **meeting** takes place in the **Railwayroom, Tuesday at 16:00.** | ||
| 4 | |||
| 5 | = Development Environment = | ||
| 6 | |||
| 7 | == KIELER == | ||
| 8 | |||
| 9 | Use the[[ KIELER Nightly Build>>url:http://rtsys.informatik.uni-kiel.de/~~kieler/files/nightly/sccharts/||shape="rect"]]. Keep your version up-to-date. | ||
| 10 | You can update to a new version from within your running installation via **Help > Check for updates**. Thus it is not necessary to download the KIELER archive every time. | ||
| 11 | |||
| 12 | Use UTF-8 as codepage (**especially when using Windows**): | ||
| 13 | |||
| 14 | * General > Workspace | ||
| 15 | ** Text file encoding: UTF-8 | ||
| 16 | |||
| 17 | It may be helpful to configure the following settings to avoid //Resource is out of sync// warnings in Eclipse: | ||
| 18 | |||
| 19 | * General > Workspace | ||
| 20 | ** Refresh using native hooks or polling: Check | ||
| 21 | ** Refresh on access | ||
| 22 | ** Save automatically before build | ||
| 23 | |||
| 24 | = Code Style = | ||
| 25 | |||
| 26 | == General == | ||
| 27 | |||
| 28 | Use an indentation of 2 Spaces: | ||
| 29 | |||
| 30 | * General > Text Editors | ||
| 31 | ** Insert Spaces for Tabs: Check | ||
| 32 | ** Displayed Tab Width: 2 | ||
| 33 | |||
| 34 | == SCT Style == | ||
| 35 | |||
| 36 | Use the following conventions when modeling an SCChart: | ||
| 37 | |||
| 38 | * General order | ||
| 39 | ** inputs first | ||
| 40 | ** outputs second | ||
| 41 | ** internal variables third | ||
| 42 | ** regions and states afterwards | ||
| 43 | * Name all regions if you have at least two (no implicit region, unless there is only one) | ||
| 44 | * Naming | ||
| 45 | ** For semantically relevant names, use lower case with underscores (e.g. //state some_long_state_name//) | ||
| 46 | ** For labels and stuff that is intended to increase readability, use more natural english (e.g. //state some_long_state_name "Wait for orders"//) | ||
| 47 | |||
| 48 | {{code language="sct" title="SCT Code Style" linenumbers="true"}} | ||
| 49 | scchart { | ||
| 50 | |||
| 51 | input bool trigger; | ||
| 52 | input int array[10]; | ||
| 53 | output bool action0, action1; | ||
| 54 | int fun; | ||
| 55 | |||
| 56 | region first_region "Have fun": | ||
| 57 | // State example | ||
| 58 | initial state example_state | ||
| 59 | --> example_state immediate "Having fun" | ||
| 60 | with trigger | ||
| 61 | / action0 = true | ||
| 62 | ; action1 = false | ||
| 63 | ; fun++ | ||
| 64 | |||
| 65 | |||
| 66 | --> example_state immediate "Having fun" | ||
| 67 | with trigger | ||
| 68 | / action0 = true | ||
| 69 | ; action1 = false | ||
| 70 | ; fun-- | ||
| 71 | ; | ||
| 72 | |||
| 73 | // Region | ||
| 74 | region second_region "Do nothing concurrently": | ||
| 75 | |||
| 76 | initial state init; | ||
| 77 | } | ||
| 78 | {{/code}} | ||
| 79 | |||
| 80 | == Build Settings == | ||
| 81 | |||
| 82 | To have the simulation and SCT build correctly via Prom, one has to modify the Prom environment that builds the project: | ||
| 83 | |||
| 84 | * Preferences > KIELER SCCharts > Execution Environments | ||
| 85 | ** Select //Generic// | ||
| 86 | ** Select tab //Compilation// | ||
| 87 | ** Select// kieler-gen// as //target directory// | ||
| 88 | ** Set //Snippets directory// to //snippets// | ||
| 89 | |||
| 90 | == Git == | ||
| 91 | |||
| 92 | Use git. | ||
| 93 | |||
| 94 | Pull before you start coding. | ||
| 95 | |||
| 96 | Add a commit message. | ||
| 97 | |||
| 98 | In case of non-trivial conflicts: ask. | ||
| 99 | |||
| 100 | \\ |