OcaTemperatureActuator

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

A temperature actuator with Celsius units of measure.

---

Overview

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

Class Declaration

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

    // Control Methods
    // Calls GetTemperature and calls on_result or on_failure
    void GetTemperature(auto on_result, failure_callback on_failure);
    // Calls SetTemperature and calls on_result or on_failure
    void SetTemperature(OcaTemperature temperature, auto on_result, failure_callback on_failure);
    // Calls SetTemperature and does not wait for the response
    void SetTemperature(OcaTemperature temperature);

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

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

Methods

GetTemperature

void GetTemperature(auto on_result, failure_callback on_failure)

Calls the method GetTemperature in the remote device.

Parameters:

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

SetTemperature

void SetTemperature(OcaTemperature temperature, auto on_result, failure_callback on_failure)

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

Parameters:

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

observeTemperature

subscription observeTemperature(auto callback, failure_callback on_failure)

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

Parameters:

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

OnTemperatureChanged

subscription OnTemperatureChanged(auto callback, failure_callback on_failure)

Parameters

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