OIA

OIA

Operator Information Area (OIA) interface. The OIA object returns values which are defined in the OIAStatus object.

Mixes in EventEmitter for event listening.

Methods

getStatus() → {StatusSet}

Returns the set of enabled status flags.

Returns:
  • set containing the status information
Type
StatusSet

getCommErrorCode() → {Number}

Returns the current communication error code.

Returns:
  • The current communication error code. If one doesn't exist, it will be 0.
Type
Number

getProgErrorCode() → {Number}

Returns the current program error code.

Returns:
  • The current program error code. If one doesn't exist, it will be 0.
Type
Number

Events

Event.CHANGED

Fired when the OIA status or error code changes.

Parameters:
Name Type Description
event Object
Properties
Name Type Description
source OIA

The OIA object that fired the event.
statusSet StatusSet

The current status flags.
progErrorCode Number

The current program error code.
commErrorCode Number

The current communication error code.

Event.ERROR

Parameters:
Name Type Description
event Object
Properties
Name Type Description
source OIA

The OIA object that fired the event.
error Error

The error.