Progress.h

Go to the documentation of this file.

#pragma once
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------

//----- Included files ---------------------------------------------------------

#include <xmscore/misc/boost_defines.h>

//----- Forward declarations ---------------------------------------------------

//----- Namespace declaration --------------------------------------------------

//----- Constants / Enumerations -----------------------------------------------

//----- Structs / Classes ------------------------------------------------------
namespace xms
{
class Progress
{
public:
  Progress(const std::string& a_message);
  ~Progress();

  void UpdateMessage(const std::string& a_message);

  void SetItemCount(long long a_count);
  void CurrentItem(long long a_item);

  void ProgressStatus(double a_percentComplete);

private:
  int m_stackIndex;      
  long long m_itemCount; 
};

class ProgressListener
{
public:
  virtual ~ProgressListener();

  virtual void OnProgressStatus(int a_stackIndex, double a_fractionComplete) = 0;

  virtual int OnBeginOperationString(const std::string& a_operation) = 0;

  virtual void OnEndOperation(int a_stackIndex) = 0;

  virtual void OnUpdateMessage(int a_stackIndex, const std::string& a_message) = 0;

  static void SetListener(BSHP<ProgressListener> a_listener);
  static BSHP<ProgressListener> GetListener();
};

} // namespace xms

//----- Function prototypes ----------------------------------------------------