1.3.5 OcaPowerManager

Class Hierarchy:

OcaRoot : OcaManager : OcaPowerManager

class OcaPowerManager : OcaManager

Optional manager that manages power settings and state.

  • May be instantiated at most once in any device.

  • If instantiated, object number must be 5.

Properties:

OcaList<OcaONo> ActivePowerSupplies

Object number(s) of power suppl(ies) currently in use.

This property has id 3.3.

OcaBoolean AutoState

True if current state was invoked automatically, not by a controller action. Readonly.

This property has id 3.4.

static const OcaClassID ClassID = "1.3.5"

Number that uniquely identifies the class. Note that this differs from the object number, which identifies the instantiated object. This property is an override of the OcaRoot property.

This property has id 1.1.

static const OcaClassVersionNumber ClassVersion = 3

Identifies the interface version of the class. Any change to the class definition leads to a higher class version. This property is an override of the OcaRoot property.

This property has id 1.2.

OcaList<OcaONo> PowerSupplies

List of object numbers of available power supplies.

This property has id 3.2.

OcaPowerState State

Current power state of device. Readonly.

This property has id 3.1.

OcaPowerState TargetState

Power state to which the device is transitioning. If no transition is in progress, has value None. Set by calls to SetTargetState().

This property has id 3.5.

Properties inherited from 1.3 OcaManager:

Methods:

OcaStatus GetState(OcaPowerState &State)

Retrieve the value of property State, the current power state of the device.

This method has id 3.1.

  • State: Output parameter.

OcaStatus SetTargetState(OcaPowerState State)

Change the target power state. Erroneously named SetState prior to v3 of this class.

This method has id 3.2.

  • State: Input parameter.

OcaStatus GetPowerSupplies(OcaList<OcaONo> &psuList)

Retrieves list of object number(s) of all power supply(ies).

This method has id 3.3.

OcaStatus GetActivePowerSupplies(OcaList<OcaONo> &psuList)

Retrieves list of object number(s) of active power supply(ies).

This method has id 3.4.

OcaStatus ExchangePowerSupply(OcaONo oldPsu, OcaONo newPsu, OcaBoolean powerOffOld)

Deactivate one power supply and activate another. An option switch indicates whether the previously active power supply is to be turned off. If it is not turned off, it will be placed in the Unavailable state.

This method has id 3.5.

OcaStatus GetAutoState(OcaBoolean &state)

Gets the value of the AutoState property.

This method has id 3.6.

  • state: Output parameter.

OcaStatus GetTargetState(OcaPowerState &State)

Retrieve the value of property** TargetState**, the power state of the device to which the device is transitioning.

This method has id 3.7.

  • State: Output parameter.

Methods inherited from 1.3 OcaManager: