View source for Mission Code Stops and TimeTables Manager

===Mission Code Stops and TimeTables Manager rule===
[[File:Help-mcsttrule-img01.png]]

'''Mission Code Stops and TimeTables Manager''' is a rule ( <kuid:61392:8300> ) which enables to create, edit and manage stop zones and timetables to easily have some trains following a timetable schedule along a path defined using mission codes.

''This page is currently under construction before public release of Mission code Stops and TimeTables Manager.

=== Mission Code Stops and TimeTables Manager rule : what is it and for which purpose ?===

MCSTT Manager rule is a rule that enables to define (create), edit and manage stop zones and timetables. 

A stop zone is a group of trackmarks (pathstops trackmarks or standard trackmarks) where a train will make a stop if the stop zone is included in a target timetable to follow. A stop zone is only a logical name under which will be grouped several pathstops or trackmarks. Station names or industry names will be often used as a stop zone, but you can use any arbitrary unique name as a stop zone name to group pathstops or trackmarks.

Timetables are defined in MCSTT Manager rule and a named timetable will list all the named stop zone where a train will stop with its arrival time and departure time. Arrival time is optional and is only an indication of the expected arrival time at the stop zone for a train. Departure time is mandatory except for the last final destination. You can also set an option to request your train to reverse direction at a stop zone. You also define in your timetable the mission code to be used by your train when it follows the timetable schedule.

When stop zones and timetables have been defined, you can use two driver commands "SetMCTimeTable" <kuid:61392:8330> to assign a timetable to a train and "AutoDriveWithMCTimeTable" <kuid:61392:8322> to start autodrive for your train following the previously timetable assigned. If the train is currently at a stop zone defined in the timetable, it will leave the stop zone at the departure time defined in the timetable and will autodrive following its mission code path until it reaches a new stop zone defined in the time table. It will then stop at the stop zone and wait until departure time. If the reverse option is set for this stop zone, the train will change direction before restarting autodrive. And the AutoDriveWithMCTimeTable command will end when the train will reach the final destination stop zone defined in the timetable or if reaches the stop zone selected when launching the driver command.

With stop zones and timetables, you can define a timetable schedule for your train and you need only two driver commands to follow the schedule : one command to assign the timetable to your train and one command to autodrive following the current timetable to destination.

The system is very easy to schedule passengers services using stations as stop zones, but you can also define your yards as stop zones for goods train or any target industry destination.

=== Mission Code Stops and TimeTables Manager rule : in practice how to use it ===

To use mission code stops and timetables in a session, you need first to add to your session rules the Mission Code Stops and TimeTables Manager rule.
The rule interface has three main tabs : Mission codes, Stop zones, Timetables list and two auxiliary details tab pages : Stop zone details and Timetable details.

== Mission Code tab page ==

The first screen will show you the current mission codes defined in your session and enables to add, edit or delete these mission codes.

[[File:Help-mcstt-rule-img02.png]]

''All screenshot examples are taken from a demo session : EIT - DemoRoute - UK1 - Full session with MC TimeTable that you can find and download from the DLS under <kuid:61392:8405>''

Mission Codes tab (above) enables to add, edit, delete mission codes. Mission codes are shared data with [[MissionCodes Manager]]. Take care that supressing a mission code may create some invalid data in other rules. You will need to use the check and suppress invalid mission code data link to supress references to no longer valid mission codes in the current edited rule.

== Stop zones tab page ==

Stop zones tab (below) lists all available current stop zones and enables to add, view details or suppress stop zones.

[[File:Help-mcstt-rule-img03.png]]

The stop zone tab screen will display all the stop zones currently defined and will enable to add new stop zone or to remove existing stop zone. with "Add new stop zone" you can enter a new stop zone name to be created. If you click on the [...] link, the rule will propose you a list of all the available industry names in your route to select as a new stop zone to be created. This option is very usefull for example to add quickly some passenger stations names as stop zone. The remove stop zone will list all the current stop zones names so that you can select which stop zone is to be removed.

In front of each stop zone name, the "view details" link will display the details of the selected stop zone : list of pathstops and trackmarks linked to this stop zone with their properties ( train length, number of cars, ...).

== Stop zone details tab page ==

[[File:Help-mcstt-rule-img04.png]]

The stop zone details page (above) shows for each stop zone the list of all pathstops or trackmarks currently linked to the stop zone. Linked pathstops and trackmarks have currently three properties : the first one is the name of the linked stop zone, the second one is maximum number of vehicles and the third one is the maximum length of a train. When a train reaches a pathstop or a trackmark, it will stop at it only the train current number of vehicles and length are both less or equal to the pathstop or trackmark property. This enables to have several pathstops or trackmarks linked to the same stop zone : one being used for short length trains and the other for longer trains. When these properties are set to 0 (default value), the pathstop or trackmark will stop any train.

What is the advantage of using pathstops ( a scripted trackmark asset <kuid:61392:8311> ) instead of trackmarks : when you drop a pathstop inside a station or an industry, it will be linked by default to a stop zone name with the same name as the embedding station name or industry name. You can also edit the pathstop properties under surveyor by clicking on the ? in the surveyor tools. For standard trackmarks, which do not have these local properties, you will need to edit the mcstt rule and go to the stop zone details page to be able to set these properties for a trackmark. So there are no functional differences, but pathstops are more easy to edit and set than standard trackmarks.

When you use pathstops or trackmarks linked to mcstt rule, you neither autodrive to a specific trackmark but you autodrive to a stop zone. Your train will stop only when it will reach a pathstop or a linked trackmark which stop zone property is equal to the target stop zone destination selected when launching the autodrive driver command. this enables to have several pathstops or linked trackmarks for a stop zone and your train will stop at any pathstop or trackmark encountered linked to the target stop zone.

The stop zone details page allows also to rename the stop zone. The timetable view link enables to switch to timetable view with an active filter on the current stop zone, displaying only timetables including a stop or a passing through at the current stop zone. With the filtering option active timetables are sorted by scheduled time at the stop zone (either arrival, departure or passing thru time).

==Timetable list tab page ==

The timetable list tab page will show the list of all timetables already defined in the system.

[[File:Help-mcstt-rule-img05.png]]

Timetable list includes the timetable unique name, the final target destination for the timetable, the first stop arrival or departure or passing thru time. Timetable lists can be filtered by timetable group name (each timetable may belong to one specific named group) or by stop zone (only timetable including a stop or passing thru at the stop zone will be displayed.

The create new timetable link offers to create a new timetable by entering a new unique timetable name. The [...] will list all the current mission codes and existing timetable group names, and when selected will create a new timetable with a unique numbered name starting with this prefix.

View details link will display the selected timetable details page. Delete will suppress the selected timetable. Clone will request you enter a new time and will clone the selected timetable as a new timetable with a new name set to the selected timetable group name concatanated with the new entered time and with all stop times shifted by the delta time between the new and original timetable.

==Timetable details tab page==

[[File:Help-mcstt-rule-img06.png]]

The timetable details page will give you all information about the selected timetable. First its name. clicking on it enables to rename the timetable. 
The group name enables to enter an arbitrary group name for the timetable. Timetable group names are usefull to filter timetables lists. If you click on [...] it will propose to enter the timetable in a mission code group name.

Timetables will have one or several mission codes assigned to it. When running the timetable schedule, a train will also add the assigned mission codes to its current mission codes for mission code manager path auto selection.

And then you have the list of all stops with their stop zone name, arrival time, departure time and option to reverse train direction at the target stop. You may also enter some information about some passing through step by entering the string "nostop" instead of an arrival time : this enables to have some passing through time information included in the schedule, but the train will not stop at any "passing through stops". This may be usefull also to keep the same stops structure for direct trains and omnibus ones.

Arrival time are only optional informative data. Departure time will be used when a train running the schedule will be at the stop zone : it will leave only after the target departure time. Trains which are less than 12 hours late will not wait ; trains which are in advance on their schedule will wait until departure time for 12 hours max.

==How for a train to follow a timetable schedule==

Quite simple and easy. First you need to assign a timetable to the current train by using the SetMCTimeTable driver command (<kuid:61392:8330>). The driver command menu will propose you at first level all the timetable groups and at second level all the timetables in the selected group. After a timetable has been assigned to the train, you can use AutoDriveWithMCTimeTable driver command ( <kuid:61392:8322>) to start autodriving following the timetable schedule.

The AutoDriveWithMCTimeTable will request you select in its menu a target destination stop zone, and will start autodriving following the timetable schedule stops until it reaches the target stop zone destination. The target stop zone destination enables to follow only partly the timetable schedule from where your train is currently located until it reaches the target stop zone destination. While running, the driver command will detect any pathstop or trackmark belonging to a stop zone stop included in the schedule and will stop the train when reaching the pathstop or trackmark (taking care of the pathstop or trackmark properties like max vehicles or max train length). It will then wait for the departure time if the train is in advance on its timetable or will immediately leave if it is late with a minimum stop duration of 1 mn.

A common usage example is a passenger service schedule : you need only to enter in the timetable the initial stop zone with its departure time, all the intermediate stops zone names with the expected arrival time (optional) and departure time and if the train has to reverse direction, and the final target destination stop zone with an optional arrival time. And with only two driver commands : first one to assign to the train the timetable to follow and the second one to autodrive following the assigned timetable, your train will run stopping at the intermediate stops encountered along its mission codes path and following the defined departure time.

==and now ...==

Just try this new rules and driver commands and you will see how it is easy to define and follow a timetable schedule.

EIT Demo route - UK 1 - Full session with MCTimetable ( <kuid:61392:8405> ) is an example session using EIT Demo route - UK 1 ( <kuid:61392:8401> ). Both will be available soon on DLS. And you can easily edit the session and look at how the rule and timetables were configured.

Have some nice timetable schedule runs and let me know if you have any trouble using this new rule.

Regards.
Pierre. (61392).

[[Category:Help|MissionCode Stops and TimeTables Manager]]
[[Category:Rules]]
{{FUN-bot}}