sipxmedialib  Version 3.3
MprnProgressMsg.h
Go to the documentation of this file.
1 //
2 // Copyright (C) 2007 SIPez LLC.
3 // Licensed to SIPfoundry under a Contributor Agreement.
4 //
5 // Copyright (C) 2007 SIPfoundry Inc.
6 // Licensed by SIPfoundry under the LGPL license.
7 //
8 // $$
10 
11 #ifndef _MprnProgressMsg_h_
12 #define _MprnProgressMsg_h_
13 
14 // SYSTEM INCLUDES
15 
16 // APPLICATION INCLUDES
17 #include "os/OsMsg.h"
18 #include "utl/UtlString.h"
19 #include "MpResNotificationMsg.h"
20 
21 // DEFINES
22 // MACROS
23 // EXTERNAL FUNCTIONS
24 // EXTERNAL VARIABLES
25 // CONSTANTS
26 // STRUCTS
27 // TYPEDEFS
28 // FORWARD DECLARATIONS
29 
34 {
35  /* //////////////////////////// PUBLIC //////////////////////////////////// */
36 public:
37 
38  /* ============================ CREATORS ================================== */
40 
41 
44  const UtlString& namedResOriginator,
45  unsigned posMS, unsigned totalMS);
46 
48  MprnProgressMsg(const MprnProgressMsg& rMsg);
49 
51  virtual OsMsg* createCopy(void) const;
52 
54  virtual
56 
58 
59  /* ============================ MANIPULATORS ============================== */
61 
62 
65 
67  void setPositionMS(unsigned posMS);
68 
70  void setTotalMS(unsigned totalMS);
71 
73 
74  /* ============================ ACCESSORS ================================= */
76 
77 
79  unsigned getPositionMS(void) const;
80 
82  unsigned getTotalMS(void) const;
83 
85 
86  /* ============================ INQUIRY =================================== */
88 
89 
91 
92  /* //////////////////////////// PROTECTED ///////////////////////////////// */
93 protected:
94 
95  /* //////////////////////////// PRIVATE /////////////////////////////////// */
96 private:
97  unsigned mCurPositionMS;
98  unsigned mTotalMS;
99 };
100 
101 /* ============================ INLINE METHODS ============================ */
102 
103 #endif // _MprnProgressMsg_h_
virtual ~MprnProgressMsg()
Destructor.
Definition: MprnProgressMsg.cpp:54
MprnProgressMsg(MpResNotificationMsg::RNMsgType msgType, const UtlString &namedResOriginator, unsigned posMS, unsigned totalMS)
Constructor.
Definition: MprnProgressMsg.cpp:30
void setPositionMS(unsigned posMS)
Set the position in milliseconds this message reports.
Definition: MprnProgressMsg.cpp:77
Definition: MprnProgressMsg.h:33
virtual OsMsg * createCopy(void) const
Create a copy of this msg object (which may be of a derived type)
Definition: MprnProgressMsg.cpp:48
unsigned getPositionMS(void) const
Get the current reported position of this progress update in MS.
Definition: MprnProgressMsg.cpp:91
MprnProgressMsg & operator=(const MprnProgressMsg &rhs)
Assignment operator.
Definition: MprnProgressMsg.cpp:63
Definition: MpResNotificationMsg.h:31
unsigned getTotalMS(void) const
Get the total size of the buffer in milliseconds this message reports.
Definition: MprnProgressMsg.cpp:97
unsigned mTotalMS
Total size in milliseconds.
Definition: MprnProgressMsg.h:98
RNMsgType
Phone set message types.
Definition: MpResNotificationMsg.h:37
void setTotalMS(unsigned totalMS)
Set the total size of the buffer in milliseconds this message reports.
Definition: MprnProgressMsg.cpp:83
unsigned mCurPositionMS
current position reported, in milliseconds.
Definition: MprnProgressMsg.h:97