TVLSIM_Service.hpp

Go to the documentation of this file.

#ifndef __TVLSIM_SVC_TVLSIM_SERVICE_HPP
#define __TVLSIM_SVC_TVLSIM_SERVICE_HPP

// //////////////////////////////////////////////////////////////////////
// Import section
// //////////////////////////////////////////////////////////////////////
// StdAir
#include <stdair/stdair_basic_types.hpp>
#include <stdair/stdair_file.hpp>
#include <stdair/stdair_date_time_types.hpp>
#include <stdair/stdair_maths_types.hpp>
#include <stdair/stdair_service_types.hpp>
#include <stdair/basic/DemandGenerationMethod.hpp>
#include <stdair/bom/TravelSolutionTypes.hpp>
#include <stdair/bom/BreakPointStruct.hpp>
// AIRRAC
#include <airrac/AIRRAC_Types.hpp>
// SimFQT
#include <simfqt/SIMFQT_Types.hpp>
// TRADEMGEN
#include <trademgen/TRADEMGEN_Types.hpp>
// Dsim
#include <tvlsim/basic/BasConst_General.hpp>
#include <tvlsim/TVLSIM_Types.hpp>

// Forward declarations
namespace stdair { 
  class BomRoot;
  struct BasLogParams;
  struct BasDBParams;
  struct BookingRequestStruct;
  class JSONString;
  struct RMEventStruct;
}

namespace TVLSIM {

  // Forward declaration
  class TVLSIM_ServiceContext;
  struct RDSParameters;
  class SimulationStatus;
  
  class TVLSIM_Service {
  public:
    // ////////////////// Constructors and Destructors //////////////////    
    TVLSIM_Service (const stdair::BasLogParams&, const stdair::BasDBParams&,
                  const stdair::Date_T& iStartDate,
                  const stdair::Date_T& iEndDate, const stdair::RandomSeed_T&,
                  const stdair::DemandGenerationMethod&,
                  const NbOfRuns_T& iNbOfRuns = DEFAULT_NUMBER_OF_RUNS);

    TVLSIM_Service (const stdair::BasLogParams&, const stdair::Date_T& iStartDate,
                  const stdair::Date_T& iEndDate, const stdair::RandomSeed_T&,
                  const stdair::DemandGenerationMethod&,
                  const NbOfRuns_T& iNbOfRuns = DEFAULT_NUMBER_OF_RUNS);

    TVLSIM_Service (stdair::STDAIR_ServicePtr_T, const stdair::Date_T& iStartDate,
                  const stdair::Date_T& iEndDate, const stdair::RandomSeed_T&,
                  const stdair::DemandGenerationMethod&,
                  const NbOfRuns_T& iNbOfRuns = DEFAULT_NUMBER_OF_RUNS);

    ~TVLSIM_Service();

    
  public:
    // /////////// Business Methods /////////////
    void simulate ();
    
    void optimise (const stdair::RMEventStruct&);
    
    void displayAirlineListFromDB() const;

    void buildSampleBom();  

    void setInputFiles (const stdair::ScheduleFilePath&,
                        const stdair::ODFilePath&,
                        const stdair::FRAT5FilePath&,
                        const stdair::FFDisutilityFilePath&,
                        const AIRRAC::YieldFilePath&,
                        const SIMFQT::FareFilePath&,
                        const TRADEMGEN::DemandFilePath&);

    void parseAndLoad ();

    void initSnapshotAndRMEvents();  

    const stdair::Count_T initBreakPointEvents(const stdair::BreakPointList_T&);

    void reinitServices();

    void buildSampleTravelSolutions (stdair::TravelSolutionList_T&);

    stdair::BookingRequestStruct
    buildSampleBookingRequest (const bool isForCRS = false);   

    void reset();
    
    bool sell (const std::string& iSegmentDateKey, const stdair::ClassCode_T&,
               const stdair::PartySize_T&);

    
  public:
    // //////////////// Export support methods /////////////////
    std::string jsonHandler (const stdair::JSONString&);

  private: 
    std::string jsonBreakPointHandler (const stdair::JSONString&);
 
    std::string jsonRunHandler (const stdair::JSONString&);


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

    std::string configDisplay () const; 

    std::string listEvents () const;    

    std::string listEvents (const stdair::EventType::EN_EventType&) const;

    std::string simulationStatusDisplay() const;

    std::string list (const stdair::AirlineCode_T& iAirlineCode = "all",
                      const stdair::FlightNumber_T& iFlightNumber = 0) const;

    std::string csvDisplay (const stdair::AirlineCode_T&,
                            const stdair::FlightNumber_T&,
                            const stdair::Date_T& iDepartureDate) const;
    
  public:
    // //////////////// Getters /////////////////
    const SimulationStatus& getSimulationStatus();

  private:

    // /////// Construction and Destruction helper methods ///////
    TVLSIM_Service();

    TVLSIM_Service (const TVLSIM_Service&);

    stdair::STDAIR_ServicePtr_T initStdAirService (const stdair::BasLogParams&,
                                                   const stdair::BasDBParams&);
    
    stdair::STDAIR_ServicePtr_T initStdAirService (const stdair::BasLogParams&);  

    void initSEVMGRService ();
    
    void initSIMCRSService();

    void initTRADEMGENService ();

    void initTRAVELCCMService();

    void addStdAirService (stdair::STDAIR_ServicePtr_T,
                           const bool iOwnStdairService);
    
    void initServiceContext ();
    
    void initConfig (const stdair::Date_T& iStartDate,
                    const stdair::Date_T& iEndDate,
                     const stdair::RandomSeed_T&,
                     const stdair::DemandGenerationMethod&,
                     const NbOfRuns_T&);

    void initDsimService();
    
    void finalise(); 

    void prepareNewRun();

    void clonePersistentBom ();  

    void buildComplementaryLinks (stdair::BomRoot&);


  private:
    // ///////// Service Context /////////
    TVLSIM_ServiceContext* _tvlsimServiceContext;
  };
}
#endif // __TVLSIM_SVC_TVLSIM_SERVICE_HPP