EventState Type
The EventState
type provides the event state. It can be used to create values for the state property of the EventFilter.
Syntax
It is possible to create an EventState
object. See the following syntax.
var eventState = new EventState(<stateId>)
Parameters Usage
Parameter | Type | Default | Use | Annotation |
stateId | Integer
| - | Mandatory | Numeric identifier of the state. |
Properties
Property | Type | Description |
Id | Integer | Numeric identifier of the state. |
descriptor | String | Localized descriptor of the state. |
Error Handling
Errors can occur in case the event state id is not defined in the text group: Alarm State.
Example of Use
How to create the EventState with id 5 and print it to Console
var eventState = new EventState(5);
console(eventState)
The instructions above print to the Console expander:
id = 5
descriptor = Ready to be Reset