Policy.hpp

Go to the documentation of this file.

#ifndef __STDAIR_BOM_POLICY_HPP
#define __STDAIR_BOM_POLICY_HPP

// //////////////////////////////////////////////////////////////////////
// Import section
// //////////////////////////////////////////////////////////////////////
// STL
#include <cmath>
// StdAir
#include <stdair/stdair_basic_types.hpp>
#include <stdair/stdair_rm_types.hpp>
#include <stdair/bom/BomAbstract.hpp>
#include <stdair/bom/BookingClassTypes.hpp>
#include <stdair/bom/PolicyKey.hpp>

namespace boost {
  namespace serialization {
    class access;
  }
}

namespace stdair {    

  class Policy : public BomAbstract {
    template <typename BOM> friend class FacBom;
    friend class FacBomManager;
    friend class boost::serialization::access;

  public:
    // ////////// Type definitions ////////////
    typedef PolicyKey Key_T;
      
  public:
    // /////////////////// Getters ////////////////////////
    const Key_T& getKey() const {
      return _key;
    }

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

    const HolderMap_T& getHolderMap() const {
      return _holderMap;
    }

    const BookingClassList_T& getBookingClassList() const;
    
    const NbOfBookings_T& getDemand() const {
      return _demand;
    }
    
    const StdDevValue_T& getStdDev() const {
      return _stdDev;
    }
    
    const Yield_T& getYield() const {
      return _yield;
    }

    const Revenue_T getTotalRevenue () const;
    
  public:
    // ///////////////////// Setters /////////////////////
    void setDemand (const NbOfBookings_T& iDemand) {
      _demand = iDemand;
    }
    
    void setStdDev (const StdDevValue_T& iStdDev) {
      _stdDev = iStdDev;
    }
    
    void setYield (const Yield_T& iYield) {
      _yield = iYield;
    }

    void resetDemandForecast () {
      _demand = 0.0;
      _stdDev = 0.0;
      _yieldDemandMap.clear();
    }

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

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

    std::string toString() const;
    
    const std::string describeKey() const {
      return _key.toString();
    }
    
    
  public:
    // /////////// (Boost) Serialisation support methods /////////
    template<class Archive>
    void serialize (Archive& ar, const unsigned int iFileVersion);

  private:
    void serialisationImplementationExport() const;
    void serialisationImplementationImport();

      
  protected:
    // /////////// Constructors and destructor. ////////////
    Policy (const Key_T&);
      
    virtual ~Policy();

  private:
    Policy();

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

    BomAbstract* _parent;

    HolderMap_T _holderMap;

    NbOfBookings_T _demand;

    StdDevValue_T _stdDev;

    Yield_T _yield;

    YieldDemandMap_T _yieldDemandMap;

  };
}
#endif // __STDAIR_BOM_POLICY_HPP