domain~ DeviceOperatingState

An enumeration of standardized device operating states.

Constructor

new DeviceOperatingState(name, bitNumber)

Constructor.

Parameters:
NameTypeDescription
namestring

the name

bitNumbernumber

the bit offset, starting from 1 for the least significant bit

Extends

Members

code

Get the state code value.

name

Get the enum name.

Methods

equals(value) → {boolean}

Test if a string is equal to this enum's name.

As long as enum values are consistently obtained from the module:util~Enum.enumValues array then enum instances can be compared with ===. If unsure, this method can be used to compare string values instead.

If value is passed as an actual Enum instance, then if that enum is the same class as this enum it's name is compared to this instance's name.

Parameters:
NameTypeDescription
valuestring | Enum

the value to test

Returns:

true if value is the same as this instance's name value

Type: 
boolean

(static) enumValues()

(static) forCode(code) → {DeviceOperatingState}

Get an enum for a code value.

Parameters:
NameTypeDescription
codenumber

the code to look for

Returns:

the state, or null if not found

Type: 
DeviceOperatingState