1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
//
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp. All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$
///////////////////////////////////////////////////////////////////////////////
#ifndef _PtComponent_h_
#define _PtComponent_h_
// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "PtDefs.h"
// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
//:The PtComponent class is the base class for all individual components used
//:to model telephone hardware. Each distinct component type is derived from
//:this class.
class PtComponent
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:
enum ComponentType
{
BUTTON,
DISPLAY,
GRAPHIC_DISPLAY,
HOOKSWITCH,
LAMP,
MICROPHONE,
RINGER,
SPEAKER,
TEXT_DISPLAY,
EXTERNAL_SPEAKER,
UNKNOWN
};
/* ============================ CREATORS ================================== */
PtComponent();
PtComponent(const PtComponent& rPtComponent);
//:Copy constructor (not implemented for this class)
PtComponent& operator=(const PtComponent& rhs);
//:Assignment operator (not implemented for this class)
PtComponent(int componentType);
//:Constructor
//!param: componentType - The type of telephone hardware modeled by this component
PtComponent(const char*& rName);
//:Constructor
//!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
virtual
~PtComponent();
//:Destructor
/* ============================ MANIPULATORS ============================== */
void setGroupType(int groupType);
/* ============================ ACCESSORS ================================= */
virtual PtStatus getName(char* rpName, int maxLen);
//:Returns the name associated with this component.
//!param: (out) rpName - The reference used to return the name
//!retcode: PT_SUCCESS - Success
//!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
virtual PtStatus getType(int& rType);
//:Returns the type associated with this component.
//!param: (out) rType - The reference used to return the component type
//!retcode: PT_SUCCESS - Success
//!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
/* ============================ INQUIRY =================================== */
friend class PtTerminal;
friend class PtPhoneTerminal;
friend class PtComponentGroup;
/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:
int mType;
char mpName[21];
public:
int mGroupType;
/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
};
/* ============================ INLINE METHODS ============================ */
#endif // _PtComponent_h_
|
