RMOL_Service.hpp

Go to the documentation of this file.

#ifndef __RMOL_SVC_RMOL_SERVICE_HPP
#define __RMOL_SVC_RMOL_SERVICE_HPP

// //////////////////////////////////////////////////////////////////////
// Import section
// //////////////////////////////////////////////////////////////////////
// STL
#include <string>
// StdAir
#include <stdair/stdair_basic_types.hpp>
#include <stdair/stdair_inventory_types.hpp>
#include <stdair/stdair_service_types.hpp>
#include <stdair/stdair_maths_types.hpp>
#include <stdair/basic/UnconstrainingMethod.hpp>
#include <stdair/basic/ForecastingMethod.hpp>
#include <stdair/basic/PreOptimisationMethod.hpp>
#include <stdair/basic/OptimisationMethod.hpp>
#include <stdair/basic/PartnershipTechnique.hpp>
// RMOL
#include <rmol/RMOL_Types.hpp>

namespace stdair {
  class FlightDate;
  struct BasLogParams;
  struct BasDBParams;
  class BomRoot;
  class AirlineClassList;
  class YieldFeatures;
  class Inventory;
  class OnDDate;
  class SegmentCabin;
}

namespace RMOL {

  class RMOL_ServiceContext;

  class RMOL_Service {
  public:
    // ////////// Constructors and destructors //////////
    RMOL_Service (const stdair::BasLogParams&, const stdair::BasDBParams&);

    RMOL_Service (const stdair::BasLogParams&);

    RMOL_Service (stdair::STDAIR_ServicePtr_T);
        
    void parseAndLoad (const stdair::CabinCapacity_T& iCabinCapacity,
                       const stdair::Filename_T& iDemandAndClassDataFile);

    void setUpStudyStatManager();

    ~RMOL_Service();


  public:
    // /////////////// Business Methods /////////////////
    void buildSampleBom();

    void clonePersistentBom ();

    void buildComplementaryLinks (stdair::BomRoot&); 

    void optimalOptimisationByMCIntegration (const int K);

    void optimalOptimisationByDP();

    void heuristicOptimisationByEmsr();
    
    void heuristicOptimisationByEmsrA();

    void heuristicOptimisationByEmsrB();

    void heuristicOptimisationByMCIntegrationForQFF();

    void heuristicOptimisationByEmsrBForQFF();

    void MRTForNewQFF();

    const stdair::SegmentCabin& 
    retrieveDummySegmentCabin(const bool isForFareFamilies = false);  

    bool optimise (stdair::FlightDate&, const stdair::DateTime_T&,
                   const stdair::UnconstrainingMethod&,
                   const stdair::ForecastingMethod&,
                   const stdair::PreOptimisationMethod&,
                   const stdair::OptimisationMethod&,
                   const stdair::PartnershipTechnique&);

    // O&D based forecast
    void forecastOnD (const stdair::DateTime_T&);

    stdair::YieldFeatures* getYieldFeatures(const stdair::OnDDate&, const stdair::CabinCode_T&,
                                            stdair::BomRoot&);
    
    void forecastOnD (const stdair::YieldFeatures&, stdair::OnDDate&,
                      const stdair::CabinCode_T&, const stdair::DTD_T&, 
                      stdair::BomRoot&);

    void setOnDForecast (const stdair::AirlineClassList&, const stdair::MeanValue_T&,
                         const stdair::StdDevValue_T&, stdair::OnDDate&, const stdair::CabinCode_T&,
                         stdair::BomRoot&);

    // Single segment O&D
    void setOnDForecast (const stdair::AirlineCode_T&, const stdair::Date_T&, const stdair::AirportCode_T&,
                         const stdair::AirportCode_T&, const stdair::CabinCode_T&, const stdair::ClassCode_T&,
                         const stdair::MeanValue_T&, const stdair::StdDevValue_T&, const stdair::Yield_T&, stdair::BomRoot&);

    // Multiple segment O&D
    void setOnDForecast (const stdair::AirlineCodeList_T&, const stdair::AirlineCode_T&,const stdair::Date_T&,
                         const stdair::AirportCode_T&, const stdair::AirportCode_T&, const stdair::CabinCode_T&,
                         const stdair::ClassCodeList_T&, const stdair::MeanValue_T&, const stdair::StdDevValue_T&,
                         const stdair::Yield_T&, stdair::BomRoot&);

    // Initialise (or re-initialise) the demand projections in all leg cabins
    void resetDemandInformation (const stdair::DateTime_T&);

    void resetDemandInformation (const stdair::DateTime_T&, const stdair::Inventory&);

    /* Projection of demand */

    // Aggregated demand at booking class level.
    void projectAggregatedDemandOnLegCabins(const stdair::DateTime_T&);

    // Static rule prorated yield
    void projectOnDDemandOnLegCabinsUsingYP(const stdair::DateTime_T&);

    // Displacement-adjusted yield
    void projectOnDDemandOnLegCabinsUsingDA(const stdair::DateTime_T&);

    // Dynamic yield proration (PF = BP_i/BP_{total}, where BP_{total} = sum(BP_i))
    void projectOnDDemandOnLegCabinsUsingDYP(const stdair::DateTime_T&);

    void projectOnDDemandOnLegCabinsUsingDYP(const stdair::DateTime_T&, const stdair::Inventory&);

    // O&D-based optimisation (using demand aggregation or demand aggregation).
    void optimiseOnD (const stdair::DateTime_T&);

    // O&D-based optimisation using displacement-adjusted yield.
    void optimiseOnDUsingRMCooperation (const stdair::DateTime_T&);

    // Advanced version of O&D-based optimisation using displacement-adjusted yield.
    // Network optimisation instead of separate inventory optimisation.    
    void optimiseOnDUsingAdvancedRMCooperation (const stdair::DateTime_T&);

    // Update bid priceand send to partners
    void updateBidPrice (const stdair::DateTime_T&);
    void updateBidPrice (const stdair::FlightDate&, stdair::BomRoot&);

  public:
    // //////////////// Export support methods /////////////////
    std::string jsonExport (const stdair::AirlineCode_T&,
                            const stdair::FlightNumber_T&,
                            const stdair::Date_T& iDepartureDate) const;


  public:
    // //////////////// Display support methods /////////////////
    std::string csvDisplay() const;


  private:
    // /////// Construction and Destruction helper methods ///////
    RMOL_Service();

    RMOL_Service (const RMOL_Service&);

    stdair::STDAIR_ServicePtr_T initStdAirService (const stdair::BasLogParams&,
                                                   const stdair::BasDBParams&);
    
    stdair::STDAIR_ServicePtr_T initStdAirService (const stdair::BasLogParams&);
    
    void addStdAirService (stdair::STDAIR_ServicePtr_T,
                           const bool iOwnStdairService);

    void initServiceContext();
    
    void initRmolService();

    void finalise();


  private:
    // ////////// Service Context //////////
    RMOL_ServiceContext* _rmolServiceContext;

    stdair::Date_T _previousForecastDate;
  };
}
#endif // __RMOL_SVC_RMOL_SERVICE_HPP