OcaStringActuator

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

UTF-8 String actuator.

---

Overview

• ClassID: 1.1.1.1.12
• Header: aes70/controller/OcaStringActuator.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 OcaStringActuator : public OcaBasicActuator
  {
  public:
    OcaStringActuator(std::shared_ptr<connection> connection,
            uin32_t object_number);
    OcaStringActuator(const OcaStringActuator &o);

    // Control Methods
    // 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(OcaString Setting, auto on_result, failure_callback on_failure);
    // Calls SetSetting and does not wait for the response
    void SetSetting(OcaString Setting);
    // Calls GetMaxLen and calls on_result or on_failure
    void GetMaxLen(auto on_result, failure_callback on_failure);

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

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

Methods

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:
  • OcaString Setting
• failure_callback on_failure: A callback which is called on error.

SetSetting

void SetSetting(OcaString 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:

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

GetMaxLen

void GetMaxLen(auto on_result, failure_callback on_failure)

Calls the method GetMaxLen in the remote device.

Parameters:

• auto on_result: A callable (e.g. a lambda) with the following arguments:
  • OcaUint16 Len
• 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: OcaString 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: OcaString Setting
• failure_callback on_failure: A callback which is called on error.