Documentation

== Trains ==

Each train has a trainnumber. The trainnumber is for prioritization, when multiple trains compete for the same track. Lower numbers mean higher priorities, e.g. train 0 has the highest priority. Priorities can't be changed dynamicly.

4

Each train has one home-track at each station.

5

6

=== Train numbering ===

7

8

Variable **trainNum** is used to identify trains.

9

10

The assignment of numbers to trains is chosen as followed

|=(((

trainNum

)))|=(((

Starting track

)))

|(((

0

)))|(((

KH_ST_1

)))

|(((

1

)))|(((

KH_ST_2

)))

|(((

2

)))|(((

KH_ST_3 (r)

)))

|(((

3

)))|(((

KH_ST_4 (r)

)))

|(((

4

)))|(((

IC_ST_3

)))

|(((

5

)))|(((

IC_ST_2

)))

|(((

6

)))|(((

OC_ST_2

)))

|(((

7

)))|(((

OC_ST_1

)))

|(((

8

)))|(((

KH_ST_5

)))

|(((

9

)))|(((

IC_ST_1

)))

|(((

10

)))|(((

OC_ST_3

)))

== Logging ==

Variable **debug** indicates verbose logging.

76

77

Prefix of all log messages must be :** [trainnum][ST-ST]**

78

79

Use **println** function to produce textual output. Do not use printf or other io functions, because output may not be flushed correctly.

== Tracks ==

Stopping on tracks without contacts is permitted. Therefore they must be reserved and used with an adjacent track.

84

Each station has one drive-through track for each possible direction:

|=(((

station

)))|=(((

drive-through track

)))

|(((

IC_station

)))|(((

IC_ST_1

)))

|(((

OC_station

)))|(((

OC_ST_3

)))

|(((

KH_station

)))|(((

KH_ST_5

)))

|(% colspan="1" %)(% colspan="1" %)

107

(((

108

KH_station(r)

109

)))|(% colspan="1" %)(% colspan="1" %)

(((

KH_ST_1

)))

=== Station-to-Station ===

115

116

Fuctions **void railArrival(int train, int station)** and **int railDeparture(int train)** should be used at the end of every Station-to-Station-Controller.

117

118

At the end of every Station-to-Station-Controller the trains should stand in one station, because every controller starts with the train in standstill.

119

120

Contact reading in triggers should only used when it is clearly determined which train will fire the contact.

121

122

=== TrainController ===

123

124

Train-Schedules should be modelled by putting together the Station-to-Station-Controllers for every train in individual regions.

=== Speed: ===

* SLOW: for the stations

129

* CAUTION: for slowdown (and optional points)

130

* NORMAL: for the other tracks

== Codestyle ==

Use entry-/exit-actions instead of actions on transitions, if possible.

135

If using hostcode, only use functions delivered by our own C-Interface and not the Höhrmann-API.

136

137

== Mutual Exclusion ==

138

139

bool <track>_req[<trainAmount>] contains the requests for each track and train. Before the availability of arrays, we used bool <train>_<track>_req.

140

int <track>_perm contains the trainnumber of the train, who is allowed to drive on <track>.

141

142

== Deadlock Prevention ==

143

144

An example controller for deadlock prevention is located in// rail-repo: docs/deadlocks/resolve_deadlock.sct//

145

146

Sidings should only be used in one direction.

147

148

Trains trying to leave a station in order to use KIO_LN_0 or KIO_LN_1 should, if they do not receive the locks for all segments, release them for two ticks.

= C Controller =

The C controller wraps the basic railway interface and creates an correct environment to run the generated controller.

== Make Script ==

A make script written in Python is located in rail-repo: code/make.py