/home/mhx/git/github/libmoost/include/moost/progress/policy/skeleton.hpp

Go to the documentation of this file.

/* vim:set ts=3 sw=3 sts=3 et: */
#ifndef MOOST_UTILS_PROGRESS_POLICY_SKELETON_HPP__
#define MOOST_UTILS_PROGRESS_POLICY_SKELETON_HPP__

#include <ostream>


namespace moost { namespace progress { namespace policy {


   template<typename CounterType = size_t>
   class skeleton // this is an example policy -- it does absolutely nothing of any use :)
   {
   public:
      typedef CounterType counter_type;

      skeleton(std::ostream & out = std::cout)
         : counter_(0), out_(out)
      {
      }

      counter_type  operator+=(counter_type const incr)
      {
         animate();
         return counter_ += incr;
      }

      counter_type operator ++ ()
      {
         return *this += 1;
      }

      counter_type operator ++ (int)
      {
         counter_type const tmp = counter_;
         ++*this; // call += to ensure any thing it does (such as animate) is applied
         return tmp;
      }

      counter_type count() const
      {
         return counter_;
      }

      counter_type expected_count() const
      {
         return counter_;
      }

   private:
      void animate()
      {
         // TODO: Your progess display animation goes here, which should take into account that incr
         //        could be > 1 so you need to ensure you display an appropriate number of 'frames'.

      }

   private:
      counter_type counter_;
      std::ostream & out_;
   };

}}}

#endif // MOOST_UTILS_PROGRESS_POLICY_SKELETON_HPP__