OcaBitstringActuator

A online version of the AES70 specification of this class can be found at http://docs.deuso.de.

The class is a subclass of OcaBasicActuator().

This class defines the properties

Name

JavaScript Type

AES70 Type

Bitstring

boolean[]

OcaBitstring

Furthermore, it inherits the properties ClassID, ClassVersion, ObjectNumber, Lockable, Role, Enabled, Ports, Label, Owner, Latency and Bitstring.

class OcaBitstringActuator(objectNumber, device)

Bitstring actuator. Maximum bitstring length is 65,536 bits.

OcaBitstringActuator.OnBitstringChanged

type: PropertyEvent.<Array.<boolean>>

This event is emitted when the property Bitstring changes in the remote object. The property Bitstring is described in the AES70 standard as follows. The bitstring data.

OcaBitstringActuator.GetBit(bitNr)

Gets the bit value of the given bit. The return value indicates whether the property was successfully gathered.

Arguments
  • bitNr (number) –

Returns

Promise.<boolean> – A promise which resolves to a single value of type boolean.

OcaBitstringActuator.GetBitstring()

Gets the entire bitstring.The return value indicates whether the property was successfully gathered.

Returns

Promise.<Array.<boolean>> – A promise which resolves to a single value of type boolean[].

OcaBitstringActuator.GetNrBits()

Gets the number of bits in the string. The return value indicates whether the property was successfully gathered.

Returns

Promise.<number> – A promise which resolves to a single value of type number.

OcaBitstringActuator.SetBit(bitNr, Value)

Sets the bit value of the given bit. The return value indicates whether the property was successfully set.

Arguments
  • bitNr (number) –

  • Value (boolean) –

Returns

Promise.<void>

OcaBitstringActuator.SetBitstring(BitString)

Sets the entire bitstring. The return value indicates whether the property was successfully set.

Arguments
  • BitString (Array.<boolean>) –

Returns

Promise.<void>