OcaPowerManager#
This document describes the device side implementation of OcaPowerManager. This class is documented in the AES70 standard as:
Optional manager that manages power settings and state. May be instantiated at most once in any device., If instantiated, object number must be 5.
Overview#
- ClassID: 1.3.5
- Header:
aes70/device/OcaPowerManager.hpp
- Namespace:
aes70::device
- Inheritance: aes70::device::OcaManager, aes70::device::OcaRoot, aes70::device::object
Class Declaration#
The device side implementation has the following signature.
namespace aes70::device
{
template <class Implementation>
class OcaPowerManager : public OcaManager<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 MyOcaPowerManagerImplementation
{
// Methods defined by OcaPowerManager
OcaPowerState GetState();
void SetTargetState(OcaPowerState State);
OcaList<OcaONo> GetPowerSupplies();
OcaList<OcaONo> GetActivePowerSupplies();
void ExchangePowerSupply(OcaONo oldPsu, OcaONo newPsu, OcaBoolean powerOffOld);
OcaBoolean GetAutoState();
OcaPowerState GetTargetState();
// Methods defined by OcaRoot
OcaBoolean GetLockable();
void SetLockNoReadWrite();
void Unlock();
OcaString GetRole();
void SetLockNoWrite();
OcaLockState GetLockState();
};