OcaPhysicalPosition

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

Physical position of device or an element of it. AES70 supports a variety of positional coordinate systems. For details, see AES70-1, section 5.5.9.

---

Overview

• ClassID: 1.2.17
• Header: aes70/controller/OcaPhysicalPosition.hpp
• Namespace: aes70::controller
• Inheritance: aes70::controller::OcaAgent, aes70::controller::OcaRoot, aes70::controller::object

Class Declaration

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

    // Control Methods
    // Calls GetCoordinateSystem and calls on_result or on_failure
    void GetCoordinateSystem(auto on_result, failure_callback on_failure);
    // Calls GetPositionDescriptorFieldFlags and calls on_result or on_failure
    void GetPositionDescriptorFieldFlags(auto on_result, failure_callback on_failure);
    // Calls GetPositionDescriptor and calls on_result or on_failure
    void GetPositionDescriptor(auto on_result, failure_callback on_failure);
    // Calls SetPositionDescriptor and calls on_result or on_failure
    void SetPositionDescriptor(OcaPositionDescriptor PositionDescriptor, auto on_result, failure_callback on_failure);
    // Calls SetPositionDescriptor and does not wait for the response
    void SetPositionDescriptor(OcaPositionDescriptor PositionDescriptor);

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

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

Methods

GetCoordinateSystem

void GetCoordinateSystem(auto on_result, failure_callback on_failure)

Calls the method GetCoordinateSystem in the remote device.

Parameters:

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

GetPositionDescriptorFieldFlags

void GetPositionDescriptorFieldFlags(auto on_result, failure_callback on_failure)

Calls the method GetPositionDescriptorFieldFlags in the remote device.

Parameters:

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

GetPositionDescriptor

void GetPositionDescriptor(auto on_result, failure_callback on_failure)

Calls the method GetPositionDescriptor in the remote device.

Parameters:

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

SetPositionDescriptor

void SetPositionDescriptor(OcaPositionDescriptor PositionDescriptor, auto on_result, failure_callback on_failure)

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

Parameters:

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

observePositionDescriptor

subscription observePositionDescriptor(auto callback, failure_callback on_failure)

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

Parameters:

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

OnPositionDescriptorChanged

subscription OnPositionDescriptorChanged(auto callback, failure_callback on_failure)

Parameters

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