List of valid IGSS object functions for Calculation

Object Function

Object Type

Example

HighAlarm('objectname')

analog

HighAlarm('y1')

Gets the value of the high alarm atom for the analog object y1.

HighLimit('objectname')

analog

HighLimit('y2')
Gets the value of the high limit atom for the analog object y2.

SetPoint('objectname')

analog

SetPoint('y3')
Gets the value of the analog set point atom for the analog object y3.

Value('objectname')

analog

Value('y4')
Gets the value of the actual value atom for the analog object y4.

LowAlarm('objectname')

analog

LowAlarm('y5')
Gets the value of the low alarm atom for the analog object y5.

LowLimit('objectname')

analog

LowLimit('y6')
Gets the value of the low limit atom for the analog object y6.

StateValue('objectname')

digital

StateValue('m1')
Gets the value of the state atom for the digital object m1.

CmdValue('objectname')

digital

CmdValue('m2')
Gets the value of the command atom for the digital object m2.

AnalogValue('objectname')

digital

AnalogValue('m3')
Gets the value of the free value atom for the digital object m3.

CompareState('objectname', statename)

digital

CompareState('m4', ‘OFF’)
Compares the parameter StateName to the current name of the state atom of the digital object m4; returns 1 if the current state of m4 is ‘OFF’, otherwise 0.

CompareCmd('objectname', ‘CmdName’)

digital

CompareCmd('m5', ‘START’)
Compares the parameter CmdName to the current name of the command atom of the digital object m5; returns 1 if the current command of m5 is ‘START’, otherwise 0.

TableValue('objectname', index)

table

ValueValue('t1', 7)
Gets the value at index 7 from the table, t1.

AlarmNo('objectname')

all objects

AlarmNo('a1')
Returns the number of the active alarm on the object a1. If there are no active alarms on a1, then a 0 is returned.

MSecsSinceLastExec()

all objects

MSecsSinceLastExec()
If 150 milliseconds have elapsed since the latest execution/evaluation of the expression then the function returns the value 150.

MSecsSinceStart()

system start

MSecsSinceStart()
Returns the number of milliseconds since system start. If 20 minutes have elapsed since system start, then the function returns the value 20x60x1000 = 1200000.

InTimeInterval('HH:MM','HH:MM')

All objects

InTimeInterval('HH:MM','HH:MM')
If the clock on the PC is between the time interval keyed in, then the function returns 1, otherwise 0. NOTE: The time format is local time.