diff options
Diffstat (limited to 'src/log.h')
0 files changed, 0 insertions, 0 deletions
#LyX 2.2 created this file. For more info see http://www.lyx.org/
\lyxformat 508
\begin_document
\begin_header
\save_transient_properties true
\origin unavailable
\textclass paper
\use_default_options true
\maintain_unincluded_children false
\language english
\language_package default
\inputencoding auto
\fontencoding global
\font_roman "default" "default"
\font_sans "default" "default"
\font_typewriter "default" "default"
\font_math "auto" "auto"
\font_default_family default
\use_non_tex_fonts false
\font_sc false
\font_osf false
\font_sf_scale 100 100
\font_tt_scale 100 100
\graphics default
\default_output_format default
\output_sync 0
\bibtex_command default
\index_command default
\paperfontsize default
\spacing single
\use_hyperref false
\papersize default
\use_geometry true
\use_package amsmath 1
\use_package amssymb 1
\use_package cancel 1
\use_package esint 1
\use_package mathdots 1
\use_package mathtools 1
\use_package mhchem 1
\use_package stackrel 1
\use_package stmaryrd 1
\use_package undertilde 1
\cite_engine basic
\cite_engine_type default
\biblio_style plain
\use_bibtopic false
\use_indices false
\paperorientation portrait
\suppress_date false
\justification true
\use_refstyle 1
\index Index
\shortcut idx
\color #008000
\end_index
\leftmargin 1cm
\topmargin 1cm
\rightmargin 1cm
\bottommargin 1cm
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
\paragraph_indentation 0bp
\quotes_language english
\papercolumns 1
\papersides 1
\paperpagestyle default
\tracking_changes false
\output_changes false
\html_math_output 0
\html_css_as_file 0
\html_be_strict false
\end_header
\begin_body
\begin_layout Title
Minetest Mod - Advanced Trains [advtrains]
\end_layout
\begin_layout Title
Interlocking System Guide
\end_layout
\begin_layout Section
Introduction
\end_layout
\begin_layout Standard
In real-world railways, a so-called interlocking system is a set of railway
signals and trackside equipment.
Its purpose is to prevent conflicting train movements which otherwise could
result in derailing or colliding trains.
If you want more information, just search for
\begin_inset Quotes eld
\end_inset
railway interlocking
\begin_inset Quotes erd
\end_inset
on the internet.
\end_layout
\begin_layout Standard
Real-world interlocking systems perform this task by setting routes.
A route is a path along a track that a train can safely pass.
To set a route for a train, the signalman (the operator of a signal box)
has to set switches (turnouts) to the correct position and lock them in
order to make a signal for a train show
\begin_inset Quotes eld
\end_inset
Proceed
\begin_inset Quotes erd
\end_inset
.
In newer systems, this is done automatically by the interlocking system.
A route can not be set if switches are locked to a wrong position by another
route or if any portion of the route is occupied by a train.
\end_layout
\begin_layout Standard
The interlocking system in this Minetest mod tries to follow real-world
interlocking systems as far as applicable.
It divides tracks into track sections and implements a route setting mechanism
following the same principle.
\end_layout
\begin_layout Standard
However, for the sake of simplicity of implementation and usage, not all
concepts of real-world interlocking have been taken over.
Especially, there is no mechanism for overlap.
\end_layout
\begin_layout Standard
If you are looking for a place to learn how real-world interlocking systems
work, have a look at
\begin_inset Quotes eld
\end_inset
SimSig
\begin_inset Quotes erd
\end_inset
.
By looking at their simulations, you can obtain experience on how to set
up your own interlocking systems in AdvTrains.
The SimSig glossary is a good place to look up unknown terms in this document.
\end_layout
\begin_layout Section
Setting up track sections
\end_layout
\begin_layout Standard
In the real world, a line of track is divided into so-called track sections,
or track circuits.
Those systems often can not tell where exactly a train is, but only which
track sections it occupies.
A route can never be set through an occupied track section.
\end_layout
\begin_layout Standard
A track section often covers:
\end_layout
\begin_layout Itemize
A section on a main running line, between two signals
\end_layout
\begin_layout Itemize
A single turnout
\end_layout
\begin_layout Itemize
A rail crossing, or a set of turnouts acting as a double/single slip switch
\end_layout
\begin_layout Itemize
A siding
\end_layout
\begin_layout Standard
You will find some examples on how to interlock certain patterns later.
\end_layout
\begin_layout Subsection
Track Circuit Breaks
\end_layout
\begin_layout Standard
In this mod, you will not directly configure the locations of track sections.
Instead, you designate the borders of each track section using a special
node, the Track Circuit Break, abbreviated TCB.
\end_layout
\begin_layout Standard
For example, if you want to create a track section for a piece of a main
running line, you set up two TCBs at the ends of this track circuit.
\end_layout
\begin_layout Standard
Setting up a TCB works as follows:
\end_layout
\begin_layout Enumerate
Place a TCB node somewhere near the place where the circuit break is going
to be located.
\end_layout
\begin_layout Enumerate
Right-click the TCB node
\end_layout
\begin_layout Enumerate
Punch the rail which should act as TCB
\end_layout
\begin_layout Standard
The result should look like this:
\end_layout
\begin_layout Standard
\begin_inset Graphics
filename lyx_img/screenshot_20180830_142551.png
width 10cm
\end_inset
\end_layout
\begin_layout Standard
Now you have assigned the TCB node to a rail.
Right-click the TCB node once again.
This will bring up a form which looks as follows:
\end_layout
\begin_layout Standard
\begin_inset Graphics
filename lyx_img/Bildschirmfoto_2018-08-30_14-26-35.png
width 10cm
\end_inset
\end_layout
\begin_layout Standard
You see that the form is divided in side A and side B.
To designate where each side is, a marker is displayed on the rail.
You can always make this marker show up by punching the TCB node, and remove
it by punching the marker.
Both sides are shown as
\begin_inset Quotes eld
\end_inset
End of interlocking
\begin_inset Quotes erd
\end_inset
.
This means that there is no track section set up at this place.
\end_layout
\begin_layout Standard
You should repeat this procedure once again a few meters away from the first
TCB to create a second TCB on the same track.
\end_layout
\begin_layout Standard
\begin_inset Graphics
filename lyx_img/Bildschirmfoto_2018-08-30_14-32-48.png
width 10cm
\end_inset
\end_layout
\begin_layout Standard
Once you have both bordering TCBs set up, you can now create the actual
track section.
To do this:
\end_layout
\begin_layout Enumerate
Right-click one of the TCBs
\end_layout
\begin_layout Enumerate
Locate the correct side (A or B) to create the track section
\end_layout
\begin_layout Enumerate
Click
\begin_inset Quotes eld
\end_inset
Create interlocked Track Section
\begin_inset Quotes erd
\end_inset
in the formspec on the chosen side.
\end_layout
\begin_layout Standard
Now, the text on the formspec has changed.
It shows something like this:
\end_layout
\begin_layout Standard
\begin_inset Graphics
filename lyx_img/Bildschirmfoto_2018-08-30_14-27-25.png
width 5cm
\end_inset
\end_layout
\begin_layout Standard
Clicking
\begin_inset Quotes eld
\end_inset
Show Track Section
\begin_inset Quotes erd
\end_inset
brings up another formspec:
\end_layout
\begin_layout Standard
\begin_inset Graphics
filename lyx_img/Bildschirmfoto_2018-08-30_14-28-32.png
width 5cm
\end_inset
\end_layout
\begin_layout Standard
On the top, you see a list of all TCBs that border this track section.
In your case, there should be two TCBs listed.
If there's only one, head over to
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Long-track-sections,"
\end_inset
.
You should now select a name for the track section, to identify it later.
\end_layout
\begin_layout Standard
The same procedure is applicable when you create a turnout track section,
except that you have to set up three or more TCBs.
\end_layout
\begin_layout Standard
The AdvTrains interlocking system allows you to add more TCBs after you
have created a track section.
This works without problems in most cases.
For example, you can easily insert a turnout into an already set-up track
section and create another TCB behind it, and AdvTrains will automatically
detect the existing track section.
Problems arise only if you try to insert a TCB in-between a section, in
which case both sides of the TCB will end up assigned to the same section.
The code currently does not handle this case properly, so try to avoid
this situation by all means.
As a last resort, you can always dissolve a faulty track section, as described
in the next chapter.
\end_layout
\begin_layout Subsection
Long track sections, crossings and other edge cases
\begin_inset CommandInset label
LatexCommand label
name "subsec:Long-track-sections,"
\end_inset
\end_layout
\begin_layout Subsubsection
Very long track sections
\end_layout
\begin_layout Standard
If you try to set up a track section that is longer than 1000 nodes, advtrains
won't recognize the TCB at the other end because of a safety limit in the
traverser function, which is supposed to prevent deadlocks.
This case has happened when the Track Section overview screen only shows
one TCB in the list.
The procedure for this is as follows:
\end_layout
\begin_layout Enumerate
Go to the second TCB (the one that wasn't recognized).
It should show
\begin_inset Quotes eld
\end_inset
End of Interlocking
\begin_inset Quotes erd
\end_inset
on the relevant side.
\end_layout
\begin_layout Enumerate
Click
\begin_inset Quotes eld
\end_inset
Create interlocked track section
\begin_inset Quotes erd
\end_inset
.
The section created will be different from the one that is already present.
\end_layout
\begin_layout Enumerate
In the track section overview, click
\begin_inset Quotes eld
\end_inset
Join into other section
\begin_inset Quotes erd
\end_inset
\end_layout
\begin_layout Enumerate
Go back to the first TCB, bring up the Track Section overview screen of
the first track section and click
\begin_inset Quotes eld
\end_inset
Join with ???
\begin_inset Quotes erd
\end_inset
\end_layout
\begin_layout Standard
The other, missing TCB should now appear in the list.
If you accidentally started such a joining procedure, click the
\begin_inset Quotes eld
\end_inset
X
\begin_inset Quotes erd
\end_inset
button on the right.
\end_layout
\begin_layout Subsubsection
Rail crosses
\end_layout
\begin_layout Standard
Since rail crosses are created by laying tracks across each other without
logical connection, there's no way for advtrains to know whether rails
cross each other.
\end_layout
\begin_layout Standard
Rail crossings in interlocking systems are always one single track section,
which in most cases has 4 TCBs adjacent.
\end_layout
\begin_layout Standard
\begin_inset Graphics
filename lyx_img/Bildschirmfoto_2018-08-30_14-51-25.png
width 5cm
\end_inset
\end_layout
\begin_layout Standard
The procedure is quite similar to the one for long sections: First, create
two track sections for the branches, and then use the
\begin_inset Quotes eld
\end_inset
Join
\begin_inset Quotes erd
\end_inset
function to merge both sections into one.
\end_layout
\begin_layout Subsubsection
Deleting and re-adding single TCBs to a section
\end_layout
\begin_layout Standard
In some occasions, for example when you remove a siding or a crossover,
it can be necessary to unassign a TCB from a track section.
There are multiple ways to do this:
\end_layout
\begin_layout Itemize
In the TCB form, click the
\begin_inset Quotes eld
\end_inset
Remove from section
\begin_inset Quotes erd
\end_inset
button
\end_layout
\begin_layout Itemize
In the track section form, first select the TCB in the list and then click
\begin_inset Quotes eld
\end_inset
Unlink selected TCB
\begin_inset Quotes erd
\end_inset
\end_layout
\begin_layout Standard
The result is that the TCB shows
\begin_inset Quotes eld
\end_inset
End of Interlocking
\begin_inset Quotes erd
\end_inset
and the section does not list the TCB as an endpoint anymore.
\end_layout
\begin_layout Standard
The other case is adding a siding or a crossover, in which case one or more
TCBs still show
\begin_inset Quotes eld
\end_inset
End of Interlocking