Description

This interface is a TECHNICAL PREVIEW, it may change.

ToiPowerControl is used for power management.

There are several regulating bodies with respect to power consumption, eg. Energy Star, EU, IEC, and this interface is intended to allow applications to be compliant with each.

import "ToiPowerControl.idl";

Inheritance diagram for ToiPowerControl:

List of all members.

Public Member Functions
void	reportPowerProfile (in TToiPowerProfile profile) raises (TToiInvalidPreconditionException)
void	reportPowerProfileActionsComplete () raises (TToiInvalidPreconditionException)
void	requestPowerProfile (in TToiPowerProfile profile, in TToiPowerProfileChangeReason reason) raises (TToiInvalidArgumentException, TToiPermissionDeniedException, TToiInvalidPreconditionException)
TToiPowerProfile	getCurrentPowerProfile ()
void	setWakeupTimeout (in unsigned long timeSpan) raises (TToiInvalidPreconditionException)
void	releaseInstance ()
Public Attributes
Events
const long	ON_POWER_PROFILE_REQUESTED = 4400
const long	ON_POWER_PROFILE_SELECTED = 4401
const long	ON_AUTO_POWER_DOWN_TIMER_EXPIRED = 4402
TToiPowerProfile
const TToiPowerProfile	PROFILE_ACTIVE = 0
const TToiPowerProfile	PROFILE_ACTIVE_STANDBY = 1
const TToiPowerProfile	PROFILE_ACTIVE_STANDBY_LOW = 2
const TToiPowerProfile	PROFILE_PASSIVE_STANDBY = 3
TToiPowerProfileChangeReason
const TToiPowerProfileChangeReason	REASON_STANDARD = 0
const TToiPowerProfileChangeReason	REASON_AUTO_POWER_DOWN = 1
TToiPowerProfileAccess
const TToiPowerProfileAccess	ACCESS_REPORT_ONLY = 0
const TToiPowerProfileAccess	ACCESS_REPORT_AND_REQUEST = 1
Public Types
typedef long	TToiPowerProfile
typedef long	TToiPowerProfileChangeReason
typedef long	TToiPowerProfileAccess
typedef sequence < ToiPowerControlPowerControllerInfo >	TToiPowerControllerInfoSequence

Member Typedef Documentation

typedef sequence< ToiPowerControlPowerControllerInfo > ToiPowerControl::TToiPowerControllerInfoSequence

A sequence of power controller information.

typedef long ToiPowerControl::TToiPowerProfile

These power profiles are a mix of European Power Code of Conduct, Energy Star and IEC.

typedef long ToiPowerControl::TToiPowerProfileAccess

Power profile control possibility.

typedef long ToiPowerControl::TToiPowerProfileChangeReason

The possible reasons for a device to switch power profile.

Member Function Documentation

TToiPowerProfile ToiPowerControl::getCurrentPowerProfile ( )

Returns the current power profile.

Return values:

profile The current power profile.

void ToiPowerControl::releaseInstance ( )

This method to release a power control instance. Power control instances are created by using ToiPlatformService.

void ToiPowerControl::reportPowerProfile ( in TToiPowerProfile profile ) raises (TToiInvalidPreconditionException)

When a profile switch has been initiated this call is used to report the currently lowest possible power profile.

Parameters:

profile Denotes the lowest power profile currently possible for the responding application/service.

Exceptions:

TToiInvalidPreconditionException Raised if this call is made whithout an ongoing voting procedure.

See also:: ToiPowerControl::onPowerProfileRequested()

void ToiPowerControl::reportPowerProfileActionsComplete ( ) raises (TToiInvalidPreconditionException)

This call is used to acknowledge that the selected power profile can now be executed.

Exceptions:

TToiInvalidPreconditionException Raised if this call is made whithout an ongoing voting procedure.

See also:: ToiPowerControl::onPowerProfileSelected()

void ToiPowerControl::requestPowerProfile	(	in TToiPowerProfile	profile,
		in TToiPowerProfileChangeReason	reason
	)		raises (TToiInvalidArgumentException, TToiPermissionDeniedException, TToiInvalidPreconditionException)

This method is used to request a change in power profile.

Parameters:

profile	Denotes the desired power profile.
reason	Denotes the reason for requesting a power profile switch.

Exceptions:

TToiInvalidArgumentException	Raised if the power profile or reason is incorrect.
TToiPermissionDeniedException	Raised if an application that hasn't registered for power profile request tries to request a new power profile.
TToiInvalidPreconditionException	Raised if this call is made during an ongoing vote.

void ToiPowerControl::setWakeupTimeout ( in unsigned long timeSpan ) raises (TToiInvalidPreconditionException)

An application can use this method to request a wakeup to active standby. If the device is in active when the timer expires nothing happens. This method must be called for each round of voting since the platform won't save values between voting rounds.

Parameters:

timeSpan Seconds until next wakeup.

Exceptions:

TToiInvalidPreconditionException Raised if this call is made whithout an ongoing voting procedure.

Member Data Documentation

const TToiPowerProfileAccess ToiPowerControl::ACCESS_REPORT_AND_REQUEST = 1

The application wants the possibility to initiate power profile switches.

This constant can also be accessed from toi.consts.ToiPowerControl.ACCESS_REPORT_AND_REQUEST.

const TToiPowerProfileAccess ToiPowerControl::ACCESS_REPORT_ONLY = 0

The application does not want to initiate a power profile switch.

This constant can also be accessed from toi.consts.ToiPowerControl.ACCESS_REPORT_ONLY.

const long ToiPowerControl::ON_AUTO_POWER_DOWN_TIMER_EXPIRED = 4402

This is an Event identifier for ToiPowerControlAutoPowerDownTimerExpiredEvent.

This constant can also be accessed from toi.consts.ToiPowerControl.ON_AUTO_POWER_DOWN_TIMER_EXPIRED.

const long ToiPowerControl::ON_POWER_PROFILE_REQUESTED = 4400

This is an Event identifier for ToiPowerControlPowerProfileRequestedEvent.

This constant can also be accessed from toi.consts.ToiPowerControl.ON_POWER_PROFILE_REQUESTED.

const long ToiPowerControl::ON_POWER_PROFILE_SELECTED = 4401

This is an Event identifier for ToiPowerControlPowerProfileSelectedEvent.

This constant can also be accessed from toi.consts.ToiPowerControl.ON_POWER_PROFILE_SELECTED.

const TToiPowerProfile ToiPowerControl::PROFILE_ACTIVE = 0

The device is in active mode.

This constant can also be accessed from toi.consts.ToiPowerControl.PROFILE_ACTIVE.

const TToiPowerProfile ToiPowerControl::PROFILE_ACTIVE_STANDBY = 1

The device is in active mode but all video and audio outputs are disabled.

This constant can also be accessed from toi.consts.ToiPowerControl.PROFILE_ACTIVE_STANDBY.

const TToiPowerProfile ToiPowerControl::PROFILE_ACTIVE_STANDBY_LOW = 2

Customized low power mode. This is intended for devices that can't support passive standby.

This constant can also be accessed from toi.consts.ToiPowerControl.PROFILE_ACTIVE_STANDBY_LOW.

const TToiPowerProfile ToiPowerControl::PROFILE_PASSIVE_STANDBY = 3

Passive standby. Real power saving mode. Sometimes known as energy saving or energy efficient mode.

This constant can also be accessed from toi.consts.ToiPowerControl.PROFILE_PASSIVE_STANDBY.

const TToiPowerProfileChangeReason ToiPowerControl::REASON_AUTO_POWER_DOWN = 1

The auto power down timer has expired.

This constant can also be accessed from toi.consts.ToiPowerControl.REASON_AUTO_POWER_DOWN.

const TToiPowerProfileChangeReason ToiPowerControl::REASON_STANDARD = 0

A reason that isn't specific in any way.

This constant can also be accessed from toi.consts.ToiPowerControl.REASON_STANDARD.

Description

Public Member Functions

Public Attributes

Public Types

Member Typedef Documentation

Member Function Documentation

Member Data Documentation