System Attribute

System Attributes

System Attributes provide a way to access the numerous parameters that Planimate® manages as a model is run.

All attributes can be read, typically in a routine using a reference such as s.clock. In some cases they may be set by the modeller, enabling the behaviour of the run engine to be changed.

Uses for System Attributes

System attributes are useful for logging, deriving fields of the current date time, determining loaded data names, controlling animation and controlling routing of trains in track networks.

Note: Content below here is automatically generated. Updated from Planimate 5.30q.

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

• AdvanceToTime
• Clock
• ClockDayCount
• ClockDayOfMonth
• ClockDayOfWeek
• ClockDaysInMonth
• ClockHourOfDay
• ClockHourOfDay_1
• ClockMonthCount
• ClockMonthOfYear
• ClockTimeOfDay
• ClockVisible
• ClockWeekCount
• ClockWeekOfYear
• ClockYear
• RunInRealTime
• RunStartTimeReference
• SystemMultimediaTimer
• SystemRealTime
• SystemRealTimeOfDay
• TimeZoneCorrectionMIN

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

• BroadcastReceivers
• FollowLimit
• ItemActAsCarrier
• ItemClassInfoHide
• ItemClassScale
• ItemDelayLeft
• ItemFollow
• ItemID
• ItemLocation
• ItemLocationDetail
• ItemOwningItemID
• ItemPriority
• ItemRotation
• ItemRouteSectionID
• ItemsCarried
• ItemShowInfoPanel
• ItemTotalDelay
• ItemTraceAnimation
• ItemTransitDistance
• ItemTransitTarget
• ItemTransitTime
• ItemTransparency

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

• ItemImageTimeStepMS
• ItemImageXStep
• ItemImageYStep
• ItemXScale
• ItemYScale

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

• ItemLength
• ItemRouteDir
• ItemRouteID
• ItemRouteLocationID
• ItemRouteStep
• ItemRouteStepCount
• ItemTrackForwardColumn
• ItemTrackReverseColumn
• ItemTrailColor
• ItemTrailWidth
• LoopDelayOverride
• RouteTestRow
• TrackLastSectionId
• TrackLastSectionRoad
• TrackLoopEntryEnd
• TrackLoopEntryStart
• TrackLoopExitEnd
• TrackLoopExitStart
• TrackSectionNominalTime

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

• CurrentPanelStatus
• CurrentPortalHeight
• CurrentPortalWidth
• CurrentPortalX
• CurrentPortalXScale
• CurrentPortalY
• CurrentPortalYScale
• OwningPortalLocation

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

• DatasetFileAndPath
• LastAccessedDataFile
• LastAccessedDataFilePath
• LastErrorFileNamePath
• LastLockFileError
• LoadFileNamePath
• LocalComputerName
• ModelName
• ScenarioName
• UseLocale
• UserName
• UserNameCanonical
• UserNameNTCompatible
• UserNameQualified

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

• ActiveBroadcastIndex
• AdvancingToTime
• AnimationStartingMessage
• AutomaticRestartAfterError
• BackgroundRun
• ContinueRun
• DisableUndo
• DoingTrackCheckNext
• DS2LoadObjectLabelByIndex
• HandlingBroadcastOnly
• HaveCurrentPendingEvents
• LastRunStopReason
• LastRunStopTime
• ModelNeedsSaving
• MultipleRunCount
• PauseAfterAdvance
• Planimate64
• RandomSeedImmediate
• RandomSeedOnRestart
• RealTimeBCInEvent
• Rnd01
• RoutineInLookahead
• RunNumber
• UserMode

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

• ActivityBarColour
• ActivityState
• ActivityState0_1
• AnimationUpdateInterval
• CurrentPanelVisible
• EnableRepaintBC
• EnableTableCellEdit
• ItemAnimateSpeed
• LockDrawing
• LockPortalDrag
• MouseX
• MouseXOwner
• MouseXWindow
• MouseY
• MouseYOwner
• MouseYWindow
• PanelOwnerVisible
• TimeScaling
• TraceAnimation
• VisiblePanelID
• VisiblePortalIndex

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

• TableColumns
• TableRows

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

• ButtonPaintID
• CPUID
• CurrentObjectLocation
• EnableDebugLogger
• JobID
• KeyDate
• KeyName
• KeyOrg
• KeySerial
• NullAttribute
• ODBCErrorStatus
• PBA
• PipeTableRow
• PrintOrientation
• PrintPaperSize
• RuntimeBreakPointControl
• SpatialLinkScanDepth
• SystemID
• TotalObjectLabelCount
• UserEditedData