BookingClass.hpp

Go to the documentation of this file.

#ifndef __STDAIR_BOM_BOOKINGCLASS_HPP
#define __STDAIR_BOM_BOOKINGCLASS_HPP

// //////////////////////////////////////////////////////////////////////
// Import section
// //////////////////////////////////////////////////////////////////////
// STL
#include <iosfwd>
#include <string>
// StdAir
#include <stdair/stdair_inventory_types.hpp>
#include <stdair/stdair_maths_types.hpp>
#include <stdair/stdair_rm_types.hpp>
#include <stdair/bom/BomAbstract.hpp>
#include <stdair/bom/BookingClassKey.hpp>
#include <stdair/bom/BookingClassTypes.hpp>

namespace stdair {

  class BookingClass : public BomAbstract {
    template <typename BOM> friend class FacBom;    
    template <typename BOM> friend class FacCloneBom;
    friend class FacBomManager;

  public:
    // ////////// Type definitions ////////////
    typedef BookingClassKey Key_T;

  public:
    // /////////// Getters ////////////
    const Key_T& getKey() const {
      return _key;
    }
    
    const ClassCode_T& getClassCode() const {
      return _key.getClassCode();
    }

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

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

    const SubclassCode_T& getSubclassCode() const {
      return _subclassCode;
    }

    const AuthorizationLevel_T& getAuthorizationLevel() const {
      return _au;
    }

    const ProtectionLevel_T& getProtection() const {
      return _protection;
    }

    const ProtectionLevel_T& getCumulatedProtection() const {
      return _cumulatedProtection;
    }

    const BookingLimit_T& getCumulatedBookingLimit() const {
      return _cumulatedBookingLimit;
    }

    const NbOfSeats_T& getNegotiatedSpace() const {
      return _nego;
    }

    const OverbookingRate_T& getNoShowPercentage() const {
      return _noShowPercentage;
    }

    const OverbookingRate_T& getCancellationPercentage() const {
      return _cancellationPercentage;
    }

    const NbOfBookings_T& getNbOfBookings() const {
      return _nbOfBookings;
    }

    const NbOfBookings_T& getNbOfGroupBookings() const {
      return _groupNbOfBookings;
    }

    const NbOfBookings_T& getNbOfPendingGroupBookings() const {
      return _groupPendingNbOfBookings;
    }

    const NbOfBookings_T& getNbOfStaffBookings() const {
      return _staffNbOfBookings;
    }

    const NbOfBookings_T& getNbOfWLBookings() const {
      return _wlNbOfBookings;
    }

    const NbOfCancellations_T& getNbOfCancellations() const {
      return _nbOfCancellations;
    }

    const NbOfBookings_T& getETB() const {
      return _etb;
    }

    const Availability_T& getNetClassAvailability() const {
      return _netClassAvailability;
    }

    const Availability_T& getSegmentAvailability() const {
      return _segmentAvailability;
    }

    const Availability_T& getNetRevenueAvailability() const {
      return _netRevenueAvailability;
    }

    const Yield_T& getYield () const { return _yield; }
    const Yield_T& getAdjustedYield () const { return _adjustedYield; }
    
    const MeanValue_T& getMean () const { return _mean; }
    const StdDevValue_T& getStdDev () const {return _stdDev; }
    const MeanValue_T& getPriceDemMean () const { return _priceDemMean; }
    const StdDevValue_T& getPriceDemStdDev () const { return _priceDemStdDev; }
    const MeanValue_T& getCumuPriceDemMean () const {
      return _cumuPriceDemMean;
    }
    const StdDevValue_T& getCumuPriceDemStdDev () const {
      return _cumuPriceDemStdDev;
    }  
    const MeanValue_T& getProductDemMean () const { return _productDemMean; }
    const StdDevValue_T& getProductDemStdDev () const {return _productDemStdDev; }

    const GeneratedDemandVector_T& getGeneratedDemandVector () const {
      return _generatedDemandVector;
    }
  
  public:
    // /////////// Setters ////////////
    void setCumulatedProtection (const ProtectionLevel_T& iPL) {
      _cumulatedProtection = iPL;
    }

    void setProtection (const ProtectionLevel_T& iPL) {
      _protection = iPL;
    }
    
    void setCumulatedBookingLimit (const BookingLimit_T& iBL) {
      _cumulatedBookingLimit = iBL;
    }

    void setAuthorizationLevel (const AuthorizationLevel_T& iAU) {
      _au = iAU;
    }

    void setSegmentAvailability (const Availability_T& iAvl) {
      _segmentAvailability = iAvl;
    }

    void setYield (const Yield_T& iYield) {
      _yield = iYield;
      _adjustedYield = iYield;
    }
    void setAdjustedYield (const Yield_T& iYield) { _adjustedYield = iYield; }
    
    void setMean (const MeanValue_T& iMean) { _mean = iMean; }
    void setStdDev (const StdDevValue_T& iStdDev) { _stdDev = iStdDev; }
    void setPriceDemMean (const MeanValue_T& iMean) { _priceDemMean = iMean; }
    void setPriceDemStdDev (const StdDevValue_T& iStdDev) {
      _priceDemStdDev = iStdDev;
    }
    void setCumuPriceDemMean (const MeanValue_T& iMean) {
      _cumuPriceDemMean = iMean; }
    void setCumuPriceDemStdDev (const StdDevValue_T& iStdDev) {
      _cumuPriceDemStdDev = iStdDev;
    }
    void setProductDemMean (const MeanValue_T& iMean) {
      _productDemMean = iMean;
    }
    void setProductDemStdDev (const StdDevValue_T& iStdDev) {
      _productDemStdDev = iStdDev;
    }

  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:
    // ////////////// Business Methods /////////////////
    void sell (const NbOfBookings_T&);
    
    void cancel (const NbOfBookings_T&);

    void generateDemandSamples (const NbOfSamples_T&);

    void generateDemandSamples (const NbOfSamples_T&, const RandomSeed_T&);

  protected:
    // ////////// Constructors and destructors /////////
    BookingClass (const Key_T&);
    virtual ~BookingClass();

  private:
    BookingClass();
    BookingClass (const BookingClass&);


  protected:
    // ////////// Attributes /////////
    Key_T _key;

    BomAbstract* _parent;

    HolderMap_T _holderMap;

    SubclassCode_T _subclassCode;

    ProtectionLevel_T _cumulatedProtection;

    ProtectionLevel_T _protection;

    BookingLimit_T _cumulatedBookingLimit;

    AuthorizationLevel_T _au;

    NbOfSeats_T _nego;

    OverbookingRate_T _noShowPercentage;

    OverbookingRate_T _cancellationPercentage;

    NbOfBookings_T _nbOfBookings;

    NbOfBookings_T _groupNbOfBookings;

    NbOfBookings_T _groupPendingNbOfBookings;

    NbOfBookings_T _staffNbOfBookings;

    NbOfBookings_T _wlNbOfBookings;

    NbOfCancellations_T _nbOfCancellations;

    NbOfBookings_T _etb;

    Availability_T _netClassAvailability;

    Availability_T _segmentAvailability;

    Availability_T _netRevenueAvailability;

    Yield_T _yield;
    Yield_T _adjustedYield;

    MeanValue_T _mean;
    StdDevValue_T _stdDev;

    MeanValue_T _priceDemMean;
    StdDevValue_T _priceDemStdDev;

    MeanValue_T _cumuPriceDemMean;
    StdDevValue_T _cumuPriceDemStdDev;

    MeanValue_T _productDemMean;
    StdDevValue_T _productDemStdDev;

    GeneratedDemandVector_T _generatedDemandVector;
  };

}
#endif // __STDAIR_BOM_BOOKINGCLASS_HPP