AirInv Logo  0.1.2
C++ Simulated Airline Inventory Management System library
AIRINV::AIRINV_Service Class Reference

Interface for the AIRINV Services. More...

#include <airinv/AIRINV_Service.hpp>

List of all members.

Public Member Functions

 AIRINV_Service (const stdair::BasLogParams &, const stdair::BasDBParams &)
 AIRINV_Service (const stdair::BasLogParams &)
 AIRINV_Service (stdair::STDAIR_ServicePtr_T)
void parseAndLoad (const stdair::Filename_T &iInventoryFilename)
void parseAndLoad (const stdair::Filename_T &iScheduleFilename, const stdair::Filename_T &iODInputFilename, const AIRRAC::YieldFilePath &iYieldFilename)
 ~AIRINV_Service ()
void buildSampleBom ()
stdair::RMEventList_T initRMEvents (const stdair::Date_T &iStartDate, const stdair::Date_T &iEndDate)
void calculateAvailability (stdair::TravelSolutionStruct &, const stdair::PartnershipTechnique &)
bool sell (const std::string &iSegmentDateKey, const stdair::ClassCode_T &, const stdair::PartySize_T &)
bool cancel (const std::string &iSegmentDateKey, const stdair::ClassCode_T &, const stdair::PartySize_T &)
void takeSnapshots (const stdair::AirlineCode_T &, const stdair::DateTime_T &)
void optimise (const stdair::AirlineCode_T &, const stdair::KeyDescription_T &, const stdair::DateTime_T &, const stdair::ForecastingMethod &, const stdair::PartnershipTechnique &)
std::string jsonExport (const stdair::AirlineCode_T &, const stdair::FlightNumber_T &, const stdair::Date_T &iDepartureDate) const
std::string list (const stdair::AirlineCode_T &iAirlineCode="all", const stdair::FlightNumber_T &iFlightNumber=0) const
bool check (const stdair::AirlineCode_T &, const stdair::FlightNumber_T &, const stdair::Date_T &iDepartureDate) const
std::string csvDisplay () const
std::string csvDisplay (const stdair::AirlineCode_T &, const stdair::FlightNumber_T &, const stdair::Date_T &iDepartureDate) const

Detailed Description

Interface for the AIRINV Services.

Definition at line 37 of file AIRINV_Service.hpp.


Constructor & Destructor Documentation

AIRINV::AIRINV_Service::AIRINV_Service ( const stdair::BasLogParams &  iLogParams,
const stdair::BasDBParams &  iDBParams 
)

Constructor.

The initAirinvService() method is called; see the corresponding documentation for more details.

A reference on an output stream is given, so that log outputs can be directed onto that stream.

Moreover, database connection parameters are given, so that a session can be created on the corresponding database.

Parameters:
conststdair::BasLogParams& Parameters for the output log stream.
conststdair::BasDBParams& Parameters for the database access.

Definition at line 74 of file AIRINV_Service.cpp.

AIRINV::AIRINV_Service::AIRINV_Service ( const stdair::BasLogParams &  iLogParams)

Constructor.

The initAirinvService() method is called; see the corresponding documentation for more details.

A reference on an output stream is given, so that log outputs can be directed onto that stream.

Parameters:
conststdair::BasLogParams& Parameters for the output log stream.

Definition at line 48 of file AIRINV_Service.cpp.

AIRINV::AIRINV_Service::AIRINV_Service ( stdair::STDAIR_ServicePtr_T  ioSTDAIR_Service_ptr)

Constructor.

The initAirinvService() method is called; see the corresponding documentation for more details.

Moreover, as no reference on any output stream is given, it is assumed that the StdAir log service has already been initialised with the proper log output stream by some other methods in the calling chain (for instance, when the AIRINV_Master_Service is itself being initialised by another library service such as SIMCRS_Service).

Parameters:
stdair::STDAIR_ServicePtr_TReference on the STDAIR service.
conststdair::Filename_T& Filename of the input inventory file.

Definition at line 101 of file AIRINV_Service.cpp.

Destructor.

Definition at line 124 of file AIRINV_Service.cpp.


Member Function Documentation

void AIRINV::AIRINV_Service::parseAndLoad ( const stdair::Filename_T &  iInventoryFilename)

Parse the inventory dump and load it into memory.

The CSV file, describing the airline inventory for the simulator, is parsed and instantiated in memory accordingly.

Parameters:
conststdair::Filename_T& Filename of the input demand file.

Definition at line 251 of file AIRINV_Service.cpp.

References AIRINV::InventoryParser::buildInventory().

Referenced by AIRINV::AIRINV_Master_Service::parseAndLoad().

void AIRINV::AIRINV_Service::parseAndLoad ( const stdair::Filename_T &  iScheduleFilename,
const stdair::Filename_T &  iODInputFilename,
const AIRRAC::YieldFilePath &  iYieldFilename 
)

Parse the schedule and O&D input files, and load them into memory.

The CSV files, describing the airline schedule and the O&Ds for the simulator, are parsed and instantiated in memory accordingly.

Parameters:
conststdair::Filename_T& Filename of the input schedule file.
conststdair::Filename_T& Filename of the input O&D file.
constAIRRAC::YieldFilePath& Filename of the input yield file.

Definition at line 266 of file AIRINV_Service.cpp.

References AIRINV::ScheduleParser::generateInventories().

Build a sample BOM tree, and attach it to the BomRoot instance.

The BOM tree is based on two actual inventories (one for BA, another for AF). Each inventory contains one flight. One of those flights has two legs (and therefore three segments).

Definition at line 290 of file AIRINV_Service.cpp.

References AIRINV::InventoryManager::buildSimilarSegmentCabinSets().

Referenced by AIRINV::AIRINV_Master_Service::buildSampleBom().

stdair::RMEventList_T AIRINV::AIRINV_Service::initRMEvents ( const stdair::Date_T &  iStartDate,
const stdair::Date_T &  iEndDate 
)

Initialise the RM events for the inventory.

Parameters:
conststdair::Date_T& Parameters for the start date.
conststdair::Date_T& Parameters for the end date.

Definition at line 493 of file AIRINV_Service.cpp.

Referenced by AIRINV::AIRINV_Master_Service::initSnapshotAndRMEvents().

void AIRINV::AIRINV_Service::calculateAvailability ( stdair::TravelSolutionStruct &  ioTravelSolution,
const stdair::PartnershipTechnique &  iPartnershipTechnique 
)

Compute the availability for the given travel solution.

Definition at line 525 of file AIRINV_Service.cpp.

Referenced by AIRINV::AIRINV_Master_Service::calculateAvailability().

bool AIRINV::AIRINV_Service::sell ( const std::string &  iSegmentDateKey,
const stdair::ClassCode_T &  iClassCode,
const stdair::PartySize_T &  iPartySize 
)

Register a booking.

Parameters:
conststd::string& Key for the segment on which the sale is made
conststdair::ClassCode_T& Class code where the sale is made
conststdair::PartySize_T& Party size
Returns:
bool Whether or not the sale was successfull

Definition at line 552 of file AIRINV_Service.cpp.

Referenced by AIRINV::AIRINV_Master_Service::sell().

bool AIRINV::AIRINV_Service::cancel ( const std::string &  iSegmentDateKey,
const stdair::ClassCode_T &  iClassCode,
const stdair::PartySize_T &  iPartySize 
)

Register a cancellation.

Parameters:
conststd::string& Key for the segment on which the cancellation is made
conststdair::ClassCode_T& Class code where the sale is made
conststdair::PartySize_T& Party size
Returns:
bool Whether or not the sale was successfull

Definition at line 593 of file AIRINV_Service.cpp.

Referenced by AIRINV::AIRINV_Master_Service::cancel().

void AIRINV::AIRINV_Service::takeSnapshots ( const stdair::AirlineCode_T &  iAirlineCode,
const stdair::DateTime_T &  iSnapshotTime 
)

Take inventory snapshots.

Definition at line 637 of file AIRINV_Service.cpp.

Referenced by AIRINV::AIRINV_Master_Service::takeSnapshots().

void AIRINV::AIRINV_Service::optimise ( const stdair::AirlineCode_T &  iAirlineCode,
const stdair::KeyDescription_T &  iFDDescription,
const stdair::DateTime_T &  iRMEventTime,
const stdair::ForecastingMethod &  iForecastingMethod,
const stdair::PartnershipTechnique &  iPartnershipTechnique 
)

Optimise (revenue management) an flight-date/network-date

Definition at line 664 of file AIRINV_Service.cpp.

Referenced by AIRINV::AIRINV_Master_Service::optimise().

std::string AIRINV::AIRINV_Service::jsonExport ( const stdair::AirlineCode_T &  iAirlineCode,
const stdair::FlightNumber_T &  iFlightNumber,
const stdair::Date_T &  iDepartureDate 
) const

Recursively dump, in the returned string and in JSON format, the flight-date corresponding to the parameters given as input.

Parameters:
conststdair::AirlineCode_T& Airline code of the flight to dump.
conststdair::FlightNumber_T& Flight number of the flight to dump.
conststdair::Date_T& Departure date of the flight to dump.
Returns:
std::string Output string in which the BOM tree is JSON-ified.

Definition at line 376 of file AIRINV_Service.cpp.

Referenced by AIRINV::AIRINV_Master_Service::jsonExport().

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

Display the list of flight-dates (contained within the BOM tree) corresponding to the parameters given as input.

Parameters:
constAirlineCode& Airline for which the flight-dates should be displayed. If set to "all" (the default), all the inventories will be displayed.
constFlightNumber_T& Flight number for which all the departure dates should be displayed. If set to 0 (the default), all the flight numbers will be displayed.
Returns:
std::string Output string in which the BOM tree is logged/dumped.

Definition at line 400 of file AIRINV_Service.cpp.

Referenced by AIRINV::AIRINV_Master_Service::list().

bool AIRINV::AIRINV_Service::check ( const stdair::AirlineCode_T &  iAirlineCode,
const stdair::FlightNumber_T &  iFlightNumber,
const stdair::Date_T &  iDepartureDate 
) const

Check whether the given flight-date is a valid one.

Parameters:
conststdair::AirlineCode_T& Airline code of the flight to check.
conststdair::FlightNumber_T& Flight number of the flight to check.
conststdair::Date_T& Departure date of the flight to check.
Returns:
bool Whether or not the given flight date is valid.

Definition at line 424 of file AIRINV_Service.cpp.

Referenced by AIRINV::AIRINV_Master_Service::check().

std::string AIRINV::AIRINV_Service::csvDisplay ( ) const

Recursively display (dump in the returned string) the objects of the BOM tree.

Returns:
std::string Output string in which the BOM tree is logged/dumped.

Definition at line 448 of file AIRINV_Service.cpp.

Referenced by AIRINV::AIRINV_Master_Service::csvDisplay().

std::string AIRINV::AIRINV_Service::csvDisplay ( const stdair::AirlineCode_T &  iAirlineCode,
const stdair::FlightNumber_T &  iFlightNumber,
const stdair::Date_T &  iDepartureDate 
) const

Recursively display (dump in the returned string) the flight-date corresponding to the parameters given as input.

Parameters:
conststdair::AirlineCode_T& Airline code of the flight to display
conststdair::FlightNumber_T& Flight number of the flight to display.
conststdair::Date_T& Departure date of the flight to display.
Returns:
std::string Output string in which the BOM tree is logged/dumped.

Definition at line 469 of file AIRINV_Service.cpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines