Index

Class OcaPowerManager

ClassID: 1.3.5

extends OcaManager

Optional manager that manages power settings and state.

Properties

static readonly OcaClassID ClassID = 1.3.5

Level: 1 Index: 1

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.

static readonly OcaClassVersionNumber ClassVersion = 2

Level: 1 Index: 2

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.

OcaPowerState State

Level: 3 Index: 1

Current power state of device. Readonly.

OcaList<OcaONo> PowerSupplies

Level: 3 Index: 2

List of object numbers of available power supplies.

OcaList<OcaONo> ActivePowerSupplies

Level: 3 Index: 3

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

OcaBoolean AutoState

Level: 3 Index: 4

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

readonly OcaPowerState TargetState

Level: 3 Index: 5

Power state to which the device is transitioning. If no transition is in progress, has value None. Readonly.

Properties inherited from OcaRoot

readonly OcaONo ObjectNumber

readonly OcaBoolean Lockable

readonly OcaString Role

Methods

OcaPowerManager::GetState ( ) → ( OcaPowerState State)

Level: 3 Index: 1

Retrieve the value of property 03p01 State, the current power state of the device. Return value indicates whether the value was successfully retrieved.

OcaPowerManager::SetState ( OcaPowerState State )

Level: 3 Index: 2

Change the device power state. The return value indicates whether the requested change has been successfully made.

OcaPowerManager::GetPowerSupplies ( ) → ( OcaList<OcaONo> psuList)

Level: 3 Index: 3

Retrieves list of object number(s) of all power supply(ies). Return value indicates whether the data was successfully retrieved.

OcaPowerManager::GetActivePowerSupplies ( ) → ( OcaList<OcaONo> psuList)

Level: 3 Index: 4

Retrieves list of object number(s) of active power supply(ies). Return value indicates whether the data was successfully retrieved.

OcaPowerManager::ExchangePowerSupply ( OcaONo oldPsu, OcaONo newPsu, OcaBoolean powerOffOld )

Level: 3 Index: 5

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. The return value indicates whether the requested exchange has been successfully made.

OcaPowerManager::GetAutoState ( ) → ( OcaBoolean state)

Level: 3 Index: 6

Gets the value of the AutoState property. The return value indicates whether the value was successfully retrieved.

Methods inherited from OcaRoot

OcaRoot::GetClassIdentification ( ) → ( OcaClassIdentification ClassIdentification)

OcaRoot::GetLockable ( ) → ( OcaBoolean lockable)

OcaRoot::LockTotal ( )

OcaRoot::Unlock ( )

OcaRoot::GetRole ( ) → ( OcaString Role)

OcaRoot::LockReadonly ( )