SimulationStatus.hpp

Go to the documentation of this file.

#ifndef __TVLSIM_BOM_SIMULATIONSTATUS_HPP
#define __TVLSIM_BOM_SIMULATIONSTATUS_HPP

// //////////////////////////////////////////////////////////////////////
// Import section
// //////////////////////////////////////////////////////////////////////
// STL
#include <string>
// Boost Simulation
#include <boost/progress.hpp>
// StdAir
#include <stdair/stdair_date_time_types.hpp>
#include <stdair/basic/StructAbstract.hpp>
// SEvMgr
#include <sevmgr/SEVMGR_Types.hpp>
// TvlSim
#include <tvlsim/basic/SimulationMode.hpp>
#include <tvlsim/bom/SimulationStatusKey.hpp>
#include <tvlsim/TVLSIM_Types.hpp>

namespace TVLSIM {

  struct SimulationStatus : public stdair::StructAbstract {
    
  public:
    // ////////// Type definitions ////////////
    typedef SimulationStatusKey Key_T;
    
  public:
    // //////////////// Getters ///////////////// 
    bool isTheSimulationDone() const;

    const stdair::Date_T& getStartDate() const {
      return _startDate;
    }

    const stdair::Date_T& getCurrentDate() const {
      return _currentDate;
    }
      
    const stdair::Date_T& getEndDate() const {
      return _endDate;
    }    

    const NbOfRuns_T& getCurrentRun() const {
      return _currentRun;
    }  

    const NbOfRuns_T& getTotalNumberOfRuns() const {
      return _totalNumberOfRuns; 
    } 
    
    const SimulationMode& getSimulationMode() const {
      return _simulationMode;
    } 

    SimulationMode::EN_SimulationMode getMode() const {
      return _simulationMode.getMode();
    } 

    const stdair::NbOfBookings_T& getCurrentNumberOfBookings() const {
      return _currentNbOfBookings;
    }  

    const double& getCurrentElapsedTime() const {
      return _currentElapsedTime;
    }    

    const double& getCurrentEstimatedRemainingTime() const {
      return _currentEstimatedRemainingTime;
    }   

    const stdair::ProgressStatus& getCurrentProgressStatus() const {
      return _currentProgressStatus;
    }  

    const SEVMGR::ProgressStatusMap_T& getProgressStatusMap() const {
      return _progressStatusMap;
    }

  public:
    // //////////////// Setters ///////////////// 
    void setSimulationPeriod (const stdair::Date_T& iStartDate,
                              const stdair::Date_T& iEndDate) {
      _startDate = iStartDate; 
      _endDate = iEndDate;
      setCurrentDate (iStartDate);
    } 

    void setCurrentDate (const stdair::Date_T& iCurrentDate) {
      _currentDate = iCurrentDate;
    } 
 
    void updateProgress(const stdair::EventType::EN_EventType&,
                        const stdair::ProgressStatus&,
                        const double& iEventMeasure = 0);

    void reset ();

    void prepareNewRun ();

    void setMode (const SimulationMode::EN_SimulationMode& iEN_SimulationMode) {
      return _simulationMode.setMode(iEN_SimulationMode);
    }
    
    void increaseGlobalNumberOfBookings (const stdair::PartySize_T&);

    void setCurrentProgressStatus (const stdair::ProgressStatus&);
    
    void setTotalNumberOfRuns (const NbOfRuns_T& iNbOfRuns) {
      _totalNumberOfRuns = iNbOfRuns;
    }

  public:
    // /////////// Display support method /////////////
    void toStream (std::ostream& ioOut) const {
      ioOut <<  describe();
    }

    void fromStream (std::istream& ioIn) {
    }

    const std::string describe() const;

    const std::string describeKey() const {
      return _key.toString();
    }

    void displayStartStatusMessage () const; 

    void displayEndStatusMessage () const;

  private:
    void describeHelper(std::string&) const;
    
  public:
    SimulationStatus (const Key_T&);

    SimulationStatus ();

    ~SimulationStatus ();

  private:
    SimulationStatus (const SimulationStatus&);
  
  private:
    // //////////////// Attributes /////////////////
    Key_T _key;

    stdair::Date_T _startDate;   

    stdair::Date_T _currentDate;   
  
    stdair::Date_T _endDate;    

    NbOfRuns_T _totalNumberOfRuns;    

    NbOfRuns_T _currentRun;

    stdair::NbOfBookings_T _currentNbOfBookings;  

    stdair::NbOfBookings_T _totalNbOfBookings;

    stdair::ProgressStatus _overallProgressStatus;
  
    stdair::ProgressStatus _currentProgressStatus;

    SEVMGR::ProgressStatusMap_T _progressStatusMap;

    double _totalElapsedTime;  
    double _estimatedRemainingTime; 

    double _currentElapsedTime;  
    double _currentEstimatedRemainingTime; 

    ChronometerMap_T _chronometerMap;
    
    SimulationMode _simulationMode;
  };

}
#endif // __TVLSIM_BOM_SIMULATIONSTATUS_HPP