Outlet group interface. More...

import"OutletGroup.idl";

Classes
struct	MetaData
	Outlet group metadata. More...

struct	Sensors
	Outlet group sensors. More...

struct	Settings
	Outlet group settings. More...

Public Member Functions
Sensors	getSensors ()
	Retrieve the outlet group sensors. More...

MetaData	getMetaData ()
	Retrieve the outlet group metadata. More...

Settings	getSettings ()
	Retrieve the outlet group settings. More...

int	setSettings (in Settings settings)
	Change the outlet group settings. More...

int	setAllOutletPowerStates (in Outlet::PowerState pstate)
	Switch all member outlets. More...

int	cycleAllOutletPowerStates ()
	Power-cycle all member outlets. More...

Public Attributes
constant int	ERR_INVALID_ARGUMENT = 1

valueobject	SensorsChangedEvent: idl::Event { Sensors oldSensors
	Event: Group sensors have changed. More...

Sensors	newSensors
	Sensors after change.

valueobject	SettingsChangedEvent: event::UserEvent { Settings oldSettings
	Event: Group settings have been changed. More...

Settings	newSettings
	Settings after change.

valueobject	PowerControlEvent: event::UserEvent { Outlet::PowerState state
	Event: Group switch operation has been invoked. More...

boolean	cycle
	Whether a power cycle operation was invoked.

Detailed Description

Outlet group interface.

Member Function Documentation

◆ cycleAllOutletPowerStates()

int pdumodel::OutletGroup::cycleAllOutletPowerStates ( )

Power-cycle all member outlets.

Returns: 0 if OK

◆ getMetaData()

MetaData pdumodel::OutletGroup::getMetaData ( )

Retrieve the outlet group metadata.

Returns: outlet group metadata

◆ getSensors()

Sensors pdumodel::OutletGroup::getSensors ( )

Retrieve the outlet group sensors.

Returns: outlet group sensors

◆ getSettings()

Settings pdumodel::OutletGroup::getSettings ( )

Retrieve the outlet group settings.

Returns: outlet group settings

◆ setAllOutletPowerStates()

int pdumodel::OutletGroup::setAllOutletPowerStates ( in Outlet::PowerState pstate )

Switch all member outlets.

Parameters

pstate New power state for all outlets

Returns: 0 if OK

◆ setSettings()

int pdumodel::OutletGroup::setSettings ( in Settings settings )

Change the outlet group settings.

Parameters

settings New outlet group settings

Returns: 0 if OK; 1 if any parameters are invalid

Member Data Documentation

◆ PowerControlEvent

valueobject pdumodel::OutletGroup::PowerControlEvent

Event: Group switch operation has been invoked.

Target power state, only valid if not cycling

◆ SensorsChangedEvent

valueobject pdumodel::OutletGroup::SensorsChangedEvent

Event: Group sensors have changed.

Sensors before change

◆ SettingsChangedEvent

valueobject pdumodel::OutletGroup::SettingsChangedEvent

Event: Group settings have been changed.

Settings before change

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

OutletGroup.idl

Classes

Public Member Functions

Public Attributes