TimeTable: Difference between revisions
No edit summary |
No edit summary |
||
| (18 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{DeveloperNav}} | |||
This table defines the train schedule and supports a wide range of features for delivering realistic traffic. | This table defines the train schedule and supports a wide range of features for delivering realistic traffic. | ||
| Line 33: | Line 36: | ||
:(int) | :(int) | ||
:Database ID of the train this train depends on - this means that the specified train must have already left the simulation for this train to spawn. | :Database ID of the train this train depends on - this means that the specified train must have already left the simulation for this train to spawn. | ||
:Groups for trains depending on each other are defined in the TrainUnits table | |||
;DependsOnDelay | ;DependsOnDelay | ||
:(int) | :(int) | ||
:Defines the length of time between the first train despawning and this train spawning. Value is in minutes. | :Defines the length of time between the first train despawning and this train spawning. Value is in minutes. | ||
:No value is a default of 30 minutes. | |||
;RequiresTrain | |||
:(int) | |||
:Database ID of the train this train requires and depends on - this means that the specified train must have entered and have left the simulation for the next train belonging to the same group to spawn. | |||
:The train requiring and depending on a train must also have the same database ID filled in in DependsOnTrain | |||
:Groups for trains depending on each other are defined in the TrainUnits table | |||
;EntryPoint | ;EntryPoint | ||
:(string) | :(string) | ||
:For spawning trains, this is the name of the spawn track. This can be left empty for trains that do not spawn. | :For spawning trains, this is the name of the spawn track. This can be left empty for trains that do not spawn. | ||
:The simulations that feature Line Operations can use a common timetable database. When a common database is applied the format is slightly different | |||
Example - KRE,SPAWN_BROHL_0;KBBG,SPAWN_REMAGEN_0;KB,SPAWN_GODESBERG_0 | |||
:Each spawning point is pre-fixed with the shortcode of the simulation followed by a comma (,). Each spawing point is then separated by an semicolon (;) | |||
;EntryPoint_time | ;EntryPoint_time | ||
:(date) | :(date) | ||
:Defines the time the train actually spawns. | :Defines the time the train actually spawns. Stand-alone simulations. | ||
:(string) | |||
:Defines the time the train actually spawns. For simulations that feature Line Operations. | |||
Example - KRE,07:27;KBBG,07:27;KB,07:27 | |||
:Each spawning time is pre-fixed with the shortcode of the simulation followed by a comma (,). Each spawing time is then separated by an semicolon (;) | |||
;ExtraordinaryTrack | ;ExtraordinaryTrack | ||
| Line 53: | Line 71: | ||
:(int) | :(int) | ||
:Defines the direction of the train when being placed. 0 = left, 1 = right. | :Defines the direction of the train when being placed. 0 = left, 1 = right. | ||
;outOfGaugeType | |||
:defines the type of out-of-gauge train. Currently only A,B,C,D for Germany are implemented | |||
;outOfGaugeInstructions | |||
:defines various special instructions for this out-of-gauge train. | |||
:currently implemented: "TR:123AT_124AT_125AT" will create list in fax with "tracks train needs to follow to avoid collisions". | |||
;ConsistTemplateID | ;ConsistTemplateID | ||
| Line 61: | Line 86: | ||
:(int) | :(int) | ||
:Used to indicate the path template to use for routing the train. | :Used to indicate the path template to use for routing the train. | ||
;PathTemplateIDLeft | |||
:(int) | |||
:''(optional)'' | |||
:Used to indicate the path template to use for routing the train when it is going in a '''left-ward''' direction. Useful for a train that requires a different path depending on which direction it's going. | |||
;PathTemplateIDRight | |||
:(int) | |||
:''(optional)'' | |||
:Used to indicate the path template to use for routing the train when it is going in a '''right-ward''' direction. Useful for a train that requires a different path depending on which direction it's going. | |||
;Origin | ;Origin | ||
| Line 81: | Line 116: | ||
:(string) | :(string) | ||
:The name of the exit spawn track. | :The name of the exit spawn track. | ||
;SteeringHints | |||
:(string) | |||
:Provides additional steering information for specific trains. This information is needed to assist the coworkers to give more accurate prompting. It also is used during the pre-simulation process to automatically route traffic more accurately. | |||
:The data is semi-colon delimited. Each item is composed of three things: the station code, a signal name, and a track name. The train is then routed from that signal to the given track. Example: | |||
KB;A902;207AT | |||
:This specifies that in Bonn, the train should be routed from signal A902 to track 207AT. | |||
:Multiple entries are separated by semicolons: | |||
STATION;SIGNAL1;TRACK1;STATION;SIGNAL2;TRACK2;STATION;SIGNAL3;TRACK3 | |||
:The station entry may be left empty if the layout does not have a station code defined: | |||
;SIGNAL1;TRACK1;;SIGNAL2;TRACK2;;SIGNAL3;TRACK3 | |||
;TimeTableStops | ;TimeTableStops | ||
:(string) | :(string) | ||
:Encodes all the data needed to describe all the timetable stops. | :Encodes all the data needed to describe all the timetable stops. The format of the timetable stops can be found [[TimeTableStops|here]]. | ||
;EngineeringTrain | ;EngineeringTrain | ||
| Line 152: | Line 206: | ||
;Communication | ;Communication | ||
:(string) | :(string) | ||
: | :Undocumented. | ||
;Skip | ;Skip | ||
| Line 161: | Line 215: | ||
:(int) | :(int) | ||
:Type of driver as defined in DriverType table. | :Type of driver as defined in DriverType table. | ||
;ActivityCode | |||
:(string) | |||
:Semi-colon delimited list of "activity codes" or "traffic codes." When an activity code is made active, trains with an activity code in this column become '''active'''. Refer to the article on [[Traffic Codes|Traffic Codes]] for more information. | |||
;InactivityCode | |||
:(string) | |||
:Semi-colon delimited list of "activity codes" or "traffic codes." When an activity code is made active, trains with an activity code in this column become '''inactive'''. Refer to the article on [[Traffic Codes|Traffic Codes]] for more information. | |||
;SpawnInfo | |||
:(string) | |||
:''optional'' | |||
:Defines additional spawning behaviour. See [[SpawnInfo]]. | |||
There may be other fields in this table. Some of these fields are used to automatically generate the values in other fields, such as the TimeTableStops field. This is done with external tools that are separate from the simulation. Other fields are used only for the purpose of generating a printed timetable and are used by either passengers or dispatchers only and are not used by the simulation. As a timetable developer, you are free to add any fields you like for your own purposes. These fields will be ignored by the simulation. | |||
Commonly used extra fields are: | |||
*[...] = placeholder for timetablestop abbreviation. | |||
*[...]_arr | |||
This is the arrival time of that stop (if empty and _dep is filled, it's a starting or passing through train) | |||
*[...]_dep | |||
This is the departure time of that stop (if empty and _arr is filled, it's an arriving train only (ending)) | |||
*[...]_track | |||
The planned platformtrack for the sim. (5a/5b becomes 5) | |||
*[...]_nicetrack | |||
the planned platformtrack for the user print version | |||
*[...]_CTA | |||
the roll number for the PID's | |||
;MaxSpeed | |||
:(int) | |||
:When present, defines the maximum speed (in km/h) that a train can move. When ''not'' present, the train's max speed is calculated from the individual vehicles. This value is useful when the train should move slowly than otherwise is normal. | |||
{{ | {{DeveloperNavBottom}} | ||
Latest revision as of 01:16, 26 January 2016
Contents | Developers pages | Command Line Options | Timetables | Scenario Creation | Developing Installers
This table defines the train schedule and supports a wide range of features for delivering realistic traffic.
- ID
- (int)
- Automatically increments.
- Train_Type
- (string)
- Gives a name for the type of train. This string can be anything, and is displayed in the Train Overview window, and elsewhere.
- TrainPhysicsModelID
- (int)
- ID number from the TrainTypes table, defining the physics properties of the train.
- Train_ID_Tech
- (string)
- Identifier used to like with movement orders in the movement order table (Train_ID_SOFT). This allows for trains with the same train ID to have different movement orders.
- Train_ID
- (string)
- Is the train number.
- SortingTime
- (date)
- Used to sort the schedule.
- CrossingWithTrain
- (date)
- On a single line track the simulation will search for this train and ask before spawning if it has NOT arrived on the spawn track.
- DependsOnTrain
- (int)
- Database ID of the train this train depends on - this means that the specified train must have already left the simulation for this train to spawn.
- Groups for trains depending on each other are defined in the TrainUnits table
- DependsOnDelay
- (int)
- Defines the length of time between the first train despawning and this train spawning. Value is in minutes.
- No value is a default of 30 minutes.
- RequiresTrain
- (int)
- Database ID of the train this train requires and depends on - this means that the specified train must have entered and have left the simulation for the next train belonging to the same group to spawn.
- The train requiring and depending on a train must also have the same database ID filled in in DependsOnTrain
- Groups for trains depending on each other are defined in the TrainUnits table
- EntryPoint
- (string)
- For spawning trains, this is the name of the spawn track. This can be left empty for trains that do not spawn.
- The simulations that feature Line Operations can use a common timetable database. When a common database is applied the format is slightly different
Example - KRE,SPAWN_BROHL_0;KBBG,SPAWN_REMAGEN_0;KB,SPAWN_GODESBERG_0
- Each spawning point is pre-fixed with the shortcode of the simulation followed by a comma (,). Each spawing point is then separated by an semicolon (;)
- EntryPoint_time
- (date)
- Defines the time the train actually spawns. Stand-alone simulations.
- (string)
- Defines the time the train actually spawns. For simulations that feature Line Operations.
Example - KRE,07:27;KBBG,07:27;KB,07:27
- Each spawning time is pre-fixed with the shortcode of the simulation followed by a comma (,). Each spawing time is then separated by an semicolon (;)
- ExtraordinaryTrack
- (string)
- Defines the track or tracks that trains may be placed at on simulation start. Multiple tracks are separated by spaces.
- ExtraordinaryDirection
- (int)
- Defines the direction of the train when being placed. 0 = left, 1 = right.
- outOfGaugeType
- defines the type of out-of-gauge train. Currently only A,B,C,D for Germany are implemented
- outOfGaugeInstructions
- defines various special instructions for this out-of-gauge train.
- currently implemented: "TR:123AT_124AT_125AT" will create list in fax with "tracks train needs to follow to avoid collisions".
- ConsistTemplateID
- (int)
- Defines the consist template from the ConsistTemplate table.
- PathTemplateID
- (int)
- Used to indicate the path template to use for routing the train.
- PathTemplateIDLeft
- (int)
- (optional)
- Used to indicate the path template to use for routing the train when it is going in a left-ward direction. Useful for a train that requires a different path depending on which direction it's going.
- PathTemplateIDRight
- (int)
- (optional)
- Used to indicate the path template to use for routing the train when it is going in a right-ward direction. Useful for a train that requires a different path depending on which direction it's going.
- Origin
- (string)
- Defines where the train is originally from.
- Destination
- (string)
- Defines where the train is ultimately destined.
- Start_NX
- (string)
- Where the train enters the simulation. This is often the name of the neighbouring station.
- End_NX
- (string)
- Where the train exits the simulation. This is often the name of the neighbouring station.
- ExitPoint
- (string)
- The name of the exit spawn track.
- SteeringHints
- (string)
- Provides additional steering information for specific trains. This information is needed to assist the coworkers to give more accurate prompting. It also is used during the pre-simulation process to automatically route traffic more accurately.
- The data is semi-colon delimited. Each item is composed of three things: the station code, a signal name, and a track name. The train is then routed from that signal to the given track. Example:
KB;A902;207AT
- This specifies that in Bonn, the train should be routed from signal A902 to track 207AT.
- Multiple entries are separated by semicolons:
STATION;SIGNAL1;TRACK1;STATION;SIGNAL2;TRACK2;STATION;SIGNAL3;TRACK3
- The station entry may be left empty if the layout does not have a station code defined:
;SIGNAL1;TRACK1;;SIGNAL2;TRACK2;;SIGNAL3;TRACK3
- TimeTableStops
- (string)
- Encodes all the data needed to describe all the timetable stops. The format of the timetable stops can be found here.
- EngineeringTrain
- (bool)
- True when the train is an engineering train.
- DelayLambdaWorkDays
- (float)
- Defines a number between 0.2 (spread delays) to 1 (normal amount delays) to 2 (large delays).
- DelayLambdaWeekend
- (float)
- Defines a number between 0.2 (spread delays) to 1 (normal amount delays) to 2 (large delays).
- IsShuntMovementOnly
- (bool)
- True when the train is a shunt movement.
- PeriodStart
- (date)
- Starting date when this train is valid.
- PeriodEnd
- (date)
- Ending date when this train is valid.
- Monday
- (bool)
- True when this train runs on Monday
- Tuesday
- (bool)
- True when this train runs on Tuesday
- Wednesday
- (bool)
- True when this train runs on Wednesday
- Thursday
- (bool)
- True when this train runs on Thursday
- Friday
- (bool)
- True when this train runs on Friday
- Saturday
- (bool)
- True when this train runs on Saturday
- Sunday
- (bool)
- True when this train runs on Sunday
- IsFACTrain
- (bool)
- True when this train is a FAC train.
- DoNotTakeMOOnRenumber
- (bool)
- True this train should not get movement orders as a result of a renumber, couple, uncouple, etc.
- Opmerking
- (string)
- Remarks. This text shows within the simulation in the Train Overview window. Typically this is a language neutral code that indicates what the train is supposed to do (movement orders).
- Communication
- (string)
- Undocumented.
- Skip
- (bool)
- True when this train should not be spawned. This has the same effect as leaving the EntryPoint_time empty.
- DriverType
- (int)
- Type of driver as defined in DriverType table.
- ActivityCode
- (string)
- Semi-colon delimited list of "activity codes" or "traffic codes." When an activity code is made active, trains with an activity code in this column become active. Refer to the article on Traffic Codes for more information.
- InactivityCode
- (string)
- Semi-colon delimited list of "activity codes" or "traffic codes." When an activity code is made active, trains with an activity code in this column become inactive. Refer to the article on Traffic Codes for more information.
- SpawnInfo
- (string)
- optional
- Defines additional spawning behaviour. See SpawnInfo.
There may be other fields in this table. Some of these fields are used to automatically generate the values in other fields, such as the TimeTableStops field. This is done with external tools that are separate from the simulation. Other fields are used only for the purpose of generating a printed timetable and are used by either passengers or dispatchers only and are not used by the simulation. As a timetable developer, you are free to add any fields you like for your own purposes. These fields will be ignored by the simulation.
Commonly used extra fields are:
- [...] = placeholder for timetablestop abbreviation.
- [...]_arr
This is the arrival time of that stop (if empty and _dep is filled, it's a starting or passing through train)
- [...]_dep
This is the departure time of that stop (if empty and _arr is filled, it's an arriving train only (ending))
- [...]_track
The planned platformtrack for the sim. (5a/5b becomes 5)
- [...]_nicetrack
the planned platformtrack for the user print version
- [...]_CTA
the roll number for the PID's
- MaxSpeed
- (int)
- When present, defines the maximum speed (in km/h) that a train can move. When not present, the train's max speed is calculated from the individual vehicles. This value is useful when the train should move slowly than otherwise is normal.
Contents | Developers pages | Command Line Options | Timetables | Scenario Creation | Developing Installers