OcaPowerSupply

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

A power supply.

---

Overview

• ClassID: 1.2.7
• Header: aes70/device/OcaPowerSupply.hpp
• Namespace: aes70::device
• Inheritance: aes70::device::OcaAgent, aes70::device::OcaRoot, aes70::device::object

Class Declaration

The device side implementation has the following signature.

namespace aes70::device
{
  template <class Implementation>
  class OcaPowerSupply : public OcaAgent<Implementation>
  {

  };
}

The template argument Implementation may implement the following methods.

Note

The signatures given here are just one possibility and that most methods are optional. Implement only those methods which make sense in the context of your device. See the documentation in Implementing AES70 Classes for more details.

class MyOcaPowerSupplyImplementation
{
  // Methods defined by OcaPowerSupply
  OcaPowerSupplyType GetType();
  OcaString GetModelInfo();
  OcaPowerSupplyState GetState();
  void SetState(OcaPowerSupplyState state);
  OcaBoolean GetCharging();
  OcaFloat32 GetLoadFractionAvailable();
  OcaFloat32 GetStorageFractionAvailable();
  OcaPowerSupplyLocation GetLocation();

  // Methods defined by OcaAgent
  OcaString GetLabel();
  void SetLabel(OcaString Label);
  OcaONo GetOwner();
  std::tuple<OcaRolePath,OcaONoPath> GetPath();

  // Methods defined by OcaRoot
  OcaBoolean GetLockable();
  void SetLockNoReadWrite();
  void Unlock();
  OcaString GetRole();
  void SetLockNoWrite();
  OcaLockState GetLockState();

};

Events