PsTaoRinger Class Reference

#include <PsTaoRinger.h>

Inheritance diagram for PsTaoRinger:

Collaboration diagram for PsTaoRinger:

Public Types
enum	RingerLevel { OFF = 0, MIDDLE = 5, FULL = 10 }
Public Types inherited from PsTaoComponent
enum	PsComponentType {   BUTTON, DISPLAY, GRAPHIC_DISPLAY, HOOKSWITCH,   LAMP, MICROPHONE, RINGER, SPEAKER,   EXTERNAL_SPEAKER }

Public Member Functions
OsStatus	setRingerInfo (int patternIndex, char *info)
	enumcode: OFF - The ringer is turned off enumcode: MIDDLE - The ringer volume is set to the middle of its range enumcode: FULL - The ringer volume is set to its maximum level More...
OsStatus	setRingerPattern (int patternIndex)
	param: patternIndex - Identifies the pattern whose info string will be modified. param: info - The text string to associate with the specified ringer pattern. retcode: OS_SUCCESS - Success retcode: OS_INVALID_ARGUMENT - Invalid pattern index retcode: OS_PROVIDER_UNAVAILABLE - The provider is not available More...
OsStatus	setRingerVolume (int volume)
	retcode: OS_SUCCESS - Success retcode: OS_INVALID_ARGUMENT - Invalid pattern index retcode: OS_PROVIDER_UNAVAILABLE - The provider is not available More...
OsStatus	getMaxRingPatternIndex (int &rMaxIndex)
	param: volume - The ringer volume level retcode: OS_SUCCESS - Success retcode: OS_INVALID_ARGUMENT - Invalid volume level retcode: OS_PROVIDER_UNAVAILABLE - The provider is not available More...
OsStatus	getNumberOfRings (int &rNumRingCycles)
	retcode: OS_SUCCESS - Success retcode: OS_PROVIDER_UNAVAILABLE - The provider is not available More...
OsStatus	getRingerInfo (int patternIndex, char *&rpInfo)
	retcode: OS_SUCCESS - Success retcode: OS_PROVIDER_UNAVAILABLE - The provider is not available More...
OsStatus	getRingerPattern (int &rPatternIndex)
	param: patternIndex - identifies the pattern whose info string will be modified. param: rpInfo - set to point to the text string associated with the specified ringer pattern. retcode: OS_SUCCESS - Success retcode: OS_INVALID_ARGUMENT - Invalid pattern index retcode: OS_PROVIDER_UNAVAILABLE - The provider is not available More...
OsStatus	getRingerVolume (int &rVolume)
	retcode: OS_SUCCESS - Success retcode: OS_PROVIDER_UNAVAILABLE - The provider is not available More...
OsStatus	isRingerOn (UtlBoolean &rIsOn)
	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
	PsTaoRinger (const UtlString &rComponentName, int componentType)
	param: (out) rIsOn - TRUE ==> ringer is ON, FALSE ==> ringer is OFF retcode: OS_SUCCESS - Success retcode: OS_PROVIDER_UNAVAILABLE - The provider is not available More...
	PsTaoRinger ()
virtual	~PsTaoRinger ()
Protected Member Functions inherited from PsTaoComponent
	PsTaoComponent (const UtlString &rComponentName, int componentType)
	PsTaoComponent ()
virtual	~PsTaoComponent ()
OsMutex *	getMutex (void)

Private Member Functions
	PsTaoRinger (const PsTaoRinger &rPsTaoRinger)
PsTaoRinger &	operator= (const PsTaoRinger &rhs)

Private Attributes
int	mVolume
bool	mIsRingerOn

Friends
class	PsPhoneTask

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

Member Enumeration Documentation

enum RingerLevel

Enumerator
OFF
MIDDLE
FULL

Constructor & Destructor Documentation

PsTaoRinger ( const UtlString &  rComponentName, int  componentType  )

protected

param: (out) rIsOn - TRUE ==> ringer is ON, FALSE ==> ringer is OFF retcode: OS_SUCCESS - Success retcode: OS_PROVIDER_UNAVAILABLE - The provider is not available

PsTaoRinger ( )

protected

~PsTaoRinger ( )

protectedvirtual

PsTaoRinger ( const PsTaoRinger &  rPsTaoRinger )

private

Member Function Documentation

OsStatus getMaxRingPatternIndex

(

int &

rMaxIndex

)

param: volume - The ringer volume level retcode: OS_SUCCESS - Success retcode: OS_INVALID_ARGUMENT - Invalid volume level retcode: OS_PROVIDER_UNAVAILABLE - The provider is not available

OsStatus getNumberOfRings

(

int &

rNumRingCycles

)

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

OsStatus getRingerInfo	(	int	patternIndex,
		char *&	rpInfo
	)

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

OsStatus getRingerPattern

(

int &

rPatternIndex

)

param: patternIndex - identifies the pattern whose info string will be modified. param: rpInfo - set to point to the text string associated with the specified ringer pattern. retcode: OS_SUCCESS - Success retcode: OS_INVALID_ARGUMENT - Invalid pattern index retcode: OS_PROVIDER_UNAVAILABLE - The provider is not available

OsStatus getRingerVolume

(

int &

rVolume

)

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

OsStatus isRingerOn

(

UtlBoolean &

rIsOn

)

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

PsTaoRinger & operator= ( const PsTaoRinger &  rhs )

private

OsStatus setRingerInfo	(	int	patternIndex,
		char *	info
	)

enumcode: OFF - The ringer is turned off enumcode: MIDDLE - The ringer volume is set to the middle of its range enumcode: FULL - The ringer volume is set to its maximum level

OsStatus setRingerPattern

(

int

patternIndex

)

param: patternIndex - Identifies the pattern whose info string will be modified. param: info - The text string to associate with the specified ringer pattern. retcode: OS_SUCCESS - Success retcode: OS_INVALID_ARGUMENT - Invalid pattern index retcode: OS_PROVIDER_UNAVAILABLE - The provider is not available

OsStatus setRingerVolume

(

int

volume

)

retcode: OS_SUCCESS - Success retcode: OS_INVALID_ARGUMENT - Invalid pattern index retcode: OS_PROVIDER_UNAVAILABLE - The provider is not available

Friends And Related Function Documentation

friend class PsPhoneTask

friend

Member Data Documentation

bool mIsRingerOn

private

int mVolume

private