#include <PtPhoneRinger.h>
Public Types | |
| enum | RingerLevel { OFF = 0, MIDDLE = 5, FULL = 10 } |
 Public Types inherited from PtComponent | |
| enum | ComponentType { BUTTON, DISPLAY, GRAPHIC_DISPLAY, HOOKSWITCH, LAMP, MICROPHONE, RINGER, SPEAKER, TEXT_DISPLAY, EXTERNAL_SPEAKER, UNKNOWN } |
Public Member Functions | |
| PtPhoneRinger () | |
| 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... | |
| PtPhoneRinger (TaoClientTask *pClient) | |
| PtPhoneRinger (const PtPhoneRinger &rPtPhoneRinger) | |
| PtPhoneRinger & | operator= (const PtPhoneRinger &rhs) |
| virtual | ~PtPhoneRinger () |
| virtual PtStatus | setRingerInfo (int patternIndex, char *info) |
| virtual PtStatus | 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: PT_SUCCESS - Success retcode: PT_INVALID_ARGUMENT - Invalid pattern index retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More... | |
| virtual PtStatus | setRingerVolume (int volume) |
| retcode: PT_SUCCESS - Success retcode: PT_INVALID_ARGUMENT - Invalid pattern index retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More... | |
| virtual PtStatus | getMaxRingPatternIndex (int &rMaxIndex) |
| param: volume - The ringer volume level retcode: PT_SUCCESS - Success retcode: PT_INVALID_ARGUMENT - Invalid volume level retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More... | |
| virtual PtStatus | getNumberOfRings (int &rNumRingCycles) |
| retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More... | |
| virtual PtStatus | getRingerInfo (int patternIndex, char *&rpInfo) |
| retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More... | |
| virtual PtStatus | 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: PT_SUCCESS - Success retcode: PT_INVALID_ARGUMENT - Invalid pattern index retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More... | |
| virtual PtStatus | getRingerVolume (int &rVolume) |
| retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More... | |
| virtual PtStatus | isRingerOn (PtBoolean &rIsOn) |
| 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 Attributes | |
| TaoClientTask * | mpClient |
| param: (out) rIsOn - TRUE ==> ringer is ON, FALSE ==> ringer is OFF retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More... | |
| OsTime | mTimeOut |
| Protected Attributes inherited from PtComponent | |
| int | mType |
| char | mpName [21] |
Private Attributes | |
| OsProtectEventMgr * | mpEventMgr |
Additional Inherited Members | |
| Public Attributes inherited from PtComponent | |
| int | mGroupType |
Member Enumeration Documentation
| enum RingerLevel |
Constructor & Destructor Documentation
| PtPhoneRinger | ( | ) |
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
| PtPhoneRinger | ( | TaoClientTask * | pClient | ) |
| PtPhoneRinger | ( | const PtPhoneRinger & | rPtPhoneRinger | ) |
|
virtual |
Member Function Documentation
|
virtual |
param: volume - The ringer volume level retcode: PT_SUCCESS - Success retcode: PT_INVALID_ARGUMENT - Invalid volume level retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
|
virtual |
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
|
virtual |
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: PT_SUCCESS - Success retcode: PT_INVALID_ARGUMENT - Invalid pattern index retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
|
virtual |
retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
param: (out) rpName - The reference used to return the name retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available param: (out) rType - The reference used to return the component type retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
| PtPhoneRinger & operator= | ( | const PtPhoneRinger & | rhs | ) |
|
virtual |
|
virtual |
param: patternIndex - Identifies the pattern whose info string will be modified. param: info - The text string to associate with the specified ringer pattern. retcode: PT_SUCCESS - Success retcode: PT_INVALID_ARGUMENT - Invalid pattern index retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
|
virtual |
retcode: PT_SUCCESS - Success retcode: PT_INVALID_ARGUMENT - Invalid pattern index retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
Member Data Documentation
|
protected |
param: (out) rIsOn - TRUE ==> ringer is ON, FALSE ==> ringer is OFF retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
|
private |
|
protected |