Other (General) System Attributes

From Planimate Knowledge Base
Jump to: navigation, search

Other (General) System Attributes

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


Name

Read / Write

Description


ButtonPaintID

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.


CPUID

W

System attribute s.CPUID returns a value identifying the type and revision of the CPU.

This is intended to help modellers secure their models from copying.

It is not a unique CPU serial number as modern cpus do not support this.


CurrentObjectLocation

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.


JobID

R

This gives access to the existing command line option:

/JOBID=xxx

where xxx is a number.

It can be useful in passing a number to a model from the command line.


NullAttribute

W

Enables dialog results etc. to be thrown away without having to create a dummy attribute.


ODBCErrorStatus

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.

PBA

R

Returns true (1) if run is in a compiled exe.


PrintOrientation

W

Enables setting the page orientation. Use a value from the _print_orientation label list. The value is set to the actual orientation after a printout.

PrintPaperSize

W

Enables setting the paper size for printing. Use a value from the _print_papersize label list. The vlaue is set to the actual paper size code after a printout.

RuntimeBreakPointControl

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.


SpatialLlinkScanDepth

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.


SystemID

R

This returns the volume serial number of the drive containing the Windows system32 directory.

It may be useful to modellers wishing to help secure their models from copying.

Note that a user can set the volume serial number of a drive.


TotalObjectLabelCount

R

With this attribute, the model can query the number of objects which are in the _Model Objects label list



UserEditedData

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