OcaBitstringActuator

This document describes the controller implementation of OcaBitstringActuator. This class is documented in the AES70 standard as:

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

---

Overview

• ClassID: 1.1.1.1.13
• Header: aes70/controller/OcaBitstringActuator.hpp
• Namespace: aes70::controller
• Inheritance: aes70::controller::OcaBasicActuator, aes70::controller::OcaActuator, aes70::controller::OcaWorker, aes70::controller::OcaRoot, aes70::controller::object

Class Declaration

namespace aes70::controller
{
  class OcaBitstringActuator : public OcaBasicActuator
  {
  public:
    OcaBitstringActuator(std::shared_ptr<connection> connection,
            uin32_t object_number);
    OcaBitstringActuator(const OcaBitstringActuator &o);

    // Control Methods
    // Calls GetNrBits and calls on_result or on_failure
    void GetNrBits(auto on_result, failure_callback on_failure);
    // Calls GetBit and calls on_result or on_failure
    void GetBit(OcaUint16 bitNr, auto on_result, failure_callback on_failure);
    // Calls GetBit and does not wait for the response
    void GetBit(OcaUint16 bitNr);
    // Calls SetBit and calls on_result or on_failure
    void SetBit(OcaUint16 bitNr, OcaBoolean Value, auto on_result, failure_callback on_failure);
    // Calls SetBit and does not wait for the response
    void SetBit(OcaUint16 bitNr, OcaBoolean Value);
    // Calls GetSetting and calls on_result or on_failure
    void GetSetting(auto on_result, failure_callback on_failure);
    // Calls SetSetting and calls on_result or on_failure
    void SetSetting(OcaBitstring Setting, auto on_result, failure_callback on_failure);
    // Calls SetSetting and does not wait for the response
    void SetSetting(OcaBitstring Setting);

    // Observing Properties
    subscription observeSetting(auto callback, failure_callback on_failure);

    // Property Changed Subscriptions
    subscription OnSettingChanged(auto callback, failure_callback on_failure);
  };
}

Methods

GetNrBits

void GetNrBits(auto on_result, failure_callback on_failure)

Calls the method GetNrBits in the remote device.

Parameters:

• auto on_result: A callable (e.g. a lambda) with the following arguments:
  • OcaUint16 nrBits
• failure_callback on_failure: A callback which is called on error.

GetBit

void GetBit(OcaUint16 bitNr, auto on_result, failure_callback on_failure)

Calls the method GetBit in the remote device. If no result and error callback is specified, the method will be called without requesting a response.

Parameters:

• OcaUint16 bitNr
• auto on_result: A callable (e.g. a lambda) with the following arguments:
  • OcaBoolean Value
• failure_callback on_failure: A callback which is called on error.

SetBit

void SetBit(OcaUint16 bitNr, OcaBoolean Value, auto on_result, failure_callback on_failure)

Calls the method SetBit in the remote device. If no result and error callback is specified, the method will be called without requesting a response.

Parameters:

• OcaUint16 bitNr
• OcaBoolean Value
• auto on_result: A callable (e.g. a lambda) with 0 arguments.
• failure_callback on_failure: A callback which is called on error.

GetSetting

void GetSetting(auto on_result, failure_callback on_failure)

Calls the method GetSetting in the remote device.

Parameters:

• auto on_result: A callable (e.g. a lambda) with the following arguments:
  • OcaBitstring Setting
• failure_callback on_failure: A callback which is called on error.

SetSetting

void SetSetting(OcaBitstring Setting, auto on_result, failure_callback on_failure)

Calls the method SetSetting in the remote device. If no result and error callback is specified, the method will be called without requesting a response.

Parameters:

• OcaBitstring Setting
• auto on_result: A callable (e.g. a lambda) with 0 arguments.
• failure_callback on_failure: A callback which is called on error.

observeSetting

subscription observeSetting(auto callback, failure_callback on_failure)

Fetches the remote property Setting and subscribes for modifications. The callback is called with the initial values of Setting and whenever it changes.

Parameters:

• auto callback: A callable (e.g. a lambda) with one argument: OcaBitstring Setting
• failure_callback on_failure: A callback which is called on error.

OnSettingChanged

subscription OnSettingChanged(auto callback, failure_callback on_failure)

Parameters

• auto callback: A callable (e.g. a lambda) with one argument: OcaBitstring Setting
• failure_callback on_failure: A callback which is called on error.