Route Assignment Table: Difference between revisions

From Planimate Knowledge Base
Jump to navigation Jump to search
m (1 revision(s))
mNo edit summary
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<font face="Arial">This table enables you to assign a route to an item. Routes are used to tell trains which stations to go to on a track network.
A Route can be manually assigned using the Route option in the change object.<br>  


Routes are used to tell trains which stations to go to on a track network.


The table has two modes of operation. By default it is in Global mode.<br /><br /><u>'''Global Indexing Mode
The Route Assignment Dialog displays a list of all of the Routes that you have specified in your model.  


In this list of Routes, each Route has a unique index number, which was defined at the time the route was created.


'''All routes in the model are listed together with their index values (defined at the time the route was created).<br /> </u><br /> You use the "&gt;" button to configure an Attribute Reference to select which route you want to assign. The default is a constant one. It is common to use an item attribute which has been set by preceeding train scheduling logic.'''<br /> '''<br /> The Delete button clears the route assignment (so no assignment occurs).
== Selector Reference<br> ==


Below the Routes list is a "Selector Reference" Attribute. This provides a value for which a matching Route index value is sought.


Clicking the Options button will display a menu with 2 options:<br />'''<br /> Index Value Source: Global<br /> '''selecting this enables you to change to Local Indexing<br /><br />'''Export Names<br /> '''Enables you to export the route names and indicies to a text file.<br /><br /><u>'''Local Indexing Mode
When an item passes through the Change Object, the Route whose index value matches the value of this Selector Reference Attribute will be assigned to the train item.  


You use the "&gt;" button to configure the Selector Reference Attribute. Its default is a constant value of 1. <br>


'''In this mode, routes are added and indexed locally to this object. Extra buttons will appear to facilitate this.
More common would be to use an item attribute which has been set in routine code before the train item arrives at this change object.<br>


Because the Selector Reference is an Attribute, you can point to an attribute that varies during a model run.


You use the "&gt;" button to configure an Attribute Reference to select which route you want to assign. The default is a constant one. It is common to use an item attribute which has been set by preceeding train scheduling logic.
e.g. You can create an Item Attribute called "Trip_Name". Each item can be given a different trip_name value, and each item will be assigned a different Route when it passes through this change object.<br>


<br>


Use the Add button to select a route and add it to the table.<br /> Likewise Remove will remove the highlighted route from the table.
== Selector Reference Enables Multiple Choices<br> ==


The Selector Reference can be pointed to a Table. This enables a number of routes to be specified and they will be tested sequentially, with the first "accepting" route taken by an item.


The Options button now has 3 options<br />'''<br /> Index Value Source: Local<br /> '''Selecting this enables you to change to Global Indexing. Doing this will lose the route/index assignments currently in this object.<br /><br />'''Rebuild From Visible<br /> '''Selecting this will add all routes that are using objects that are visible to the table. This may be useful in track models where several panels contain routes. The change object can be constructed on the panel with the routes, the routes added using this option then the object can be copied (typically into the portals which are the terminals in the network).
*The reference must be to the entire table.  
*The route index values to test are specified in column 1 of the table.  
*The rows in this column should be set to the route IDs to test.


== Row Limit Attribute  ==


</u>'''Export Names<br /> '''Enables you to export the route names and indicies to a text file.
When you are using the table-based multiple choice Selector Reference, you can set an additional "row limit" attribute.  


You use the "&gt;" button to configure the Row Limit Attribute. Its default is a constant value of 1.


The Delete button clears the route assignment (so no assignment occurs). The customised route indicies within this route table are lost.<br /><br /><br />'''
This provides a convenient means of limiting the number of rows tested.  


This is useful because the table needs to be prepared and available during lookahead, during which time rows cannot be added/ removed from a table.
The default of -1 for the row limit will scan all rows in the table.<br>
== Delete Button<br>  ==
The Delete button clears the route assignment function in this change object (so it performs no route
----


'''</font>
----
----
[[Category:Attribute]]
 
[[Category:Route]]
[[Category:Track]] [[Category:Context_Help]]
[[Category:Track]]
[[Category:Context Help]]
<font size="2">idkbase note 10160</font>

Latest revision as of 17:57, 9 May 2011

A Route can be manually assigned using the Route option in the change object.

Routes are used to tell trains which stations to go to on a track network.

The Route Assignment Dialog displays a list of all of the Routes that you have specified in your model.

In this list of Routes, each Route has a unique index number, which was defined at the time the route was created.

Selector Reference

Below the Routes list is a "Selector Reference" Attribute. This provides a value for which a matching Route index value is sought.

When an item passes through the Change Object, the Route whose index value matches the value of this Selector Reference Attribute will be assigned to the train item.

You use the ">" button to configure the Selector Reference Attribute. Its default is a constant value of 1.

More common would be to use an item attribute which has been set in routine code before the train item arrives at this change object.

Because the Selector Reference is an Attribute, you can point to an attribute that varies during a model run.

e.g. You can create an Item Attribute called "Trip_Name". Each item can be given a different trip_name value, and each item will be assigned a different Route when it passes through this change object.


Selector Reference Enables Multiple Choices

The Selector Reference can be pointed to a Table. This enables a number of routes to be specified and they will be tested sequentially, with the first "accepting" route taken by an item.

  • The reference must be to the entire table.
  • The route index values to test are specified in column 1 of the table.
  • The rows in this column should be set to the route IDs to test.

Row Limit Attribute

When you are using the table-based multiple choice Selector Reference, you can set an additional "row limit" attribute.

You use the ">" button to configure the Row Limit Attribute. Its default is a constant value of 1.

This provides a convenient means of limiting the number of rows tested.

This is useful because the table needs to be prepared and available during lookahead, during which time rows cannot be added/ removed from a table.

The default of -1 for the row limit will scan all rows in the table.

Delete Button

The Delete button clears the route assignment function in this change object (so it performs no route

Retrieved from ‘https://wiki.planimate.com/index.php?title=Route_Assignment_Table&oldid=3836’