Package com.storedobject.iot

Class DataSet.AlarmStatus

java.lang.Object

com.storedobject.iot.DataSet.DataStatus<Boolean>

com.storedobject.iot.DataSet.AlarmStatus

Enclosing class:

DataSet

public static class DataSet.AlarmStatus
extends DataSet.DataStatus<Boolean>

Method Summary

Modifier and Type	Method	Description
int	alarm()	Determines the alarm status based on the current value and the defined alarm condition.
Boolean	getValue()	Returns the current boolean value of the alarm status.
AlarmSwitch	getValueDefinition()	Retrieves the associated AlarmSwitch value definition for the current data status.
String	statusLabel()	Returns the status label based on the alarm's state.
String	value()	Returns the string representation of the alarm's current value.

Methods inherited from class com.storedobject.iot.DataSet.DataStatus

alert, caption, dailyStatistics, display, equals, getAlarmMessage, getId, getUnit, hashCode, hourlyStatistics, label, monthlyStatistics, ordinality, significance, tooltip, value, value, weeklyStatistics, yearlyStatistics

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Details

getValueDefinition

public AlarmSwitch getValueDefinition()

Retrieves the associated AlarmSwitch value definition for the current data status.

Overrides:

getValueDefinition in class DataSet.DataStatus<Boolean>

Returns:

the AlarmSwitch object representing the value definition.

getValue

public Boolean getValue()

Returns the current boolean value of the alarm status.

Specified by:

getValue in class DataSet.DataStatus<Boolean>

Returns:

the current value of the alarm status, represented as a Boolean.

alarm

public int alarm()

Determines the alarm status based on the current value and the defined alarm condition.

Specified by:

alarm in class DataSet.DataStatus<Boolean>

Returns:

an integer representing the alarm status:

         - Returns 0 if the alarm condition is not met.
         - Returns -3 if the alarm should trigger but the condition is false.
         - Returns 3 if the alarm should trigger and the condition is true.
 

statusLabel

public String statusLabel()

Returns the status label based on the alarm's state.

Specified by:

statusLabel in class DataSet.DataStatus<Boolean>

Returns:

"Off" if the alarm state is 0, otherwise "On".

value

public String value()

Returns the string representation of the alarm's current value.

Specified by:

value in class DataSet.DataStatus<Boolean>

Returns:

"On" if the alarm value is true, otherwise "Off".