System Attribute: Difference between revisions

From Planimate Knowledge Base
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 53: Line 53:
== Other (General) System Attributes  ==
== Other (General) System Attributes  ==


Name Read / Write Description
{{Breakout|Other General System Attributes}}
 
Null W Enables dialog results etc. to be thrown away without having to create a dummy attribute.
 
Runtime Break Point Control W Provides convenient control of any breakpoint(s) in the model. This works in addition to modeller defined breakpoint control attributes, enabling breakpoints at complex conditions or at certain stages in a long loop to be activated.
 
Current Object Location R Lets you get an owning portal location for an object without involving an item. In other words, it obtains the location from the object's point of view rather than going via the item. This can be useful when you need to find the subsystem that a specific object is in, perhaps so you can direct a message to this location.
 
Total Object Label Count R With this attribute, the model can query the number of objects which are in the _Model Objects label list
 
ODBC Error Status R ODBC operations have an option to not stop the run on error. This system attribute returns whether an error in the ODBC operation occurred, non zero value indicates an error. ODBC Error Status must be read in the same thread that performs the ODBC operation.
 
Spatial link Scan Depth W Limits how deep PL will scan a spatial net looking for the closest route to the target. The attribute needs to be set each time the model is loaded, it is not saved. The default is 9999999 (ie: don’t limit search depth). Setting this value means Planimate® may not chose the shortest distance path in a spatial net if it contains more intermediate nodes than an alternative which is further in distance, and the node limit happens to be exceeded in scanning the shorter path. This will be obvious in incorrect animation but should not affect the item arrival time. In other words, reducing the search depth may cause PL to chose a route which is not the "shortest". It may also cause Planimate® not to find the correct route at all (if it has too many intermediate nodes) in which case PL will report a flow error. This attribute has to be set before firing the first item into the spatial net. It doesn't get saved with the model, it resets to a large number when the model is loaded. You can change its setting during the run but probably not something useful to do, if its too low and PL fails to find a target it will stop the model with a "no outgoing flow" type message.
 
User Edited Model Data R Gets set when a user edits an attribute view or table view/editor. The model can set and reset this attribute. It gets reset when the model is saved. Tables and attribute views have an option to not set this bit when they are edited
 
Button Paint ID R Set while a paint object checks its visibility/state attribute reference. If the object is in the paint label list, it can be used to assist in looking up visibility for that paint object. <br>
 
[[Category:Attribute]] [[Category:Runtime_Engine]]

Revision as of 15:05, 14 December 2008

System Attributes

System Attributes are where Planimate® manages various attributes to run the model.

These attributes (e.g. the clock time), may be referenced. In some cases they may be set by the modeller in a Routine.


Uses for System Attributes

System Attributes are always available.

You can derive information about time spent in various states or regions of the model.

They give access to time variables useful in developing or monitoring schedules of activity.

Time-Related System Attributes

These attributes cover pretty much all there is to know about both simulation time (i.e. within the Model during a run), and real time (i.e. the time at which you are running your model).

For full details refer to this page: Time-Related System Attributes

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.

For full details refer to this page: Item Related System Attributes

Item Animation Related System Attributes

These attributes are intended for run time assignment so their settings are not currently saved with the model and in fact cannot be edited directly, only via a routine calculation.

For full details refer to this page: Item Animation Related System Attributes

Track-related System-Item Attributes

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

These system attributes are available via routines to support more sophisticated decision making, manage and control train movements, derive useful records and for creating train graph outputs.

They can be accessed when items pass through routines. Some can be changed, altering the nature of a train’s movement, others are read-only, and can be used also in switches, to control processing of and delays to train items.

For full details refer to this page: Track-related System-Item Attributes

Owning Portal Object Related System Attributes

These system attributes enable a subsystem to access its owning portals graphics without having to use a label list.

For full details refer to this page: Owning Portal Object Related System Attributes

System String Related System Attributes

These system attributes provide information to assist with File input and output and management.

For full details refer to this page: System String Related System Attributes

Model Run Engine Related System Attributes

These system attributes provide information to assist you in how to respond to activities and events in the Model during a Run.

For full details refer to this page: Model Run Engine Related System Attributes

Display Related System Attributes

These attribute relate to what is going on concerning the currently visible panels, and status bar displays etc.

For full details refer to this page: Display Related System Attributes

Table Related System Attributes

Relating to the currently-referenced table in a routine operation.

For full details refer to this page: Table Related System Attributes

Other (General) System Attributes

This is a collection of System Attributes that are available, but not strictly classifiable into the groups above.

For full details refer to this page: Other General System Attributes
Retrieved from ‘https://wiki.planimate.com/index.php?title=System_Attribute&oldid=2439’