OcaFrequencyActuator

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

Simple frequency actuator.

---

Overview

• ClassID: 1.1.1.8
• Header: aes70/controller/OcaFrequencyActuator.hpp
• Namespace: aes70::controller
• Inheritance: aes70::controller::OcaActuator, aes70::controller::OcaWorker, aes70::controller::OcaRoot, aes70::controller::object

Class Declaration

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

    // Control Methods
    // Calls GetFrequency and calls on_result or on_failure
    void GetFrequency(auto on_result, failure_callback on_failure);
    // Calls SetFrequency and calls on_result or on_failure
    void SetFrequency(OcaFrequency Frequency, auto on_result, failure_callback on_failure);
    // Calls SetFrequency and does not wait for the response
    void SetFrequency(OcaFrequency Frequency);

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

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

Methods

GetFrequency

void GetFrequency(auto on_result, failure_callback on_failure)

Calls the method GetFrequency in the remote device.

Parameters:

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

SetFrequency

void SetFrequency(OcaFrequency Frequency, auto on_result, failure_callback on_failure)

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

Parameters:

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

observeFrequency

subscription observeFrequency(auto callback, failure_callback on_failure)

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

Parameters:

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

OnFrequencyChanged

subscription OnFrequencyChanged(auto callback, failure_callback on_failure)

Parameters

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