Point Status Functions

Scripting > CxScript > GlobalFunctions Library > Point Status Functions

Point Status Functions

The following functions are useful when writing scripts relating to status bits. These functions accept a single parameter, Status As Integer, which is the base status integer for a Point or HyperPoint object.

Point Type Functions
Point Direction Functions
Value Status
Analog Alarm Functions
Digital Alarm Functions
Enum Alarm Functions
String Alarm Functions
Alarm State Functions

Point Type Functions

Function	Description
IsAnalogPoint	Returns true if the point type is Analog.
IsDigitalPoint	Returns true if the point type is Digital.
IsEnumPoint	Returns true if the point type is Enumeration.
IsStringPoint	Returns true if the point type is String.

Point Direction Functions

Function	Description
IsInputPoint	Returns true if the point direction is Input.
IsOutputPoint	Returns true if the point direction is Output.

Value Status

Function	Description
IsInitialized	Returns true if the point has been initialized.
IsUnreliable	Returns true if the point value is unreliable.
IsUpdated	Returns true if the point has been updated.

Analog Alarm Functions

An error will occur if the point is not Analog.

Function	Description
IsHighAlarm	Returns true if the analog point is in High Alarm.
IsHighDeviation	Returns true if the analog point is in High Deviation.
IsHighOutOfRange	Returns true if the analog point is in High Out-of-Range.
IsHighWarning	Returns true if the analog point is in High Warning.
IsLowAlarm	Returns true if the analog point is in Low Alarm.
IsLowOutOfRange	Returns true if the analog point is in Low Out-of-Range.
IsLowWarning	Returns true if the analog point is in Low Warning.

Digital Alarm Functions

An error will occur if the point is not Digital.

Function	Description
IsDigitalAlarm	Returns true if the digital point is in Digital Alarm.
IsDigitalWarning	Returns true if the digital point is in Digital Warning.
IsDigitalChattering	Returns true if the digital point is Chattering.

Enum Alarm Functions

An error will occur if the point is not Enum.

Function	Description
IsEnumAlarm1	Returns true if the enumeration point is in Alarm State 1.
IsEnumAlarm2	Returns true if the enumeration point is in Alarm State 2.
IsEnumAlarm3	Returns true if the enumeration point is in Alarm State 3.
IsEnumAlarm4	Returns true if the enumeration point is in Alarm State 4.
IsEnumAlarm5	Returns true if the enumeration point is in Alarm State 5.
IsEnumAlarm6	Returns true if the enumeration point is in Alarm State 6.

String Alarm Functions

An error will occur if the point is not String.

Function	Description
IsStringAlarm1	Returns true if the string point is in Alarm State 1.
IsStringAlarm2	Returns true if the string point is in Alarm State 2.
IsStringAlarm3	Returns true if the string point is in Alarm State 3.
IsStringAlarm4	Returns true if the string point is in Alarm State 4.
IsStringAlarm5	Returns true if the string point is in Alarm State 5.
IsStringAlarm6	Returns true if the string point is in Alarm State 6.

Alarm State Functions

Function	Description
GetAlarmState	Returns the alarm state. This function returns a Long value. The return value is one of the values in the Alarm State Enumeration table. If more than one state is detected, only the highest valued state is returned. Note that the Unreliable state is returned as an alarm state and must be interrogated separately using the point status function, IsUnReliable.