Track-related System-Item Attributes

Planimate automatically maintains a number of system-item attributes as trains move along a track network. These are useful to modellers generating logs and graphs of the train movement which occurs.

These simplify management of routines executed as trains move through the network:

The following are system attributes maintained for each train item:

---

Name Read / Write (R/W) Description

---

Item Route ID

R

When an Item is assigned a Route to traverse a Rail Network, this is the ID for that Route. Corresponds to its index in the _Model Routes System Label List.

Item Route Step

R/W

When an Item assigned a Route moves across a Rail Network, as it completes each step by arriving at the next Object named in the Route, its Route Step Attribute will be incremented.

Item Route Step Count

R

Returns the total number of steps (Locations) in the Route the item is following.

Item Route Location

R

This returns the _ModelObject index to the next location the train item is to visit on its route.

Item Route Dir

R

This returns the direction of movement of the train item along the Track Object - either Forward (1) or Reverse (2)

ItemTrackForwardColumn

R/W

This provide the column reference for Planimate to use to look up the train item's FORWARD direction track section time for the Track being used.

ItemTrackReverseColumn

R/W

This provide the column reference for Planimate to use to look up the train item's REVERSE direction track section time for the Track being used.

Track Last Section ID

R

Gives the object label index of the last section the train entered.

Track Last Section Road

R

Gives the road number the item travelled on the section that the train last entered.0 for single road; for multi-road sections its 1,2 (or 3 for triple track) When an Item leaves a Track Section in a Rail Network, the Road that it travelled on is recorded. This enables you to track the progress of a train item in great detail. Consistency of results will depend on the 'direction' in which you have laid the track objects.

Track Loop Exit Start

R

This gives the time that a train began to leave the previous loop or portal. If its a loop and a loop exit delay was set and actually required, this is the start time of the loop exit delay.

Track Loop Exit End

R

This gives the time that a train actually began to move on the previous section. If the object is a portal or a loop with no exit delay, this time will be the same as the Track Loop Exit Start time.

Track Loop Entry Start

R

This gives the time that a train arrived at a loop or portal. If its a loop and a loop entry delay was set and required, this is the start time of the loop entry delay period (during which the section remains unavailable and the train cannot leave the loop).

Track Loop Entry End

R

This gives the time that train completed arrival at a loop or portal. If the object is a portal or a loop with no entry delay, this time will be the same as the Track Loop Entry Start time.

Track Section Nominal Time

R

Gives the nominal running time for the section that the train last used, as compared to the actual running time which can be influenced by section restrictions.

LoopDelayOverride

R/W

This enables a modeller to instruct the Planimate Tracks Engine to ignore track portal loop delay testing and assignment when an item is doing a TestEnter on a portal exit leading up to the track.

It is useful where a modeller is doing advanced lookahead in evaluating possible train routes and the loop delay mechanism needs to be temporarily disabled in order that the modeller receives notification whether a route is actually viable.

Note that a special mode dispatcher is also required for this option to be useful.

Planimate will revert any changes made to this attribute during lookahead. Ensure any "Move" code does not leave this attribute in a non zero value or portal loop delays will fail.

RouteTestRow

Enables a modeller to query which row of a Route Selection table is being tested. This is useful when the change objcet multiple route test capability is being used, as it enables the modeller to access other data they are storing in the table.

The value is the row number from the table. This value is set only during lookahead for Change Objects immediately downstream of the Change Object that is testing routes from the table.

Otherwise this value should not be relied upon for any purpose.