YieldRuleStruct.hpp

Go to the documentation of this file.

#ifndef __AIRRAC_BOM_YIELDRULESTRUCT_HPP
#define __AIRRAC_BOM_YIELDRULESTRUCT_HPP

// //////////////////////////////////////////////////////////////////////
// Import section
// //////////////////////////////////////////////////////////////////////
// STL
#include <string>
// StdAir
#include <stdair/stdair_basic_types.hpp>
#include <stdair/stdair_date_time_types.hpp>
#include <stdair/stdair_demand_types.hpp>
#include <stdair/stdair_inventory_types.hpp>
#include <stdair/basic/StructAbstract.hpp>
#include <stdair/basic/BasParserHelperTypes.hpp>
// AirRAC
#include <airrac/AIRRAC_Types.hpp>

namespace AIRRAC {

  struct YieldRuleStruct : public stdair::StructAbstract {
  public:
    // /////////////////// Initialisation / Destruction /////////////////////
    YieldRuleStruct();

    ~YieldRuleStruct();
    
  public:
    // ////////////////////// Getters /////////////////////////
    AIRRAC::YieldID_T getYieldID () const {
      return _yieldId;
    }
    
    stdair::AirportCode_T getOrigin () const {
      return _origin;
    }
    
    stdair::AirportCode_T getDestination () const {
      return _destination;
    }

    stdair::TripType_T getTripType () const {
      return _tripType;
    }

    stdair::Date_T getDateRangeStart () const {
      return _dateRangeStart;
    }

    stdair::Date_T getDateRangeEnd () const {
      return _dateRangeEnd;
    }

    stdair::Duration_T getTimeRangeStart () const {
      return _timeRangeStart;
    }

    stdair::Duration_T getTimeRangeEnd () const {
      return _timeRangeEnd;
    }

    stdair::CabinCode_T getCabinCode () const {
      return _cabinCode;
    }
    
    const stdair::CityCode_T getPOS () const {
      return _pos;
    }

    stdair::ChannelLabel_T getChannel () const {
      return _channel;
    }

    stdair::YieldValue_T getYield () const {
      return _yield;
    }

    stdair::AirlineCode_T getAirlineCode () const {
      return _airlineCode;
    }

    stdair::ClassCode_T getClassCode () const {
      return _classCode;
    }

    const unsigned int getAirlineListSize () const {
      return _airlineCodeList.size();
    }

    const unsigned int getClassCodeListSize () const {
      return _classCodeList.size();
    }

    stdair::AirlineCodeList_T getAirlineList () const {
      return _airlineCodeList;
    }

    stdair::ClassList_StringList_T getClassCodeList () const {
      return _classCodeList;
    }

  public: 
    // ////////////////////// Display support methods /////////////////////////
    stdair::Date_T calculateDate() const;

    stdair::Duration_T calculateTime() const;
  
    const std::string describe() const;

  public:
    // ///////// Setters //////////
    void setYieldID (const AIRRAC::YieldID_T iYieldID) {
      _yieldId = iYieldID;
    }

    void setOrigin (const stdair::AirportCode_T& iOrigin) {
      _origin = iOrigin;
    }
    
    void setDestination (const stdair::AirportCode_T& iDestination) {
      _destination = iDestination;
    }

    void setTripType (const stdair::TripType_T& iTripType) {
      _tripType = iTripType;
    }

    void setDateRangeStart (const stdair::Date_T& iDateRangeStart) {
      _dateRangeStart = iDateRangeStart;
    }

    void setDateRangeEnd (const stdair::Date_T& iDateRangeEnd) {
      _dateRangeEnd = iDateRangeEnd;
    }

    void setTimeRangeStart (const stdair::Duration_T& iTimeRangeStart) {
      _timeRangeStart = iTimeRangeStart;
    }

    void setTimeRangeEnd (const stdair::Duration_T& iTimeRangeEnd) {
      _timeRangeEnd = iTimeRangeEnd;
    }

    void setCabinCode (const stdair::CabinCode_T& iCabinCode) {
      _cabinCode = iCabinCode;
    }

    void setPOS (const stdair::CityCode_T& iPOS) {
      _pos = iPOS;
    }

    void setChannel (const stdair::ChannelLabel_T& iChannel) {
      _channel = iChannel;
    }

    void setYield(const stdair::YieldValue_T& iYield) {
      _yield = iYield;
    }

    void setAirlineCode (const stdair::AirlineCode_T&  iAirlineCode) {
      _airlineCode = iAirlineCode;
    }

    void setClassCode (const stdair::ClassCode_T& iClassCode) {
      _classCode = iClassCode;
    }

    void clearAirlineCodeList () {
      _airlineCodeList.clear();
    }

    void clearClassCodeList () {
      _classCodeList.clear();
    }

    void addAirlineCode (const stdair::AirlineCode_T& iAirlineCode)  {
      _airlineCodeList.push_back (iAirlineCode);
    }

    void addClassCode (const stdair::ClassCode_T& iClassCode) {
      _classCodeList.push_back (iClassCode);
    }

  public:
    // ////////////////// Attributes /////////////////
    stdair::year_t _itYear;
    stdair::month_t _itMonth;
    stdair::day_t _itDay;
      
    //long _itHours;
    stdair::hour_t _itHours;
    stdair::minute_t _itMinutes;
    stdair::second_t _itSeconds;

  private:
    // ////////////////// Attributes /////////////////   

    YieldID_T _yieldId;

    stdair::AirportCode_T _origin;

    stdair::AirportCode_T _destination; 

    stdair::TripType_T _tripType;

    stdair::Date_T _dateRangeStart;

    stdair::Date_T _dateRangeEnd;
    
    stdair::Duration_T _timeRangeStart;
     
    stdair::Duration_T _timeRangeEnd;
    
    stdair::YieldValue_T _yield;

    stdair::CabinCode_T _cabinCode;

    stdair::CityCode_T _pos;
    
    stdair::ChannelLabel_T _channel;

    stdair::AirlineCode_T _airlineCode;

    stdair::ClassCode_T _classCode;

    stdair::AirlineCodeList_T _airlineCodeList;

    stdair::ClassList_StringList_T _classCodeList;
  };

}
#endif // __AIRRAC_BOM_YIELDRULESTRUCT_HPP