OcaPanBalance

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

Pan or Balance control.

---

Overview

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

Class Declaration

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

    // Control Methods
    // Calls GetPosition and calls on_result or on_failure
    void GetPosition(auto on_result, failure_callback on_failure);
    // Calls SetPosition and calls on_result or on_failure
    void SetPosition(OcaFloat32 Position, auto on_result, failure_callback on_failure);
    // Calls SetPosition and does not wait for the response
    void SetPosition(OcaFloat32 Position);
    // Calls GetMidpointGain and calls on_result or on_failure
    void GetMidpointGain(auto on_result, failure_callback on_failure);
    // Calls SetMidpointGain and calls on_result or on_failure
    void SetMidpointGain(OcaDB Gain, auto on_result, failure_callback on_failure);
    // Calls SetMidpointGain and does not wait for the response
    void SetMidpointGain(OcaDB Gain);

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

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

Methods

GetPosition

void GetPosition(auto on_result, failure_callback on_failure)

Calls the method GetPosition in the remote device.

Parameters:

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

SetPosition

void SetPosition(OcaFloat32 Position, auto on_result, failure_callback on_failure)

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

Parameters:

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

GetMidpointGain

void GetMidpointGain(auto on_result, failure_callback on_failure)

Calls the method GetMidpointGain in the remote device.

Parameters:

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

SetMidpointGain

void SetMidpointGain(OcaDB Gain, auto on_result, failure_callback on_failure)

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

Parameters:

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

observePosition

subscription observePosition(auto callback, failure_callback on_failure)

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

Parameters:

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

observeMidpointGain

subscription observeMidpointGain(auto callback, failure_callback on_failure)

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

Parameters:

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

OnPositionChanged

subscription OnPositionChanged(auto callback, failure_callback on_failure)

Parameters

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

OnMidpointGainChanged

subscription OnMidpointGainChanged(auto callback, failure_callback on_failure)

Parameters

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