EventQueue.hpp

Go to the documentation of this file.

#ifndef __SEVMGR_BOM_EVENTQUEUE_HPP
#define __SEVMGR_BOM_EVENTQUEUE_HPP

// //////////////////////////////////////////////////////////////////////
// Import section
// //////////////////////////////////////////////////////////////////////
// STL
#include <iosfwd>
#include <string>
// StdAir
#include <stdair/stdair_basic_types.hpp>
#include <stdair/stdair_date_time_types.hpp>
#include <stdair/basic/ProgressStatusSet.hpp>
#include <stdair/basic/EventType.hpp>
#include <stdair/bom/BomAbstract.hpp>
#include <stdair/bom/EventTypes.hpp>
// SEvMgr
#include <sevmgr/bom/EventQueueKey.hpp>
#include <sevmgr/bom/EventQueueTypes.hpp>
#include <sevmgr/SEVMGR_Types.hpp>

namespace stdair {
  class FacBomManager;
  template <typename BOM> class FacBom;
}

namespace SEVMGR {

  class EventQueue : public stdair::BomAbstract {
    template <typename BOM> friend class stdair::FacBom;
    friend class stdair::FacBomManager;

  public:
    // ////////// Type definitions ////////////
    typedef EventQueueKey Key_T;
    

  public:
    // /////////// Getters ///////////////
    const Key_T& getKey () const {
      return _key;
    }

    BomAbstract* const getParent () const {
      return _parent;
    } 

    const stdair::EventList_T& getEventList () const {
      return _eventList;
    }
    
    const stdair::HolderMap_T& getHolderMap () const {
      return _holderMap;
    }
    
    const stdair::ProgressStatus& getStatus () const {
      return _progressStatus;
    }
    const stdair::Count_T& getCurrentNbOfEvents () const {
      return _progressStatus.getCurrentNb();
    }
    const stdair::Count_T& getExpectedTotalNbOfEvents () const {
      return _progressStatus.getExpectedNb();
    }
    const stdair::Count_T& getActualTotalNbOfEvents () const {
      return _progressStatus.getActualNb();
    }

    const stdair::ProgressStatus& getStatus (const stdair::EventType::EN_EventType&) const;

    const stdair::Count_T& getCurrentNbOfEvents (const stdair::EventType::EN_EventType&) const;

    const stdair::Count_T& getExpectedTotalNbOfEvents (const stdair::EventType::EN_EventType&) const;

    const stdair::Count_T& getActualTotalNbOfEvents (const stdair::EventType::EN_EventType&) const;  

    bool hasProgressStatus (const stdair::EventType::EN_EventType&) const;

  public:
    // /////////// Setters ///////////////
    void setStatus (const stdair::ProgressStatus& iProgressStatus) {
      _progressStatus = iProgressStatus;
    }
    void setStatus (const stdair::Count_T& iCurrentNbOfEvents,
                    const stdair::Count_T& iExpectedTotalNbOfEvents,
                    const stdair::Count_T& iActualTotalNbOfEvents) {
      _progressStatus.setCurrentNb (iCurrentNbOfEvents);
      _progressStatus.setExpectedNb (iExpectedTotalNbOfEvents);
      _progressStatus.setActualNb (iActualTotalNbOfEvents);
    }
    void setStatus (const stdair::Count_T& iCurrentNbOfEvents,
                    const stdair::Count_T& iActualTotalNbOfEvents) {
      _progressStatus.setCurrentNb (iCurrentNbOfEvents);
      _progressStatus.setActualNb (iActualTotalNbOfEvents);
    }
    void setCurrentNbOfEvents (const stdair::Count_T& iCurrentNbOfEvents) {
      _progressStatus.setCurrentNb (iCurrentNbOfEvents);
    }
    void setExpectedTotalNbOfEvents (const stdair::Count_T& iExpectedTotalNbOfEvents) {
      _progressStatus.setExpectedNb (iExpectedTotalNbOfEvents);
    }

    void setStatus (const stdair::EventType::EN_EventType& iType,
                    const stdair::ProgressStatus& iProgressStatus);


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

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

    std::string toString () const; 

    std::string list () const;
 
    std::string list (const stdair::EventType::EN_EventType&) const;
    
    const std::string describeKey () const {
      return _key.toString();
    }
    
    /*
     * Display the full content of the event queue, with all its
     * event structure.
     *
     * That method can be very consuming (in time, CPU and memory)
     * when there are a lot of event structures (e.g., several hundreds
     * of thousands). Call it only for debug purposes.
    */
    std::string display () const;
    
    
  public:
    // ////////// Business methods /////////
    void reset ();
    
     stdair::ProgressStatusSet popEvent (stdair::EventStruct&);

    bool addEvent (stdair::EventStruct&);

    bool hasEventDateTime (const stdair::DateTime_T&);

    bool isQueueDone () const;

    void addStatus (const stdair::EventType::EN_EventType&,
                    const stdair::NbOfRequests_T& iExpectedTotalNbOfEvents);

    void updateStatus (const stdair::EventType::EN_EventType&,
                       const stdair::ProgressStatus& iProgressStatus);

    void updateStatus (const stdair::EventType::EN_EventType&,
                       const stdair::NbOfEvents_T& iActualTotalNbOfEvents);

    stdair::ProgressPercentage_T calculateProgress () const {
      return _progressStatus.progress();
    }

    stdair::ProgressPercentage_T calculateProgress (const stdair::EventType::EN_EventType&)const;


  public:
    // ////////// Debug methods /////////
    stdair::Count_T getQueueSize () const;

    bool isQueueEmpty () const;

    
  protected:
    // ////////// Constructors and destructors /////////
    EventQueue (const Key_T&);
    EventQueue (const EventQueue&);
    ~EventQueue ();
  private:
    EventQueue ();
    

  protected:
    // ////////// Attributes /////////
    Key_T _key;

    BomAbstract* _parent;

    stdair::HolderMap_T _holderMap;

    stdair::EventList_T _eventList;
    
    stdair::ProgressStatus _progressStatus;

    ProgressStatusMap_T _progressStatusMap;
  };

}
#endif // __SEVMGR_BOM_EVENTQUEUE_HPP