Activate New Train Window

Introduction

The Activate New Train window supports the creation of a new Active Train. To create an Active Train, the dispatcher uses this window to assign a Transit, assign a train, and specify a starting Block (train location at start) and an end Block (train location when transit of the layout is complete). Options for the new Active Train are also set using this window. It is likely that more Active Train options will be added in the future.

Transits are always selected from Transits defined in the Transit Table. Trains may come from any one of three sources:

Trains from Roster - Dispatcher will list all trains in the JMRI Roster that are not currently in Active Trains.
Trains from Trains - Dispatcher will list all trains available from Operations that are not in Active Trains.
Trains from User Entry - Dispatcher will replace the train selection box in the Activate New Train window with two entry fields allowing the user to enter a train name and a dcc Address.

Dispatcher's train source is set by selecting one of the above in the Options window accessed from Dispatcher's Options menu.

Active Trains must start from a Block in the selected Transit, or from a Block connected to a Block in the selected Transit. Active Trains must stop in a Block within the selected Transit. Transits have a direction, so for a starting Block outside the Transit to be a valid starting Block, entry to the Transit from the starting Block must result in travel in the Transit's defined direction. This window only allows selection of valid starting and stopping Blocks. If an expected Block is not in the starting Block selection box, it may be because of this requirement.

Saving and Retrieving Active Train Information

To facilitate easy set up of Active Trains that are used more than once, Dispatcher provides for saving and loading train information from disk.

To save your train information to disk, click the Save Train Info button after all selections and options have been set up but before clicking the Add New Train button. This will bring up a small window allowing you to name the saved train information file. The name you enter will be normalized automatically with any non-alphanumeric characters replaced, and a .xml suffix added if needed. Train information files are saved as .xml files in the dispatcher folder in the user's preferences area of disk.

To load previously saved train information, click the Load Train Info button immediately after the Activate New Train window is displayed. This will bring up a small window allowing you to select the train information file to load from all the train information files in the dispatcher folder. When a train information file is loaded all items in the Activate New Train window are set according to the saved train information if possible. If an item cannot be set, for example if the specified Transit is in use, a warning is displayed and a default selection is made. After loading, you may change any option or selection, then may save your new train information, before clicking the Add New Train button.

Using the Activate New Train Window

To create a new Active Train, use the following procedure:

Click the New Train... button in the Dispatcher window to bring up the window shown below.
If you want to use saved train information, click Load Train Info. See above for more on loading train information.
Select a Transit from the Transit selection box. The selected Transit specifies the route the Active Train will follow while running on the layout. Transits are displayed and new Transits are created using the Transit Table accessed from the Tables submenu of the JMRI Tools menu. This Transit selection box will allow selection of any Transit in the Transit Table that is not in use by an Active Train.
If the window shown above is displayed, select a train from the Train selection box. This window is displayed if the Trains from Roster or the Trains from Trains options are selected as Dispatcher's train source.

- OR -
If the window shown below is displayed,

enter a train name in the Train Name: field, and enter a numeric address in the DCC Address: field. Any short name that identifies the train may be used provided the name is not being used by another Active Train. Dcc addresses must be a number in the range 1 - 9999. Note: If the train will not be run automatically, the dcc address need not be accurate. This window is displayed if Trains from User Entry is selected as Dispatcher's train source.
If the starting location of the Active Train is a Block within the selected Transit, check the Train in selected Transit box. If the starting location of the Active Train is outside the selected Transit, (in a Block connected to a Block within the selected Transit) uncheck this box. Checking and unchecking this box results in different selections in the Starting Location of Train: select box.
Select a Starting Location of Train: from the select box. This select box lists all Blocks consistent with the check box above and the selected Transit. To identify each Block uniquely, the Block identifier consists of the Block system name, followed by the Block user name (in parentheses) followed by the sequence number of a Section in the Transit definition. If the train is located in the Transit, this sequence number identifies the Section where the train is located. If the train is located in a connected Block, the sequence number identifies the Section that will be entered when the train enters the Transit. If the train spans two blocks, select the Block where the engine is located.
Select a Destination Location of Train: from the select box. This select box lists all Blocks consistent with the selected Transit that can be reached from the selected starting location by travel in the direction of the Transit. The Block identifier in the select box consists of the Block system name, followed by the Block user name (in parentheses). If a Section is in the Transit more than once, the sequence number of the destination Section is appended to the Block identifier to identify the destination Block uniquely.
Enter a Priority for the Active Train relative to other Active Trains. Larger numbers are higher priority. The priority is used in by automated dispatching functions to arbitrate between Active Trains if multiple Active Trains are requesting the same resources.
Check Reset When Done to set up the Active Train for continuous running. With continuous running, when an Active Train has completed running through its Transit, it is immediately reset to run around its Transit again. Continuous running requires that the selected Transit be set up in a certain way. If the selected Transit is not capable of continuous running, the user is warned and Reset When Done remains unchecked. For more information on setting up a Transit for continuous running see the Transit Table help file.
Check Run Train Automatically to request that the Active Train be run automatically by the computer. Checking here will display options that are only related to automatic running of trains.
If you want to save your entered train information for later use, click Save Train Info. See above for more information on saving train information.
Click Add New Train after all the above have been set to create and activate the new Active Train. The new Active Train will immediately appear in the Dispatcher window, and this window will be dismissed.

- OR -
Click Cancel to exit this window without creating a new Active Train.

Note: Automated dispatching and automatic running of trains are not implemented in the initial version of Dispatcher. These functions are expected to be introduced in later versions of JMRI.