OcaFilterClassical

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

Classical analog-style filter - highpass, lowpass, bandpass, etc., with shape characteristics such as Butterworth, Chebyshev, Bessel, and Linkwitz-Riley.

---

Overview

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

Class Declaration

namespace aes70::controller
{
  class OcaFilterClassical : public OcaActuator
  {
  public:
    OcaFilterClassical(std::shared_ptr<connection> connection,
            uin32_t object_number);
    OcaFilterClassical(const OcaFilterClassical &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);
    // Calls GetPassband and calls on_result or on_failure
    void GetPassband(auto on_result, failure_callback on_failure);
    // Calls SetPassband and calls on_result or on_failure
    void SetPassband(OcaFilterPassband Passband, auto on_result, failure_callback on_failure);
    // Calls SetPassband and does not wait for the response
    void SetPassband(OcaFilterPassband Passband);
    // Calls GetShape and calls on_result or on_failure
    void GetShape(auto on_result, failure_callback on_failure);
    // Calls SetShape and calls on_result or on_failure
    void SetShape(OcaClassicalFilterShape Shape, auto on_result, failure_callback on_failure);
    // Calls SetShape and does not wait for the response
    void SetShape(OcaClassicalFilterShape Shape);
    // Calls GetOrder and calls on_result or on_failure
    void GetOrder(auto on_result, failure_callback on_failure);
    // Calls SetOrder and calls on_result or on_failure
    void SetOrder(OcaUint16 Order, auto on_result, failure_callback on_failure);
    // Calls SetOrder and does not wait for the response
    void SetOrder(OcaUint16 Order);
    // Calls GetParameter and calls on_result or on_failure
    void GetParameter(auto on_result, failure_callback on_failure);
    // Calls SetParameter and calls on_result or on_failure
    void SetParameter(OcaFloat32 Parameter, auto on_result, failure_callback on_failure);
    // Calls SetParameter and does not wait for the response
    void SetParameter(OcaFloat32 Parameter);
    // Calls SetMultiple and calls on_result or on_failure
    void SetMultiple(OcaParameterMask Mask, OcaFrequency Frequency, OcaFilterPassband Passband, OcaClassicalFilterShape Shape, OcaUint16 Order, OcaFloat32 Parameter, auto on_result, failure_callback on_failure);
    // Calls SetMultiple and does not wait for the response
    void SetMultiple(OcaParameterMask Mask, OcaFrequency Frequency, OcaFilterPassband Passband, OcaClassicalFilterShape Shape, OcaUint16 Order, OcaFloat32 Parameter);

    // Observing Properties
    subscription observeFrequency(auto callback, failure_callback on_failure);
    subscription observePassband(auto callback, failure_callback on_failure);
    subscription observeShape(auto callback, failure_callback on_failure);
    subscription observeOrder(auto callback, failure_callback on_failure);
    subscription observeParameter(auto callback, failure_callback on_failure);

    // Property Changed Subscriptions
    subscription OnFrequencyChanged(auto callback, failure_callback on_failure);
    subscription OnPassbandChanged(auto callback, failure_callback on_failure);
    subscription OnShapeChanged(auto callback, failure_callback on_failure);
    subscription OnOrderChanged(auto callback, failure_callback on_failure);
    subscription OnParameterChanged(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.

GetPassband

void GetPassband(auto on_result, failure_callback on_failure)

Calls the method GetPassband in the remote device.

Parameters:

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

SetPassband

void SetPassband(OcaFilterPassband Passband, auto on_result, failure_callback on_failure)

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

Parameters:

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

GetShape

void GetShape(auto on_result, failure_callback on_failure)

Calls the method GetShape in the remote device.

Parameters:

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

SetShape

void SetShape(OcaClassicalFilterShape Shape, auto on_result, failure_callback on_failure)

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

Parameters:

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

GetOrder

void GetOrder(auto on_result, failure_callback on_failure)

Calls the method GetOrder in the remote device.

Parameters:

• auto on_result: A callable (e.g. a lambda) with the following arguments:
  • OcaUint16 Order
  • OcaUint16 minOrder
  • OcaUint16 maxOrder
• failure_callback on_failure: A callback which is called on error.

SetOrder

void SetOrder(OcaUint16 Order, auto on_result, failure_callback on_failure)

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

Parameters:

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

GetParameter

void GetParameter(auto on_result, failure_callback on_failure)

Calls the method GetParameter in the remote device.

Parameters:

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

SetParameter

void SetParameter(OcaFloat32 Parameter, auto on_result, failure_callback on_failure)

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

Parameters:

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

SetMultiple

void SetMultiple(OcaParameterMask Mask, OcaFrequency Frequency, OcaFilterPassband Passband, OcaClassicalFilterShape Shape, OcaUint16 Order, OcaFloat32 Parameter, auto on_result, failure_callback on_failure)

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

Parameters:

• OcaParameterMask Mask
• OcaFrequency Frequency
• OcaFilterPassband Passband
• OcaClassicalFilterShape Shape
• OcaUint16 Order
• OcaFloat32 Parameter
• 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.

observePassband

subscription observePassband(auto callback, failure_callback on_failure)

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

Parameters:

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

observeShape

subscription observeShape(auto callback, failure_callback on_failure)

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

Parameters:

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

observeOrder

subscription observeOrder(auto callback, failure_callback on_failure)

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

Parameters:

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

observeParameter

subscription observeParameter(auto callback, failure_callback on_failure)

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

Parameters:

• auto callback: A callable (e.g. a lambda) with one argument: OcaFloat32 Parameter
• 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.

OnPassbandChanged

subscription OnPassbandChanged(auto callback, failure_callback on_failure)

Parameters

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

OnShapeChanged

subscription OnShapeChanged(auto callback, failure_callback on_failure)

Parameters

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

OnOrderChanged

subscription OnOrderChanged(auto callback, failure_callback on_failure)

Parameters

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

OnParameterChanged

subscription OnParameterChanged(auto callback, failure_callback on_failure)

Parameters

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