Skip to content

OcaPowerSupply#

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

A power supply.

Overview#

Class Declaration#

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

    // Control Methods
    // Calls GetType and calls on_result or on_failure
    void GetType(auto on_result, failure_callback on_failure);
    // Calls GetModelInfo and calls on_result or on_failure
    void GetModelInfo(auto on_result, failure_callback on_failure);
    // Calls GetState and calls on_result or on_failure
    void GetState(auto on_result, failure_callback on_failure);
    // Calls SetState and calls on_result or on_failure
    void SetState(OcaPowerSupplyState state, auto on_result, failure_callback on_failure);
    // Calls SetState and does not wait for the response
    void SetState(OcaPowerSupplyState state);
    // Calls GetCharging and calls on_result or on_failure
    void GetCharging(auto on_result, failure_callback on_failure);
    // Calls GetLoadFractionAvailable and calls on_result or on_failure
    void GetLoadFractionAvailable(auto on_result, failure_callback on_failure);
    // Calls GetStorageFractionAvailable and calls on_result or on_failure
    void GetStorageFractionAvailable(auto on_result, failure_callback on_failure);
    // Calls GetLocation and calls on_result or on_failure
    void GetLocation(auto on_result, failure_callback on_failure);

    // Observing Properties
    subscription observeType(auto callback, failure_callback on_failure);
    subscription observeModelInfo(auto callback, failure_callback on_failure);
    subscription observeState(auto callback, failure_callback on_failure);
    subscription observeCharging(auto callback, failure_callback on_failure);
    subscription observeLoadFractionAvailable(auto callback, failure_callback on_failure);
    subscription observeStorageFractionAvailable(auto callback, failure_callback on_failure);

    // Property Changed Subscriptions
    subscription OnTypeChanged(auto callback, failure_callback on_failure);
    subscription OnModelInfoChanged(auto callback, failure_callback on_failure);
    subscription OnStateChanged(auto callback, failure_callback on_failure);
    subscription OnChargingChanged(auto callback, failure_callback on_failure);
    subscription OnLoadFractionAvailableChanged(auto callback, failure_callback on_failure);
    subscription OnStorageFractionAvailableChanged(auto callback, failure_callback on_failure);
  };
}

Methods#

GetType#

void GetType(auto on_result, failure_callback on_failure)

Calls the method GetType in the remote device.

Parameters:#

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

GetModelInfo#

void GetModelInfo(auto on_result, failure_callback on_failure)

Calls the method GetModelInfo in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaString info
  • 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:
    • OcaPowerSupplyState state
  • failure_callback on_failure: A callback which is called on error.

SetState#

void SetState(OcaPowerSupplyState state, auto on_result, failure_callback on_failure)

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

Parameters:#

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

GetCharging#

void GetCharging(auto on_result, failure_callback on_failure)

Calls the method GetCharging in the remote device.

Parameters:#

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

GetLoadFractionAvailable#

void GetLoadFractionAvailable(auto on_result, failure_callback on_failure)

Calls the method GetLoadFractionAvailable in the remote device.

Parameters:#

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

GetStorageFractionAvailable#

void GetStorageFractionAvailable(auto on_result, failure_callback on_failure)

Calls the method GetStorageFractionAvailable in the remote device.

Parameters:#

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

GetLocation#

void GetLocation(auto on_result, failure_callback on_failure)

Calls the method GetLocation in the remote device.

Parameters:#

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

observeType#

subscription observeType(auto callback, failure_callback on_failure)

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

Parameters:#

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

observeModelInfo#

subscription observeModelInfo(auto callback, failure_callback on_failure)

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

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaString ModelInfo
  • 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: OcaPowerSupplyState State
  • failure_callback on_failure: A callback which is called on error.

observeCharging#

subscription observeCharging(auto callback, failure_callback on_failure)

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

Parameters:#

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

observeLoadFractionAvailable#

subscription observeLoadFractionAvailable(auto callback, failure_callback on_failure)

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

Parameters:#

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

observeStorageFractionAvailable#

subscription observeStorageFractionAvailable(auto callback, failure_callback on_failure)

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

Parameters:#

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

OnTypeChanged#

subscription OnTypeChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnModelInfoChanged#

subscription OnModelInfoChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaString ModelInfo
  • 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: OcaPowerSupplyState State
  • failure_callback on_failure: A callback which is called on error.

OnChargingChanged#

subscription OnChargingChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnLoadFractionAvailableChanged#

subscription OnLoadFractionAvailableChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnStorageFractionAvailableChanged#

subscription OnStorageFractionAvailableChanged(auto callback, failure_callback on_failure)

Parameters#

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