Item Related System Attributes: Difference between revisions

From Planimate Knowledge Base
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
 
(3 intermediate revisions by the same user not shown)
Line 4: Line 4:
This information can be useful to support identification and perhaps logging of each item's experience while it is the model.</onlyinclude>  
This information can be useful to support identification and perhaps logging of each item's experience while it is the model.</onlyinclude>  


Name Read / Write Description
----


Item ID R The Item’s unique ID number in the system model during the model run.
Name


Item Owning Item ID R Returns the ID of any item which OWNS the current item if it is a message item. If the current item is not a message item, -1 is returned.
Read / Write


Item Priority R/W Read or change the Item’s Priority in a change object using this attribute.
Description


Items Carried R Read the number of Items being carried by the item, when it is acting as an Agent (and even when it is not).
----


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.
<br>


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.
=== '''BroadcastReceivers '''  ===


Item Route Step Count R Indicates the number of Locations included in the Route Definition. Can be used to interrogate a route in a routine through iteration, using this as the end point.
R  


Item Route Location R/W The _Model Objects Name of the Location included in the Route at the particular Route Step the Item is on.  
When an Item arrives at a Broadcast Dispatcher, the transmitted broadcast will be picked up by some Broadcast Entries tuned to it.  


Item Route Dir. R/W Indicates whether the Item is moving in the Forward or Back direction along the track. This can enable you to make your train item perform U-turns.  
This tells you how many.  


Item Stopping R When an Item enters a Loop Object on a Rail Network, it will know whether it has to stop to allow a train to pass it in one direction or another. If it does have to stop, this attribute can be read. (&gt;1 = Stopping; 0 = Not Stopping).  
This is set after an item is released by a broadcast dispatcher. It is set to the number of receivers that the broadcast was sent to.  


Item Booking ID R/W Required for calculation operations to support adding bookings to a section; reading back all bookings from a section; clearing a sections bookings. Sections are read and written using a table which must have the following columns: "_book id" identifier of the item which the section is booked for. An integer &gt;= 1. Only the item whose system attribute "booking id" matches will have access to the section during the booked interval "_from"; "_to" Specify the time range over which the section is booked
This includes all entries which produced an item and all sockets which sent the broadcast over TCP/IP.<br>


Act As An Agent R/W Determines how any agent-sensitive object (in tray, out tray, facility) will treat the item. The default setting of this attribute is that of the items class (set during edit of the class). For proper operation, you must ensure that any change made to this system attribute is seen during lookahead - if set in a routine just before the object, the routine must execute during lookahead. Otherwise the item may be let in as an item when in fact you wanted it to enter as an agent.
<br>


Item Show info Panel W Enables the info panel to be hidden/shown on an item by item basis.
=== '''ItemActAsCarrier '''  ===


Item Last Track Road R 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. (1 for Single or Road 1; 2 for second Road). Consistency of results will depend on the ‘direction’ in which you have laid the track objects.
R/W


Item Total Delay W When ‘placing an Item in an Object, set this value so the item knows what delay is involved.  
Determines how any Carrier-Item-sensitive object (PickUp, DropOff) will treat the item.  


Item Delay Left W When ‘placing an Item in an Object, set this value so the item knows what remaining delay is involved. Set ONLY after setting "Item Total Delay", as the engine needs it to compute the effective item entry time.  
The default setting of this attribute is as per the item's class (set during edit of the class). For proper operation, you must ensure that any change made to this system attribute is seen during lookahead - if set in a routine just before the object, the routine must execute during lookahead.  


Item Location R/W Read this for a current location of an item. The object must be part of the _Model Objects label list. When ‘placing an Item in an Object, set this value so the item knows what Object it is being placed into. Set this using the _Model Objects label list, or a subset of it.  
Otherwise the item may be let in as a regular item when in fact you wanted it to enter as a Carrier Item.  


Item Location Detail R Extra parameter to item location, e.g. road # (of a track object), server # (in a Multi-Server). Not completely implemented, so don’t use it yet.
<br>


Item Trace Animation W When an item passes through a Change Object, and in its routine this attribute is set to a value of 1, the tracing of the animation of this item commences. That single item’s progress through the model structure will be following, shifting screens as it moves around, until it is destroyed, or until it is set back to Zero.
=== '''ItemDelayLeft '''  ===


The following three system attributes are used for rail applications in conjunction with Dynamic Routes and Timetables.
W


Item Time Until Arrival R/W Gives the time which must elapse before the item needs to arrive at the next step in its route. (When an item is inside a station, its step pointer is already advanced to the next step). If the timetabled time has already passed or no route is assigned, this will yield 0.  
If you choose to ‘place' an Item into an Object using the Throw Exit mode, you can set this value so the item knows what remaining delay is involved. Set this attributes ONLY after setting "Item Total Delay", as the engine needs it to compute the effective item entry time.  


Item Time Until Departure R/W Gives the time which must elapse before the item should leave the current object in its route. This is unavailable if the current object was the last step in the route (the route has completed). If the timetabled time has already passed or no route is assigned, this will yield 0.
<br>


Item Dwell Time R/W Gives the minimum time which the item must spend at the current object, even if its behind on its timetable. If no route is assigned, this will yield 0.
=== '''Item ID <br>'''  ===


Item Transit Target W Before an Item can cross a Spatial link, it needs this attribute set. This is the other end of the Transit. To be a valid Target, it must be a Portal in the same subsystem as the Portal the link begins with, and must be in the _Model Objects List.
R <br>


Item Transit Time W This is the time that the item will take to traverse the links on its way to the Transit target.  
The Item’s unique ID number in the system model during the model run.  


Item Transit Distance R This is set when an item first enters a spatial net. The value is the total distance to the specified target on the spatial link network. It doesn't get set until the item actually enters the spatial net. It is available upon arrival at the target, and can be used to track distances travelled (in pixels). It gets cleared when you assign a new target.  
Item Owning Item ID R Returns the ID of any item which OWNS the current item if it is a message item. If the current item is not a message item, -1 is returned.<br>


Broadcast Receivers R When an Item arrives at a Broadcast Dispatcher, the transmitted broadcast will be picked up by some Broadcast Entries tuned to it. This tells you how many. This is set after an item is released by a broadcast dispatcher. It is set to the number of receivers that the broadcast was sent to. This includes all entries which produced an item and all sockets which sent the broadcast over TCP/IP. Attribute Routine Runtime_Engine Item  
<br>
 
=== '''Item Location '''  ===
 
R/W
 
Read this for a current location of an item. The object in which the item is located must be part of the _Model Objects label list.
 
If you choose to ‘place' an Item into an Object using the Throw Exit mode, before sending the item through the Throw Exit, set this value so the item knows what Object it is being placed into. Set this using the _Model Objects label list, or a subset of it.
 
<br>
 
=== '''ItemLocationDetail '''  ===
 
R  
 
Extra parameter to item location, e.g. road # (of a track object), server # (in a Multi-Server).
 
Currently this is only a limited implementation, so its use is not recommended.
 
<br>
 
=== ItemOwning ItemID  ===
 
R
 
For a [[Message Item|Message Item]] only.
 
This carries the ItemID of the Item that triggered the production of this Message Item.
 
<br>
 
=== '''Item Priority <br>'''  ===
 
R/W <br>
 
Read or change the Item’s Priority in a change object using this attribute.
 
<br>
 
=== '''Items Carried <br>'''  ===
 
R <br>
 
Read the number of Items being carried by the item, when it is acting as a Carrier Item (and even when it is not).
 
<br>
 
=== '''ItemShowInfoPanel '''  ===
 
W
 
Enables the [[Info Panel|Info Panel]] to be hidden/shown on an item by item basis.
 
<br>
 
=== '''ItemTotalDelay '''  ===
 
W
 
If you choose to ‘place' an Item into an Object using the Throw Exit mode, you can set this value so the item knows what delay is involved once it arrives at the object.<br>
 
<br>
 
=== '''ItemTraceAnimation '''  ===
 
W
 
When an item passes through a Change Object with a routine that sets this attribute to a value of 1, the tracing of the animation of this item commences. That single item’s progress through the model structure will be followed, shifting screens as it moves around, until it is destroyed, or until it is set back to Zero.  
 
<br>
 
=== '''ItemTransitDistance '''  ===
 
R
 
This is set when an item first enters a spatial net.
 
The value is the total distance to the specified target on the spatial link network.
 
It doesn't get set until the item actually enters the spatial net.  
 
It is available upon arrival at the target, and can be used to track distances travelled (in pixels).
 
It gets cleared when you assign a new target.
 
<br>
 
=== '''ItemTransitTarget'''  ===
 
W
 
Before an Item can cross a Spatial link, it needs this attribute set. This provides the end point of the Transit.
 
To be a valid Target, it must be a Portal in the same subsystem as the Portal the link begins with, and must be in the _Model Objects List.
 
<br>
 
=== '''ItemTransitTime '''  ===
 
W
 
This is the time that the item will take to traverse the links on its way to the Transit target.  
 
<br>
 
<br>
 
----
 
There are further system item attributes that are used in conjunction with Planimate Tracks features. The list of Track-Related System Item Attributes can be accessed [[Track-related System-Item Attributes|here]].<br>


[[Category:Attribute]] [[Category:Item]] [[Category:Routine]] [[Category:Runtime_Engine]]
[[Category:Attribute]] [[Category:Item]] [[Category:Routine]] [[Category:Runtime_Engine]]

Latest revision as of 16:38, 5 January 2009

Item Related System Attributes

Each individual Item created in your model records and stores information about itself. This information can be useful to support identification and perhaps logging of each item's experience while it is the model.

Name

Read / Write

Description


BroadcastReceivers

R

When an Item arrives at a Broadcast Dispatcher, the transmitted broadcast will be picked up by some Broadcast Entries tuned to it.

This tells you how many.

This is set after an item is released by a broadcast dispatcher. It is set to the number of receivers that the broadcast was sent to.

This includes all entries which produced an item and all sockets which sent the broadcast over TCP/IP.


ItemActAsCarrier

R/W

Determines how any Carrier-Item-sensitive object (PickUp, DropOff) will treat the item.

The default setting of this attribute is as per the item's class (set during edit of the class). For proper operation, you must ensure that any change made to this system attribute is seen during lookahead - if set in a routine just before the object, the routine must execute during lookahead.

Otherwise the item may be let in as a regular item when in fact you wanted it to enter as a Carrier Item.


ItemDelayLeft

W

If you choose to ‘place' an Item into an Object using the Throw Exit mode, you can set this value so the item knows what remaining delay is involved. Set this attributes ONLY after setting "Item Total Delay", as the engine needs it to compute the effective item entry time.


Item ID

R

The Item’s unique ID number in the system model during the model run.

Item Owning Item ID R Returns the ID of any item which OWNS the current item if it is a message item. If the current item is not a message item, -1 is returned.


Item Location

R/W

Read this for a current location of an item. The object in which the item is located must be part of the _Model Objects label list.

If you choose to ‘place' an Item into an Object using the Throw Exit mode, before sending the item through the Throw Exit, set this value so the item knows what Object it is being placed into. Set this using the _Model Objects label list, or a subset of it.


ItemLocationDetail

R

Extra parameter to item location, e.g. road # (of a track object), server # (in a Multi-Server).

Currently this is only a limited implementation, so its use is not recommended.


ItemOwning ItemID

R

For a Message Item only.

This carries the ItemID of the Item that triggered the production of this Message Item.


Item Priority

R/W

Read or change the Item’s Priority in a change object using this attribute.


Items Carried

R

Read the number of Items being carried by the item, when it is acting as a Carrier Item (and even when it is not).


ItemShowInfoPanel

W

Enables the Info Panel to be hidden/shown on an item by item basis.


ItemTotalDelay

W

If you choose to ‘place' an Item into an Object using the Throw Exit mode, you can set this value so the item knows what delay is involved once it arrives at the object.


ItemTraceAnimation

W

When an item passes through a Change Object with a routine that sets this attribute to a value of 1, the tracing of the animation of this item commences. That single item’s progress through the model structure will be followed, shifting screens as it moves around, until it is destroyed, or until it is set back to Zero.


ItemTransitDistance

R

This is set when an item first enters a spatial net.

The value is the total distance to the specified target on the spatial link network.

It doesn't get set until the item actually enters the spatial net.

It is available upon arrival at the target, and can be used to track distances travelled (in pixels).

It gets cleared when you assign a new target.


ItemTransitTarget

W

Before an Item can cross a Spatial link, it needs this attribute set. This provides the end point of the Transit.

To be a valid Target, it must be a Portal in the same subsystem as the Portal the link begins with, and must be in the _Model Objects List.


ItemTransitTime

W

This is the time that the item will take to traverse the links on its way to the Transit target.



There are further system item attributes that are used in conjunction with Planimate Tracks features. The list of Track-Related System Item Attributes can be accessed here.

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