pdumodel::ShelfPowerSupply Interface Reference

Shelf power supply interface. More...

import "ShelfPowerSupply.idl";

Inheritance diagram for pdumodel::ShelfPowerSupply:

Classes
struct	FanSpeedControlEvent
	Event: Fan speed target was set. More...
struct	FaultsClearedEvent
	Event: Fault states of PSU were cleared. More...
struct	InputSensors
	Power supply input (AC) sensors. More...
struct	MetaData
	Power supply metadata. More...
struct	MetaDataChangedEvent
	Event: Metadata has changed. More...
struct	OutputSensors
	Power supply output (DC) sensors. More...
struct	PowerControlEvent
	Event: Power control was initiated. More...
struct	PowerSupplySensors
	Power supply auxiliary sensors. More...
struct	State
	Power supply state. More...
struct	StateChangedEvent
	Event: Power supply state has changed. More...

Public Types
enum	PowerState { PS_OFF , PS_ON }
	Power supply power state. More...

Public Member Functions
MetaData	getMetaData ()
	Retrieve the power supply metadata.
State	getState ()
	Get current PSU state.
InputSensors	getInputSensors ()
	Get the input (AC side) sensors.
OutputSensors	getOutputSensors ()
	Get the output (DC side) sensors.
PowerSupplySensors	getPowerSupplySensors ()
	Get the auxiliary sensors.
int	setPowerState (in PowerState pstate)
	Turn PSU on or off.
int	setFanSpeedOverride (in boolean enableOverride, in int fanSpeedPercent)
	Set PSU fan speed override.
void	clearFaults ()
	Clear any PSU internal fault states.
vector< Pole >	getInputPoles ()
	Get the input (AC side) poles.
vector< Pole >	getOutputPoles ()
	Get the output (DC side) poles.
Controller	getController ()
	Get the controller for this power supply.
Public Member Functions inherited from pdumodel::EDevice
vector< EDevice >	getParents ()
	Get the list of devices that provide energy to this device.
vector< EDevice >	getChildren ()
	Get the list of devices that are directly fed by this device.
Waveform	getWaveform ()
	Get the current voltage and current waveforms for this device.
Waveform	getPoleWaveform (in PowerLine line)
	Get the current voltage and current waveforms for a pole of this device.

Public Attributes
constant int	ERR_OPERATION_NOT_SUPPORTED = 1
constant int	ERR_INVALID_ARGUMENT = 2
constant int	FAULT_STATE_NO_FAULT = 0
	No fault is present.
constant int	FAULT_STATE_WARNING = 1
	Warning indicator active.
constant int	FAULT_STATE_CRITICAL = 2
	Critical indicator active.

Detailed Description

Shelf power supply interface.

Definition at line 20 of file ShelfPowerSupply.idl.

Member Enumeration Documentation

PowerState

enum pdumodel::ShelfPowerSupply::PowerState

Power supply power state.

Used both for switching and representing the current state

Enumerator
PS_OFF	Turn off / Power is off.
PS_ON	Turn on / Power is on.

Definition at line 43 of file ShelfPowerSupply.idl.

Member Function Documentation

clearFaults()

void pdumodel::ShelfPowerSupply::clearFaults

(

)

Clear any PSU internal fault states.

This includes input and output related faults as well as temperature and fan faults.

getController()

Controller pdumodel::ShelfPowerSupply::getController

(

)

Get the controller for this power supply.

Returns

Sub controller reference

getInputPoles()

vector< Pole > pdumodel::ShelfPowerSupply::getInputPoles

(

)

Get the input (AC side) poles.

Returns

List of poles

getInputSensors()

InputSensors pdumodel::ShelfPowerSupply::getInputSensors

(

)

Get the input (AC side) sensors.

Returns

sensors

getMetaData()

MetaData pdumodel::ShelfPowerSupply::getMetaData

(

)

Retrieve the power supply metadata.

Returns

Metadata

getOutputPoles()

vector< Pole > pdumodel::ShelfPowerSupply::getOutputPoles

(

)

Get the output (DC side) poles.

Returns

List of poles

getOutputSensors()

OutputSensors pdumodel::ShelfPowerSupply::getOutputSensors

(

)

Get the output (DC side) sensors.

Returns

sensors

getPowerSupplySensors()

PowerSupplySensors pdumodel::ShelfPowerSupply::getPowerSupplySensors

(

)

Get the auxiliary sensors.

Returns

sensors

getState()

State pdumodel::ShelfPowerSupply::getState

(

)

Get current PSU state.

Returns

Current state

setFanSpeedOverride()

int pdumodel::ShelfPowerSupply::setFanSpeedOverride	(	in boolean	enableOverride,
		in int	fanSpeedPercent )

Set PSU fan speed override.

Parameters

enableOverride	true if fan speed should be overridden; false to operate fan in automatic mode
fanSpeedPercent	New fan speed target in %

Returns

0 if OK

1 if fan speed control is not supported

2 if the supplied target is out of range (1..100%)

setPowerState()

int pdumodel::ShelfPowerSupply::setPowerState

(

in PowerState

pstate

)

Turn PSU on or off.

Parameters

pstate

New power state

Returns

0 if OK

1 if the PSU does not support power control

Member Data Documentation

ERR_INVALID_ARGUMENT

constant int pdumodel::ShelfPowerSupply::ERR_INVALID_ARGUMENT = 2

Definition at line 23 of file ShelfPowerSupply.idl.

ERR_OPERATION_NOT_SUPPORTED

constant int pdumodel::ShelfPowerSupply::ERR_OPERATION_NOT_SUPPORTED = 1

Definition at line 22 of file ShelfPowerSupply.idl.

FAULT_STATE_CRITICAL

constant int pdumodel::ShelfPowerSupply::FAULT_STATE_CRITICAL = 2

Critical indicator active.

Definition at line 60 of file ShelfPowerSupply.idl.

FAULT_STATE_NO_FAULT

constant int pdumodel::ShelfPowerSupply::FAULT_STATE_NO_FAULT = 0

No fault is present.

Definition at line 58 of file ShelfPowerSupply.idl.

FAULT_STATE_WARNING

constant int pdumodel::ShelfPowerSupply::FAULT_STATE_WARNING = 1

Warning indicator active.

Definition at line 59 of file ShelfPowerSupply.idl.

---

The documentation for this interface was generated from the following file:

• ShelfPowerSupply.idl