#include <PtPhoneLamp.h>
Inheritance diagram for PtPhoneLamp:
Collaboration diagram for PtPhoneLamp:
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 PtComponent | |
| enum | ComponentType { BUTTON, DISPLAY, GRAPHIC_DISPLAY, HOOKSWITCH, LAMP, MICROPHONE, RINGER, SPEAKER, TEXT_DISPLAY, EXTERNAL_SPEAKER, UNKNOWN } |
Public Member Functions | |
| PtPhoneLamp (const PtPhoneLamp &rPtPhoneLamp) | |
| 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... | |
| PtPhoneLamp (TaoClientTask *pClient) | |
| PtPhoneLamp & | operator= (const PtPhoneLamp &rhs) |
| PtPhoneLamp () | |
| virtual | ~PtPhoneLamp () |
| virtual PtStatus | setMode (int mode) |
| virtual PtStatus | getAssociatedPhoneButton (PtPhoneButton &rButton) |
| retcode: PT_SUCCESS - Success retcode: PT_INVALID_ARGUMENT - The requested mode is not supported by this indicator retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More... | |
| virtual PtStatus | getMode (int &rMode) |
| param: (out) rpButton - The pointer to the associated button object retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More... | |
| virtual PtStatus | getSupportedModes (int &rModeMask) |
| retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More... | |
| Public Member Functions inherited from PtComponent | |
| PtComponent () | |
| PtComponent (const PtComponent &rPtComponent) | |
| PtComponent & | operator= (const PtComponent &rhs) |
| PtComponent (int componentType) | |
| PtComponent (const char *&rName) | |
| param: componentType - The type of telephone hardware modeled by this component More... | |
| virtual | ~PtComponent () |
| param: rName - The name of telephone hardware modeled by this component name: button name: hookswitch name: display name: graphic_display name: text_display name: lamp name: microphone name: ringer name: speaker name: unknown More... | |
| void | setGroupType (int groupType) |
| virtual PtStatus | getName (char *rpName, int maxLen) |
| virtual PtStatus | getType (int &rType) |
| param: (out) rpName - The reference used to return the name retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More... | |
Protected Member Functions | |
| void | setAssociatedButton (PtPhoneButton *pButton) |
Protected Attributes | |
| TaoClientTask * | mpClient |
| OsTime | mTimeOut |
| int | mMode |
| int | mSupportedModes |
| int | mType |
| PtPhoneButton * | mpAssociatedButton |
| Protected Attributes inherited from PtComponent | |
| int | mType |
| char | mpName [21] |
Private Attributes | |
| OsProtectEventMgr * | mpEventMgr |
Friends | |
| class | PtPhoneButton |
Additional Inherited Members | |
| Public Attributes inherited from PtComponent | |
| int | mGroupType |
Member Enumeration Documentation
| enum IndicatorMode |
Constructor & Destructor Documentation
| PtPhoneLamp | ( | const PtPhoneLamp & | rPtPhoneLamp | ) |
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
| PtPhoneLamp | ( | TaoClientTask * | pClient | ) |
| PtPhoneLamp | ( | ) |
|
virtual |
Member Function Documentation
|
virtual |
retcode: PT_SUCCESS - Success retcode: PT_INVALID_ARGUMENT - The requested mode is not supported by this indicator retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
|
virtual |
param: (out) rpButton - The pointer to the associated button object retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
|
virtual |
retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
| PtPhoneLamp & operator= | ( | const PtPhoneLamp & | rhs | ) |
|
protected |
|
virtual |
Friends And Related Function Documentation
|
friend |
Member Data Documentation
|
protected |
|
protected |
|
protected |
|
private |
|
protected |
|
protected |
|
protected |