LegCabin.hpp

Go to the documentation of this file.

#ifndef __STDAIR_BOM_LEGCABIN_HPP
#define __STDAIR_BOM_LEGCABIN_HPP
// //////////////////////////////////////////////////////////////////////
// Import section
// //////////////////////////////////////////////////////////////////////
// STL
#include <iosfwd>
#include <string>
// StdAir
#include <stdair/stdair_inventory_types.hpp>
#include <stdair/stdair_maths_types.hpp>
#include <stdair/bom/BomAbstract.hpp>
#include <stdair/bom/LegCabinKey.hpp>
#include <stdair/bom/LegCabinTypes.hpp>
#include <stdair/bom/VirtualClassStruct.hpp>
#include <stdair/bom/VirtualClassTypes.hpp>


namespace stdair {

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

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

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

    BomAbstract* const getParent() const {
      return _parent;
    }
    
    const CabinCode_T& getCabinCode() const {
      return _key.getCabinCode();
    }

    const MapKey_T getFullerKey() const;

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

    const CabinCapacity_T& getOfferedCapacity() const {
      return _offeredCapacity;
    }

    const CabinCapacity_T& getPhysicalCapacity() const {
      return _physicalCapacity;
    }

    const NbOfSeats_T& getSoldSeat() const {
      return _soldSeat;
    }

    const CommittedSpace_T& getCommittedSpace() const {
      return _committedSpace;
    }

    const Availability_T& getAvailabilityPool() const {
      return _availabilityPool;
    }

    const Availability_T& getAvailability() const {
      return _availability;
    }

    const BidPrice_T& getCurrentBidPrice() const {
      return _currentBidPrice;
    }

    const BidPrice_T& getPreviousBidPrice() const {
      return _previousBidPrice;
    }
    
    const BidPriceVector_T& getBidPriceVector() const {
      return _bidPriceVector;
    }

    const CapacityAdjustment_T& getRegradeAdjustment() const {
      return _dcsRegrade;
    }

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

    const UPR_T& getUPR() const {
      return _upr;
    }

    const Availability_T& getNetAvailability() const {
      return _nav;
    }

    const Availability_T& getGrossAvailability() const {
      return _gav;
    }

    const OverbookingRate_T& getAvgCancellationPercentage() const {
      return _acp;
    }

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

    const NbOfSeats_T& getStaffNbOfSeats() const {
      return _staffNbOfBookings;
    }

    const NbOfSeats_T& getWLNbOfSeats() const {
      return _wlNbOfBookings;
    }

    const NbOfSeats_T& getGroupNbOfSeats() const {
      return _groupNbOfBookings;
    }

    VirtualClassList_T& getVirtualClassList() {
      return _virtualClassList;
    }

    BidPriceVector_T& getBidPriceVector() {
      return _bidPriceVector;
    }


    const YieldLevelDemandMap_T& getYieldLevelDemandMap() {
      return _yieldLevelDemandMap;
    }


  public:
    // ///////////// Setters ///////////////
    void setCapacities (const CabinCapacity_T& iCapacity);
    
    void setSoldSeat (const NbOfSeats_T& iSoldSeat) {
      _soldSeat = iSoldSeat;
    }

    void setCommittedSpace (const CommittedSpace_T& iCommittedSpace) {
      _committedSpace = iCommittedSpace;
    }

    void setAvailabilityPool (const Availability_T& iAvailabilityPool) {
      _availabilityPool = iAvailabilityPool;
    }

    void setAvailability (const Availability_T& iAvailability) {
      _availability = iAvailability;
    }

    void setCurrentBidPrice (const BidPrice_T& iBidPrice) {
      _currentBidPrice = iBidPrice;
    }

    void setPreviousBidPrice (const BidPrice_T& iBidPrice) {
      _previousBidPrice = iBidPrice;
    }

    void updatePreviousBidPrice () {
      _previousBidPrice = _currentBidPrice;
    }   

    void setRegradeAdjustment (const CapacityAdjustment_T& iRegradeAdjustment) {
      _dcsRegrade = iRegradeAdjustment;
    }

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

    void setUPR (const UPR_T& iUPR) {
      _upr = iUPR;
    }

    void setNetAvailability (const Availability_T& iNAV) {
      _nav = iNAV;
    }

    void setGrossAvailability (const Availability_T& iGAV) {
      _gav = iGAV;
    }

    void setAvgCancellationPercentage (const OverbookingRate_T& iACP) {
      _acp = iACP;
    }

    void setETB (const NbOfSeats_T& iETB) {
      _etb = iETB;
    }

    void setStaffNbOfSeats (const NbOfSeats_T& iStaffSeats) {
      _staffNbOfBookings = iStaffSeats;
    }

    void setWLNbOfSeats (const NbOfSeats_T& iWLSeats) {
      _wlNbOfBookings = iWLSeats;
    }

    void setGroupNbOfSeats (const NbOfSeats_T& iGroupSeats) {
      _groupNbOfBookings = iGroupSeats;
    }

    void updateCurrentBidPrice();

    
  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();
    }

    const std::string displayVirtualClassList() const;


  public:
    // /////////// Business methods //////////
    void updateFromReservation (const NbOfBookings_T&);

    void addVirtualClass (const VirtualClassStruct& iVC) {
      _virtualClassList.push_back (iVC);
    }

    void emptyVirtualClassList() {
      _virtualClassList.clear();
    }

    void emptyBidPriceVector() {
      _bidPriceVector.clear();
    }

    void addDemandInformation (const YieldValue_T&, const MeanValue_T&,
                               const StdDevValue_T&);

    void emptyYieldLevelDemandMap() {
      _yieldLevelDemandMap.clear();
    }


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


  private:
    LegCabin();
    LegCabin (const LegCabin&);


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

    BomAbstract* _parent;
    
    HolderMap_T _holderMap;

    CabinCapacity_T _offeredCapacity;

    CabinCapacity_T _physicalCapacity;

    NbOfSeats_T  _soldSeat;

    /* Committed space. */
    CommittedSpace_T  _committedSpace;

    Availability_T _availabilityPool;

    Availability_T _availability;

    BidPrice_T _currentBidPrice;

    BidPrice_T _previousBidPrice;
    
    BidPriceVector_T _bidPriceVector;

    VirtualClassList_T _virtualClassList;

    YieldLevelDemandMap_T _yieldLevelDemandMap;


  public:
    CapacityAdjustment_T _dcsRegrade;

    AuthorizationLevel_T _au;

    UPR_T _upr;

    Availability_T _nav;

    Availability_T _gav;

    OverbookingRate_T _acp;

    NbOfSeats_T _etb;

    NbOfSeats_T _staffNbOfBookings;

    NbOfSeats_T _wlNbOfBookings;

    NbOfSeats_T _groupNbOfBookings;
  };

}
#endif // __STDAIR_BOM_LEGCABIN_HPP