ProgressStatus.hpp

Go to the documentation of this file.

#ifndef __STDAIR_BAS_PROGRESSSTATUS_HPP
#define __STDAIR_BAS_PROGRESSSTATUS_HPP
 
// //////////////////////////////////////////////////////////////////////
// Import section
// //////////////////////////////////////////////////////////////////////
// STL
#include <string>
// StdAir
#include <stdair/basic/BasConst_Event.hpp>
#include <stdair/stdair_basic_types.hpp>
#include <stdair/basic/StructAbstract.hpp>
#include <stdair/service/Logger.hpp>
 
namespace stdair {

  struct ProgressStatus : public StructAbstract {
  public:
    // //////////////// Getters /////////////////
    const Count_T& count() const {
      return _currentNb;
    }

    const Count_T& getCurrentNb() const {
      return _currentNb;
    }

    const Count_T& getExpectedNb() const {
      return _expectedNb;
    }

    const Count_T& getActualNb() const {
      return _actualNb;
    }

    const ProgressPercentage_T progress() const {
      if (_actualNb == 0) {
        return 0;
      } 
      Percentage_T lPercentage = 
        (static_cast<Percentage_T> (_currentNb)
         / static_cast<Percentage_T> (_actualNb));
      lPercentage *= MAXIMUM_PROGRESS_STATUS;
      return lPercentage;
    }
    
 
    // //////////////// Setters /////////////////
    void setCurrentNb (const Count_T& iCurrentNb) {
      _currentNb = iCurrentNb;
    }

    void setExpectedNb (const Count_T& iExpectedNb) {
      _expectedNb = iExpectedNb;
    } 

    void setActualNb (const Count_T& iActualNb) {
      _actualNb = iActualNb;  
    }

    void reset();

    Count_T operator+= (Count_T iIncrement) {
      _currentNb += iIncrement;
      return _currentNb;
    }

    Count_T operator++() {
      ++_currentNb;
      return _currentNb;
    }
 
 
  public:
    // //////////////// Display Support Methods /////////////////
    const std::string describe() const;   

    const std::string toString() const;
 
    
  public:
    ProgressStatus (const Count_T& iCurrentNb, const Count_T& iExpectedNb,
                    const Count_T& iActualNb);

    ProgressStatus (const Count_T& iExpectedNb, const Count_T& iActualNb);

    ProgressStatus (const Count_T& iActualNb);

    ProgressStatus();

    ProgressStatus (const ProgressStatus&);
    
  private:
    // //////////////// Attributes /////////////////
    Count_T _currentNb;

    Count_T _expectedNb;

    Count_T _actualNb;
  };
 
}
#endif // __STDAIR_BAS_PROGRESSSTATUS_HPP