Skip to content

OcaIdentificationActuator#

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

Function that shall turn on some kind of human-detectable indicator for purposes of device identification during network setup. Physical form of indicator is not specified by AES70, so it could be anything, e.g.

LED, Foghorn, Smoke emitter, Little waving robot hand wearing white glove, Jack-in-the-box popout, et cetera

Overview#

Class Declaration#

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

    // Control Methods
    // Calls GetActive and calls on_result or on_failure
    void GetActive(auto on_result, failure_callback on_failure);
    // Calls SetActive and calls on_result or on_failure
    void SetActive(OcaBoolean active, auto on_result, failure_callback on_failure);
    // Calls SetActive and does not wait for the response
    void SetActive(OcaBoolean active);

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

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

Methods#

GetActive#

void GetActive(auto on_result, failure_callback on_failure)

Calls the method GetActive in the remote device.

Parameters:#

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

SetActive#

void SetActive(OcaBoolean active, auto on_result, failure_callback on_failure)

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

Parameters:#

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

observeActive#

subscription observeActive(auto callback, failure_callback on_failure)

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

Parameters:#

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

OnActiveChanged#

subscription OnActiveChanged(auto callback, failure_callback on_failure)

Parameters#

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