OcaTemperatureSensor#
This document describes the controller implementation of OcaTemperatureSensor. This class is documented in the AES70 standard as:
Temperature sensor. Units of measure are Celsius.
Overview#
- ClassID: 1.1.2.5
- Header:
aes70/controller/OcaTemperatureSensor.hpp
- Namespace:
aes70::controller
- Inheritance: aes70::controller::OcaSensor, aes70::controller::OcaWorker, aes70::controller::OcaRoot, aes70::controller::object
Class Declaration#
namespace aes70::controller
{
class OcaTemperatureSensor : public OcaSensor
{
public:
OcaTemperatureSensor(std::shared_ptr<connection> connection,
uin32_t object_number);
OcaTemperatureSensor(const OcaTemperatureSensor &o);
// Control Methods
// Calls GetReading and calls on_result or on_failure
void GetReading(auto on_result, failure_callback on_failure);
// Observing Properties
subscription observeReading(auto callback, failure_callback on_failure);
// Property Changed Subscriptions
subscription OnReadingChanged(auto callback, failure_callback on_failure);
};
}
Methods#
GetReading#
void GetReading(auto on_result, failure_callback on_failure)
Calls the method GetReading in the remote device.
Parameters:#
auto on_result
: A callable (e.g. a lambda) with the following arguments:OcaTemperature Reading
OcaTemperature minReading
OcaTemperature maxReading
failure_callback on_failure
: A callback which is called on error.
observeReading#
subscription observeReading(auto callback, failure_callback on_failure)
Fetches the remote property Reading and subscribes for modifications. The callback is called with the initial values of Reading and whenever it changes.
Parameters:#
auto callback
: A callable (e.g. a lambda) with one argument:OcaTemperature Reading
failure_callback on_failure
: A callback which is called on error.
OnReadingChanged#
subscription OnReadingChanged(auto callback, failure_callback on_failure)
Parameters#
auto callback
: A callable (e.g. a lambda) with one argument:OcaTemperature Reading
failure_callback on_failure
: A callback which is called on error.