RealTimeOutputMachine GitHub

πŸ“Š Overview: 10 Properties 1 Constructor 6 Functions 16 Getters

πŸ“ Description

Creates real-time output object for displaying machine status on dashboard, calculates colors and metrics

πŸ• Last updated: 2025-12-10T11:45:24.149Z


πŸ“‘ Table of Contents


Properties

Property Type Default Description
RealTimeMachinesEntity cs.RealTimeMachinesEntity - Machine being monitored
WorksOrderEntity cs.WorksOrderEntity - Current works order on machine, can be Null if no order active
ProductEntity cs.ProductEntity - Product being manufactured, Null if no order active
ToolsEntity cs.ToolsEntity - Tool being used, Null if no order active
DownReasonsEntity cs.DownReasonsEntity - Current downtime reason if machine stopped, otherwise Null
AverageCycleTime Real - Average cycle time over recent cycles in seconds
RunningSlow Boolean - True if average cycle time exceeds tool’s target cycle time
MachineWheelsEntity cs.MachineWheelsEntity - Machine wheel/priority configuration
QuantityMade Integer - Total quantity produced on current works order
QuantityScrapped Integer - Total quantity scrapped on current works order

Constructor

constructor

[πŸ—οΈ constructor]

Class constructor($RealTimeMachinesEntity : cs.RealTimeMachinesEntity)

Creates real-time output object for displaying machine status on dashboard, calculates colors and metrics

Parameters:

Name Type Optional Description
$RealTimeMachinesEntity cs.RealTimeMachinesEntity - -

Functions

Regular Functions

ProcessColors

Function ProcessColors

Determines background and foreground colors for machine display based on machine state, downtime, temperature exceptions, etc.


setPrimaryColors

Function setPrimaryColors($BackgroundColor : Integer; $ForegroundColor : Integer)

Parameters:

Name Type Optional Description
$BackgroundColor Integer - -
$ForegroundColor Integer - -

setAlternatingColors

Function setAlternatingColors($BackgroundColor : Integer; $ForegroundColor : Integer)

Parameters:

Name Type Optional Description
$BackgroundColor Integer - -
$ForegroundColor Integer - -

setDateTimeColors

Function setDateTimeColors($BackgroundColor : Integer; $ForegroundColor : Integer)

Parameters:

Name Type Optional Description
$BackgroundColor Integer - -
$ForegroundColor Integer - -

setAlertColors

Function setAlertColors($BackgroundColor : Integer; $ForegroundColor : Integer)

Parameters:

Name Type Optional Description
$BackgroundColor Integer - -
$ForegroundColor Integer - -

setTimeRemainingText

Function setTimeRemainingText($Text : Text; $DateTime : Variant; $AdditionalSeconds : Real)

Parameters:

Name Type Optional Description
$Text Text - -
$DateTime Variant - -
$AdditionalSeconds Real - -

Computed Attributes (Getters/Setters/Query/OrderBy)

AlertsText

[πŸ” get only]

Function get AlertsText -> Text

Returns: Text


DeviceMaintenanceActive

[πŸ” get only]

Function get DeviceMaintenanceActive -> Boolean

Returns: Boolean


MachineDisconnected

[πŸ” get only]

Function get MachineDisconnected -> Boolean

Returns: Boolean


MachineNumberText

[πŸ” get only]

Function get MachineNumberText -> Text

Returns: Text


MachineRunning

[πŸ” get only]

Function get MachineRunning -> Boolean

Returns: Boolean


MouldStatusText

[πŸ” get only]

Function get MouldStatusText -> Text

Returns: Text


PartNameText

[πŸ” get only]

Function get PartNameText -> Text

Returns: Text


PartsMadeText

[πŸ” get only]

Function get PartsMadeText -> Text

Returns: Text


PercentMade

[πŸ” get only]

Function get PercentMade -> Real

Returns: Real


PrimaryStatusText

[πŸ” get only]

Function get PrimaryStatusText -> Text

Returns: Text


ScrapText

[πŸ” get only]

Function get ScrapText -> Text

Returns: Text


SecondaryStatusText

[πŸ” get only]

Function get SecondaryStatusText -> $DateTimeObject : Object

Returns object with status text template and datetime for secondary status line (e.g., last activity, temperature exceptions)

Returns: Object


TimeRemainingText

[πŸ” get only]

Function get TimeRemainingText -> $DateTimeObject : Object

Returns: Object


UnacknowledgedSensorExceptions

[πŸ” get only]

Function get UnacknowledgedSensorExceptions -> Boolean

Returns: Boolean


UnicodeSymbolsText

[πŸ” get only]

Function get UnicodeSymbolsText -> Text

Returns: Text


WorksOrderIsOpen

[πŸ” get only]

Function get WorksOrderIsOpen -> Boolean

Returns: Boolean



Generated from RealTimeOutputMachine.4dm