diff options
| author | ywang <yw05@forksworld.de> | 2021-11-07 19:01:45 +0100 |
|---|---|---|
| committer | ywang <yw05@forksworld.de> | 2021-11-07 19:01:45 +0100 |
| commit | 3f6cef730838ed9ab20e445e4078ecc504f1e72e (patch) | |
| tree | 076fa3be47fb0ed701275664209ec6cd022068c9 | |
| parent | 3c92fa597cf5b0baf1ccbcb673e51a205ba6dbdb (diff) | |
| download | advtrains-3f6cef730838ed9ab20e445e4078ecc504f1e72e.tar.gz advtrains-3f6cef730838ed9ab20e445e4078ecc504f1e72e.tar.bz2 advtrains-3f6cef730838ed9ab20e445e4078ecc504f1e72e.zip | |
Add documentation on signal aspects
| -rw-r--r-- | advtrains/doc/advtrains_speed_lessp.3advtrains.md | 2 | ||||
| -rw-r--r-- | advtrains/doc/advtrains_speed_set_restriction.3advtrains.md (renamed from advtrains/doc/advtrains_speed_merge_aspect.3advtrains.md) | 2 | ||||
| -rw-r--r-- | advtrains/doc/signal_aspect.7advtrains.md | 24 |
3 files changed, 26 insertions, 2 deletions
diff --git a/advtrains/doc/advtrains_speed_lessp.3advtrains.md b/advtrains/doc/advtrains_speed_lessp.3advtrains.md index 165d028..663aa42 100644 --- a/advtrains/doc/advtrains_speed_lessp.3advtrains.md +++ b/advtrains/doc/advtrains_speed_lessp.3advtrains.md @@ -1,4 +1,4 @@ -% advtrains.speed.lessp(3advtrains) | Advtrains Developer's Manual +% advtrains_speed_lessp(3advtrains) | Advtrains Developer's Manual # NAME `advtrains.speed.lessp`, `advtrains.speed.greaterp`, `advtrains.speed.not_lessp`, `advtrains.speed_not_greaterp`, `advtrains.speed.equalp`, `advtrains.speed.not_equalp`, `advtrains.speed.max`, `advtrains.speed.min` - speed restriction comparison functions diff --git a/advtrains/doc/advtrains_speed_merge_aspect.3advtrains.md b/advtrains/doc/advtrains_speed_set_restriction.3advtrains.md index 02e83ea..b3183c6 100644 --- a/advtrains/doc/advtrains_speed_merge_aspect.3advtrains.md +++ b/advtrains/doc/advtrains_speed_set_restriction.3advtrains.md @@ -1,4 +1,4 @@ -% advtrains.speed.set_restriction(3advtrains) | Advtrains Developer's Manual +% advtrains_speed_set_restriction(3advtrains) | Advtrains Developer's Manual # NAME `advtrains.speed.set_restriction`, `advtrains.speed.merge_aspect` - modify speed restriction diff --git a/advtrains/doc/signal_aspect.7advtrains.md b/advtrains/doc/signal_aspect.7advtrains.md new file mode 100644 index 0000000..827760d --- /dev/null +++ b/advtrains/doc/signal_aspect.7advtrains.md @@ -0,0 +1,24 @@ +% signal_aspect(7advtrains) | Advtrains Developer's Manual + +# DESCRIPTION + +The signal aspect table used by advtrains has the following fields: + +* `main`: The main speed restriction +* `dst`: The `main` aspect of the distant signal (not implemented) +* `type`: The type of speed restriction given by the signal +* `shunt`: Whether shunting is allowed +* `proceed_as_main`: Whether to proceed without shunting + +The `main` and `dst` fields may contain the following values: +* `-1`: No speed restriction +* `nil`: No information is available + +The `type` field can be any valid table index, but it should usually be one of the following values: +* "main": The main signal aspect used before the introduction of speed restriction types. This is the default value if the `type` field is absent. +* "line": The speed limit for the physical line. +* "temp": The speed limit that is temporarily introduced. + +# NOTES + +A signal with the `main` aspect of zero should not provide distant signal aspect. |