PsTaoLamp Class Reference

#include <PsTaoLamp.h>

Inheritance diagram for PsTaoLamp:

Collaboration diagram for PsTaoLamp:

Public Types
enum	IndicatorMode {   MODE_OFF = 0x00, MODE_STEADY = 0x01, MODE_FLASH = 0x02, MODE_FLUTTER = 0x04,   MODE_BROKENFLUTTER = 0x08, MODE_WINK = 0x10 }
Public Types inherited from PsTaoComponent
enum	PsComponentType {   BUTTON, DISPLAY, GRAPHIC_DISPLAY, HOOKSWITCH,   LAMP, MICROPHONE, RINGER, SPEAKER,   EXTERNAL_SPEAKER }

Public Member Functions
OsStatus	setMode (int mode)
	enumcode: MODE_OFF - The indicator mode is off enumcode: MODE_STEADY - The indicator mode is continuously on enumcode: MODE_FLASH - The indicator mode is slow on and off enumcode: MODE_FLUTTER - The indicator mode is fast on and off enumcode: MODE_BROKENFLUTTER - The indicator is the superposition of flash and flutter enumcode: MODE_WINK - The indicator mode is wink More...
OsStatus	getAssociatedPhoneButton (PsTaoButton *&rpButton)
	retcode: OS_SUCCESS - Success retcode: OS_INVALID_ARGUMENT - The requested mode is not supported by this indicator retcode: OS_PROVIDER_UNAVAILABLE - The provider is not available More...
OsStatus	getMode (int &rMode)
	param: (out) rpButton - The pointer to the associated button object retcode: OS_SUCCESS - Success retcode: OS_PROVIDER_UNAVAILABLE - The provider is not available More...
OsStatus	getSupportedModes (int &rModeMask)
	retcode: OS_SUCCESS - Success retcode: OS_PROVIDER_UNAVAILABLE - The provider is not available More...
Public Member Functions inherited from PsTaoComponent
void	getName (UtlString &rName)
int	getType (void)

Protected Member Functions
	PsTaoLamp (const UtlString &rComponentName, int componentType)
	PsTaoLamp ()
virtual	~PsTaoLamp ()
Protected Member Functions inherited from PsTaoComponent
	PsTaoComponent (const UtlString &rComponentName, int componentType)
	PsTaoComponent ()
virtual	~PsTaoComponent ()
OsMutex *	getMutex (void)

Private Member Functions
	PsTaoLamp (const PsTaoLamp &rPsTaoLamp)
PsTaoLamp &	operator= (const PsTaoLamp &rhs)

Friends
class	PsPhoneTask

Additional Inherited Members
Protected Attributes inherited from PsTaoComponent
OsMutex	mMutex
UtlString	mName
int	mType

Member Enumeration Documentation

enum IndicatorMode

Enumerator
MODE_OFF
MODE_STEADY
MODE_FLASH
MODE_FLUTTER
MODE_BROKENFLUTTER
MODE_WINK

Constructor & Destructor Documentation

PsTaoLamp ( const UtlString &  rComponentName, int  componentType  )

protected

PsTaoLamp ( )

protected

~PsTaoLamp ( )

protectedvirtual

PsTaoLamp ( const PsTaoLamp &  rPsTaoLamp )

private

Member Function Documentation

OsStatus getAssociatedPhoneButton

(

PsTaoButton *&

rpButton

)

retcode: OS_SUCCESS - Success retcode: OS_INVALID_ARGUMENT - The requested mode is not supported by this indicator retcode: OS_PROVIDER_UNAVAILABLE - The provider is not available

OsStatus getMode

(

int &

rMode

)

param: (out) rpButton - The pointer to the associated button object retcode: OS_SUCCESS - Success retcode: OS_PROVIDER_UNAVAILABLE - The provider is not available

OsStatus getSupportedModes

(

int &

rModeMask

)

retcode: OS_SUCCESS - Success retcode: OS_PROVIDER_UNAVAILABLE - The provider is not available

PsTaoLamp & operator= ( const PsTaoLamp &  rhs )

private

OsStatus setMode

(

int

mode

)

enumcode: MODE_OFF - The indicator mode is off enumcode: MODE_STEADY - The indicator mode is continuously on enumcode: MODE_FLASH - The indicator mode is slow on and off enumcode: MODE_FLUTTER - The indicator mode is fast on and off enumcode: MODE_BROKENFLUTTER - The indicator is the superposition of flash and flutter enumcode: MODE_WINK - The indicator mode is wink

Friends And Related Function Documentation

friend class PsPhoneTask

friend