sipXcallLib home page


Public Types | Public Member Functions | Public Attributes | Protected Attributes | Friends | List of all members
PtComponent Class Reference

#include <PtComponent.h>

Inheritance diagram for PtComponent:
Inheritance graph
[legend]

Public Types

enum  ComponentType {
  BUTTON, DISPLAY, GRAPHIC_DISPLAY, HOOKSWITCH,
  LAMP, MICROPHONE, RINGER, SPEAKER,
  TEXT_DISPLAY, EXTERNAL_SPEAKER, UNKNOWN
}
 

Public Member Functions

 PtComponent ()
 
 PtComponent (const PtComponent &rPtComponent)
 
PtComponentoperator= (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...
 

Public Attributes

int mGroupType
 

Protected Attributes

int mType
 
char mpName [21]
 

Friends

class PtTerminal
 param: (out) rType - The reference used to return the component type retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 
class PtPhoneTerminal
 
class PtComponentGroup
 

Member Enumeration Documentation

Enumerator
BUTTON 
DISPLAY 
GRAPHIC_DISPLAY 
HOOKSWITCH 
LAMP 
MICROPHONE 
RINGER 
SPEAKER 
TEXT_DISPLAY 
EXTERNAL_SPEAKER 
UNKNOWN 

Constructor & Destructor Documentation

PtComponent ( const PtComponent rPtComponent)
PtComponent ( int  componentType)
PtComponent ( const char *&  rName)

param: componentType - The type of telephone hardware modeled by this component

~PtComponent ( )
virtual

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

Member Function Documentation

PtStatus getName ( char *  rpName,
int  maxLen 
)
virtual
PtStatus getType ( int &  rType)
virtual

param: (out) rpName - The reference used to return the name retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtComponent & operator= ( const PtComponent rhs)
void setGroupType ( int  groupType)

Friends And Related Function Documentation

friend class PtComponentGroup
friend
friend class PtPhoneTerminal
friend
friend class PtTerminal
friend

param: (out) rType - The reference used to return the component type retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

Member Data Documentation

int mGroupType
char mpName[21]
protected
int mType
protected