Skip to content

OcaDeviceManager#

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

Mandatory manager that contains information relevant to the whole device. Must be instantiated once in every device., Must have object number 1.

Overview#

Class Declaration#

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

    // Control Methods
    // Calls GetOcaVersion and calls on_result or on_failure
    void GetOcaVersion(auto on_result, failure_callback on_failure);
    // Calls GetModelGUID and calls on_result or on_failure
    void GetModelGUID(auto on_result, failure_callback on_failure);
    // Calls GetSerialNumber and calls on_result or on_failure
    void GetSerialNumber(auto on_result, failure_callback on_failure);
    // Calls GetDeviceName and calls on_result or on_failure
    void GetDeviceName(auto on_result, failure_callback on_failure);
    // Calls SetDeviceName and calls on_result or on_failure
    void SetDeviceName(OcaString Name, auto on_result, failure_callback on_failure);
    // Calls SetDeviceName and does not wait for the response
    void SetDeviceName(OcaString Name);
    // Calls GetModelDescription and calls on_result or on_failure
    void GetModelDescription(auto on_result, failure_callback on_failure);
    // Calls GetDeviceRole and calls on_result or on_failure
    void GetDeviceRole(auto on_result, failure_callback on_failure);
    // Calls SetDeviceRole and calls on_result or on_failure
    void SetDeviceRole(OcaString role, auto on_result, failure_callback on_failure);
    // Calls SetDeviceRole and does not wait for the response
    void SetDeviceRole(OcaString role);
    // Calls GetUserInventoryCode and calls on_result or on_failure
    void GetUserInventoryCode(auto on_result, failure_callback on_failure);
    // Calls SetUserInventoryCode and calls on_result or on_failure
    void SetUserInventoryCode(OcaString Code, auto on_result, failure_callback on_failure);
    // Calls SetUserInventoryCode and does not wait for the response
    void SetUserInventoryCode(OcaString Code);
    // Calls GetEnabled and calls on_result or on_failure
    void GetEnabled(auto on_result, failure_callback on_failure);
    // Calls SetEnabled and calls on_result or on_failure
    void SetEnabled(OcaBoolean enabled, auto on_result, failure_callback on_failure);
    // Calls SetEnabled and does not wait for the response
    void SetEnabled(OcaBoolean enabled);
    // Calls GetState and calls on_result or on_failure
    void GetState(auto on_result, failure_callback on_failure);
    // Calls SetResetKey and calls on_result or on_failure
    void SetResetKey(OcaBlobFixedLen<16> Key, OcaNetworkAddress Address, auto on_result, failure_callback on_failure);
    // Calls SetResetKey and does not wait for the response
    void SetResetKey(OcaBlobFixedLen<16> Key, OcaNetworkAddress Address);
    // Calls GetResetCause and calls on_result or on_failure
    void GetResetCause(auto on_result, failure_callback on_failure);
    // Calls ClearResetCause and calls on_result or on_failure
    void ClearResetCause(auto on_result, failure_callback on_failure);
    // Calls GetMessage and calls on_result or on_failure
    void GetMessage(auto on_result, failure_callback on_failure);
    // Calls SetMessage and calls on_result or on_failure
    void SetMessage(OcaString Text, auto on_result, failure_callback on_failure);
    // Calls SetMessage and does not wait for the response
    void SetMessage(OcaString Text);
    // Calls GetManagers and calls on_result or on_failure
    void GetManagers(auto on_result, failure_callback on_failure);
    // Calls GetDeviceRevisionID and calls on_result or on_failure
    void GetDeviceRevisionID(auto on_result, failure_callback on_failure);
    // Calls GetManufacturer and calls on_result or on_failure
    void GetManufacturer(auto on_result, failure_callback on_failure);
    // Calls GetProduct and calls on_result or on_failure
    void GetProduct(auto on_result, failure_callback on_failure);
    // Calls GetOperationalState and calls on_result or on_failure
    void GetOperationalState(auto on_result, failure_callback on_failure);
    // Calls GetLoggingEnabled and calls on_result or on_failure
    void GetLoggingEnabled(auto on_result, failure_callback on_failure);
    // Calls SetLoggingEnabled and calls on_result or on_failure
    void SetLoggingEnabled(OcaBoolean Enabled, auto on_result, failure_callback on_failure);
    // Calls SetLoggingEnabled and does not wait for the response
    void SetLoggingEnabled(OcaBoolean Enabled);
    // Calls GetMostRecentPatchDatasetONo and calls on_result or on_failure
    void GetMostRecentPatchDatasetONo(auto on_result, failure_callback on_failure);
    // Calls ApplyPatch and calls on_result or on_failure
    void ApplyPatch(OcaONo ONo, auto on_result, failure_callback on_failure);
    // Calls ApplyPatch and does not wait for the response
    void ApplyPatch(OcaONo ONo);

    // Observing Properties
    subscription observeModelGUID(auto callback, failure_callback on_failure);
    subscription observeModelDescription(auto callback, failure_callback on_failure);
    subscription observeDeviceName(auto callback, failure_callback on_failure);
    subscription observeDeviceRole(auto callback, failure_callback on_failure);
    subscription observeUserInventoryCode(auto callback, failure_callback on_failure);
    subscription observeControlEnabled(auto callback, failure_callback on_failure);
    subscription observeState(auto callback, failure_callback on_failure);
    subscription observeBusy(auto callback, failure_callback on_failure);
    subscription observeMessage(auto callback, failure_callback on_failure);
    subscription observeManagers(auto callback, failure_callback on_failure);
    subscription observeOperationalState(auto callback, failure_callback on_failure);
    subscription observeLoggingEnabled(auto callback, failure_callback on_failure);
    subscription observeMostRecentPatchDatasetONo(auto callback, failure_callback on_failure);

    // Property Changed Subscriptions
    subscription OnModelGUIDChanged(auto callback, failure_callback on_failure);
    subscription OnModelDescriptionChanged(auto callback, failure_callback on_failure);
    subscription OnDeviceNameChanged(auto callback, failure_callback on_failure);
    subscription OnDeviceRoleChanged(auto callback, failure_callback on_failure);
    subscription OnUserInventoryCodeChanged(auto callback, failure_callback on_failure);
    subscription OnControlEnabledChanged(auto callback, failure_callback on_failure);
    subscription OnStateChanged(auto callback, failure_callback on_failure);
    subscription OnBusyChanged(auto callback, failure_callback on_failure);
    subscription OnMessageChanged(auto callback, failure_callback on_failure);
    subscription OnManagersChanged(auto callback, failure_callback on_failure);
    subscription OnOperationalStateChanged(auto callback, failure_callback on_failure);
    subscription OnLoggingEnabledChanged(auto callback, failure_callback on_failure);
    subscription OnMostRecentPatchDatasetONoChanged(auto callback, failure_callback on_failure);
  };
}

Methods#

GetOcaVersion#

void GetOcaVersion(auto on_result, failure_callback on_failure)

Calls the method GetOcaVersion in the remote device.

Parameters:#

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

GetModelGUID#

void GetModelGUID(auto on_result, failure_callback on_failure)

Calls the method GetModelGUID in the remote device.

Parameters:#

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

GetSerialNumber#

void GetSerialNumber(auto on_result, failure_callback on_failure)

Calls the method GetSerialNumber in the remote device.

Parameters:#

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

GetDeviceName#

void GetDeviceName(auto on_result, failure_callback on_failure)

Calls the method GetDeviceName in the remote device.

Parameters:#

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

SetDeviceName#

void SetDeviceName(OcaString Name, auto on_result, failure_callback on_failure)

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

Parameters:#

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

GetModelDescription#

void GetModelDescription(auto on_result, failure_callback on_failure)

Calls the method GetModelDescription in the remote device.

Parameters:#

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

GetDeviceRole#

void GetDeviceRole(auto on_result, failure_callback on_failure)

Calls the method GetDeviceRole in the remote device.

Parameters:#

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

SetDeviceRole#

void SetDeviceRole(OcaString role, auto on_result, failure_callback on_failure)

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

Parameters:#

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

GetUserInventoryCode#

void GetUserInventoryCode(auto on_result, failure_callback on_failure)

Calls the method GetUserInventoryCode in the remote device.

Parameters:#

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

SetUserInventoryCode#

void SetUserInventoryCode(OcaString Code, auto on_result, failure_callback on_failure)

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

Parameters:#

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

GetEnabled#

void GetEnabled(auto on_result, failure_callback on_failure)

Calls the method GetEnabled in the remote device.

Parameters:#

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

SetEnabled#

void SetEnabled(OcaBoolean enabled, auto on_result, failure_callback on_failure)

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

Parameters:#

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

GetState#

void GetState(auto on_result, failure_callback on_failure)

Calls the method GetState in the remote device.

Parameters:#

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

SetResetKey#

void SetResetKey(OcaBlobFixedLen<16> Key, OcaNetworkAddress Address, auto on_result, failure_callback on_failure)

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

Parameters:#

  • OcaBlobFixedLen<16> Key
  • OcaNetworkAddress Address
  • auto on_result: A callable (e.g. a lambda) with 0 arguments.
  • failure_callback on_failure: A callback which is called on error.

GetResetCause#

void GetResetCause(auto on_result, failure_callback on_failure)

Calls the method GetResetCause in the remote device.

Parameters:#

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

ClearResetCause#

void ClearResetCause(auto on_result, failure_callback on_failure)

Calls the method ClearResetCause in the remote device.

Parameters:#

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

GetMessage#

void GetMessage(auto on_result, failure_callback on_failure)

Calls the method GetMessage in the remote device.

Parameters:#

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

SetMessage#

void SetMessage(OcaString Text, auto on_result, failure_callback on_failure)

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

Parameters:#

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

GetManagers#

void GetManagers(auto on_result, failure_callback on_failure)

Calls the method GetManagers in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaList<OcaManagerDescriptor> Managers
  • failure_callback on_failure: A callback which is called on error.

GetDeviceRevisionID#

void GetDeviceRevisionID(auto on_result, failure_callback on_failure)

Calls the method GetDeviceRevisionID in the remote device.

Parameters:#

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

GetManufacturer#

void GetManufacturer(auto on_result, failure_callback on_failure)

Calls the method GetManufacturer in the remote device.

Parameters:#

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

GetProduct#

void GetProduct(auto on_result, failure_callback on_failure)

Calls the method GetProduct in the remote device.

Parameters:#

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

GetOperationalState#

void GetOperationalState(auto on_result, failure_callback on_failure)

Calls the method GetOperationalState in the remote device.

Parameters:#

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

GetLoggingEnabled#

void GetLoggingEnabled(auto on_result, failure_callback on_failure)

Calls the method GetLoggingEnabled in the remote device.

Parameters:#

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

SetLoggingEnabled#

void SetLoggingEnabled(OcaBoolean Enabled, auto on_result, failure_callback on_failure)

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

Parameters:#

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

GetMostRecentPatchDatasetONo#

void GetMostRecentPatchDatasetONo(auto on_result, failure_callback on_failure)

Calls the method GetMostRecentPatchDatasetONo in the remote device.

Parameters:#

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

ApplyPatch#

void ApplyPatch(OcaONo ONo, auto on_result, failure_callback on_failure)

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

Parameters:#

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

observeModelGUID#

subscription observeModelGUID(auto callback, failure_callback on_failure)

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

Parameters:#

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

observeModelDescription#

subscription observeModelDescription(auto callback, failure_callback on_failure)

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

Parameters:#

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

observeDeviceName#

subscription observeDeviceName(auto callback, failure_callback on_failure)

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

Parameters:#

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

observeDeviceRole#

subscription observeDeviceRole(auto callback, failure_callback on_failure)

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

Parameters:#

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

observeUserInventoryCode#

subscription observeUserInventoryCode(auto callback, failure_callback on_failure)

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

Parameters:#

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

observeControlEnabled#

subscription observeControlEnabled(auto callback, failure_callback on_failure)

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

Parameters:#

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

observeState#

subscription observeState(auto callback, failure_callback on_failure)

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

Parameters:#

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

observeBusy#

subscription observeBusy(auto callback, failure_callback on_failure)

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

Parameters:#

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

observeMessage#

subscription observeMessage(auto callback, failure_callback on_failure)

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

Parameters:#

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

observeManagers#

subscription observeManagers(auto callback, failure_callback on_failure)

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

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaList<OcaManagerDescriptor> Managers
  • failure_callback on_failure: A callback which is called on error.

observeOperationalState#

subscription observeOperationalState(auto callback, failure_callback on_failure)

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

Parameters:#

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

observeLoggingEnabled#

subscription observeLoggingEnabled(auto callback, failure_callback on_failure)

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

Parameters:#

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

observeMostRecentPatchDatasetONo#

subscription observeMostRecentPatchDatasetONo(auto callback, failure_callback on_failure)

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

Parameters:#

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

OnModelGUIDChanged#

subscription OnModelGUIDChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnModelDescriptionChanged#

subscription OnModelDescriptionChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnDeviceNameChanged#

subscription OnDeviceNameChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnDeviceRoleChanged#

subscription OnDeviceRoleChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnUserInventoryCodeChanged#

subscription OnUserInventoryCodeChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnControlEnabledChanged#

subscription OnControlEnabledChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnStateChanged#

subscription OnStateChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnBusyChanged#

subscription OnBusyChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnMessageChanged#

subscription OnMessageChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnManagersChanged#

subscription OnManagersChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaList<OcaManagerDescriptor> Managers
  • failure_callback on_failure: A callback which is called on error.

OnOperationalStateChanged#

subscription OnOperationalStateChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnLoggingEnabledChanged#

subscription OnLoggingEnabledChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnMostRecentPatchDatasetONoChanged#

subscription OnMostRecentPatchDatasetONoChanged(auto callback, failure_callback on_failure)

Parameters#

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