MiProgressNotf.h

Go to the documentation of this file.

//  
// Copyright (C) 2007 SIPez LLC. 
// Licensed to SIPfoundry under a Contributor Agreement. 
//
// Copyright (C) 2007 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// $$

// Author: Keith Kyzivat <kkyzivat AT SIPez DOT com>

#ifndef _MiProgressNotf_h_
#define _MiProgressNotf_h_

// SYSTEM INCLUDES

// APPLICATION INCLUDES
#include "os/OsMsg.h"
#include "utl/UtlString.h"
#include "mi/MiNotification.h"

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS

class MiProgressNotf : public MiNotification
{
   /* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

   /* ============================ CREATORS ================================== */


   MiProgressNotf(const UtlString& sourceId, 
                  unsigned posMS, unsigned totalMS);

   MiProgressNotf(const MiProgressNotf& rNotf);

   virtual OsMsg* createCopy(void) const;

   virtual ~MiProgressNotf();


   /* ============================ MANIPULATORS ============================== */


   MiProgressNotf& operator=(const MiProgressNotf& rhs);

   void setPositionMS(unsigned posMS);

   void setTotalMS(unsigned totalMS);


   /* ============================ ACCESSORS ================================= */


   unsigned getPositionMS(void) const;

   unsigned getTotalMS(void) const;


   /* ============================ INQUIRY =================================== */



   /* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:

   /* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
   unsigned mCurPositionMS; 
   unsigned mTotalMS; 
};

/* ============================ INLINE METHODS ============================ */

#endif  // _MiProgressNotf_h_