stdair::LegCabin Class Reference

Class representing the actual attributes for an airline leg-cabin. More...

#include <stdair/bom/LegCabin.hpp>

Inheritance diagram for stdair::LegCabin:

List of all members.

Public Types
typedef LegCabinKey	Key_T

Public Member Functions
const Key_T &	getKey () const
BomAbstract *const	getParent () const
const CabinCode_T &	getCabinCode () const
const MapKey_T	getFullerKey () const
const HolderMap_T &	getHolderMap () const
const CabinCapacity_T &	getOfferedCapacity () const
const CabinCapacity_T &	getPhysicalCapacity () const
const NbOfSeats_T &	getSoldSeat () const
const CommittedSpace_T &	getCommittedSpace () const
const Availability_T &	getAvailabilityPool () const
const Availability_T &	getAvailability () const
const BidPrice_T &	getCurrentBidPrice () const
const BidPrice_T &	getPreviousBidPrice () const
const BidPriceVector_T &	getBidPriceVector () const
const CapacityAdjustment_T &	getRegradeAdjustment () const
const AuthorizationLevel_T &	getAuthorizationLevel () const
const UPR_T &	getUPR () const
const Availability_T &	getNetAvailability () const
const Availability_T &	getGrossAvailability () const
const OverbookingRate_T &	getAvgCancellationPercentage () const
const NbOfSeats_T &	getETB () const
const NbOfSeats_T &	getStaffNbOfSeats () const
const NbOfSeats_T &	getWLNbOfSeats () const
const NbOfSeats_T &	getGroupNbOfSeats () const
VirtualClassList_T &	getVirtualClassList ()
BidPriceVector_T &	getBidPriceVector ()
const YieldLevelDemandMap_T &	getYieldLevelDemandMap ()
void	setCapacities (const CabinCapacity_T &iCapacity)
void	setSoldSeat (const NbOfSeats_T &iSoldSeat)
void	setCommittedSpace (const CommittedSpace_T &iCommittedSpace)
void	setAvailabilityPool (const Availability_T &iAvailabilityPool)
void	setAvailability (const Availability_T &iAvailability)
void	setCurrentBidPrice (const BidPrice_T &iBidPrice)
void	setPreviousBidPrice (const BidPrice_T &iBidPrice)
void	updatePreviousBidPrice ()
void	setRegradeAdjustment (const CapacityAdjustment_T &iRegradeAdjustment)
void	setAuthorizationLevel (const AuthorizationLevel_T &iAU)
void	setUPR (const UPR_T &iUPR)
void	setNetAvailability (const Availability_T &iNAV)
void	setGrossAvailability (const Availability_T &iGAV)
void	setAvgCancellationPercentage (const OverbookingRate_T &iACP)
void	setETB (const NbOfSeats_T &iETB)
void	setStaffNbOfSeats (const NbOfSeats_T &iStaffSeats)
void	setWLNbOfSeats (const NbOfSeats_T &iWLSeats)
void	setGroupNbOfSeats (const NbOfSeats_T &iGroupSeats)
void	updateCurrentBidPrice ()
void	toStream (std::ostream &ioOut) const
void	fromStream (std::istream &ioIn)
std::string	toString () const
const std::string	describeKey () const
const std::string	displayVirtualClassList () const
void	updateFromReservation (const NbOfBookings_T &)
void	addVirtualClass (const VirtualClassStruct &iVC)
void	emptyVirtualClassList ()
void	emptyBidPriceVector ()
void	addDemandInformation (const YieldValue_T &, const MeanValue_T &, const StdDevValue_T &)
void	emptyYieldLevelDemandMap ()

Public Attributes
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

Protected Member Functions
	LegCabin (const Key_T &)
	~LegCabin ()

Protected Attributes
Key_T	_key
BomAbstract *	_parent
HolderMap_T	_holderMap
CabinCapacity_T	_offeredCapacity
CabinCapacity_T	_physicalCapacity
NbOfSeats_T	_soldSeat
CommittedSpace_T	_committedSpace
Availability_T	_availabilityPool
Availability_T	_availability
BidPrice_T	_currentBidPrice
BidPrice_T	_previousBidPrice
BidPriceVector_T	_bidPriceVector
VirtualClassList_T	_virtualClassList
YieldLevelDemandMap_T	_yieldLevelDemandMap

Friends
class	FacBom
class	FacCloneBom
class	FacBomManager

---

Detailed Description

Class representing the actual attributes for an airline leg-cabin.

Definition at line 25 of file LegCabin.hpp.

---

Member Typedef Documentation

typedef LegCabinKey stdair::LegCabin::Key_T

Definition allowing to retrieve the associated BOM key type.

Definition at line 35 of file LegCabin.hpp.

---

Constructor & Destructor Documentation

stdair::LegCabin::LegCabin ( const Key_T &  iKey )

protected

Constructor.

Definition at line 46 of file LegCabin.cpp.

stdair::LegCabin::~LegCabin ( )

protected

Destructor.

Definition at line 69 of file LegCabin.cpp.

---

Member Function Documentation

const Key_T& stdair::LegCabin::getKey ( ) const

inline

Get the leg-cabin key (cabin code).

Definition at line 42 of file LegCabin.hpp.

References _key.

BomAbstract* const stdair::LegCabin::getParent ( ) const

inline

Get the parent object.

Definition at line 49 of file LegCabin.hpp.

References _parent.

const CabinCode_T& stdair::LegCabin::getCabinCode ( ) const

inline

Get the cabin code (from key).

Definition at line 56 of file LegCabin.hpp.

References _key, and stdair::LegCabinKey::getCabinCode().

Referenced by getFullerKey().

const MapKey_T stdair::LegCabin::getFullerKey

(

)

const

Get the (leg-date, leg-cabin) key (board point and cabin code).

Note:

That method assumes that the parent object derives from the SegmentDate class, as it needs to have access to the describeKey() method.

Definition at line 80 of file LegCabin.cpp.

References stdair::DEFAULT_KEY_FLD_DELIMITER, stdair::LegDate::describeKey(), and getCabinCode().

const HolderMap_T& stdair::LegCabin::getHolderMap ( ) const

inline

Get the map of children holders.

Definition at line 72 of file LegCabin.hpp.

References _holderMap.

const CabinCapacity_T& stdair::LegCabin::getOfferedCapacity ( ) const

inline

Get the cabin offered capacity.

Definition at line 77 of file LegCabin.hpp.

References _offeredCapacity.

const CabinCapacity_T& stdair::LegCabin::getPhysicalCapacity ( ) const

inline

Get the cabin physical capacity.

Definition at line 82 of file LegCabin.hpp.

References _physicalCapacity.

const NbOfSeats_T& stdair::LegCabin::getSoldSeat ( ) const

inline

Get the number of sold seat.

Definition at line 87 of file LegCabin.hpp.

References _soldSeat.

const CommittedSpace_T& stdair::LegCabin::getCommittedSpace ( ) const

inline

Get the value of committed space.

Definition at line 92 of file LegCabin.hpp.

References _committedSpace.

const Availability_T& stdair::LegCabin::getAvailabilityPool ( ) const

inline

Get the value of the availability pool.

Definition at line 97 of file LegCabin.hpp.

References _availabilityPool.

const Availability_T& stdair::LegCabin::getAvailability ( ) const

inline

Get the value of the availability.

Definition at line 102 of file LegCabin.hpp.

References _availability.

const BidPrice_T& stdair::LegCabin::getCurrentBidPrice ( ) const

inline

Get the current Bid-Price.

Definition at line 107 of file LegCabin.hpp.

References _currentBidPrice.

const BidPrice_T& stdair::LegCabin::getPreviousBidPrice ( ) const

inline

Get the previous Bid-Price.

Definition at line 112 of file LegCabin.hpp.

References _previousBidPrice.

const BidPriceVector_T& stdair::LegCabin::getBidPriceVector ( ) const

inline

Get the Bid-Price Vector.

Definition at line 117 of file LegCabin.hpp.

References _bidPriceVector.

const CapacityAdjustment_T& stdair::LegCabin::getRegradeAdjustment ( ) const

inline

Get the capacity adjustment due to check-in (DCS) regrade.

Definition at line 122 of file LegCabin.hpp.

References _dcsRegrade.

const AuthorizationLevel_T& stdair::LegCabin::getAuthorizationLevel ( ) const

inline

Authorisation Level (AU).

Definition at line 127 of file LegCabin.hpp.

References _au.

const UPR_T& stdair::LegCabin::getUPR ( ) const

inline

Unsold Protection (UPR).

Definition at line 132 of file LegCabin.hpp.

References _upr.

const Availability_T& stdair::LegCabin::getNetAvailability ( ) const

inline

Net Availability (NAV).

Definition at line 137 of file LegCabin.hpp.

References _nav.

const Availability_T& stdair::LegCabin::getGrossAvailability ( ) const

inline

Gross Availability (GAV).

Definition at line 142 of file LegCabin.hpp.

References _gav.

const OverbookingRate_T& stdair::LegCabin::getAvgCancellationPercentage ( ) const

inline

Average Cancellation Percentage (ACP).

Definition at line 147 of file LegCabin.hpp.

References _acp.

const NbOfSeats_T& stdair::LegCabin::getETB ( ) const

inline

Expected to Board (ETB).

Definition at line 152 of file LegCabin.hpp.

References _etb.

const NbOfSeats_T& stdair::LegCabin::getStaffNbOfSeats ( ) const

inline

Number of staff bookings.

Definition at line 157 of file LegCabin.hpp.

References _staffNbOfBookings.

const NbOfSeats_T& stdair::LegCabin::getWLNbOfSeats ( ) const

inline

Number of wait-listed bookings.

Definition at line 162 of file LegCabin.hpp.

References _wlNbOfBookings.

const NbOfSeats_T& stdair::LegCabin::getGroupNbOfSeats ( ) const

inline

Number of group bookings.

Definition at line 167 of file LegCabin.hpp.

References _groupNbOfBookings.

VirtualClassList_T& stdair::LegCabin::getVirtualClassList ( )

inline

The virtual class list.

Definition at line 172 of file LegCabin.hpp.

References _virtualClassList.

BidPriceVector_T& stdair::LegCabin::getBidPriceVector ( )

inline

Reset the bid price vector and return it.

Definition at line 177 of file LegCabin.hpp.

References _bidPriceVector.

const YieldLevelDemandMap_T& stdair::LegCabin::getYieldLevelDemandMap ( )

inline

Get the yield-demand map.

Definition at line 183 of file LegCabin.hpp.

References _yieldLevelDemandMap.

void stdair::LegCabin::setCapacities

(

const CabinCapacity_T &

iCapacity

)

Set the offered and physical capacities.

Definition at line 73 of file LegCabin.cpp.

References _committedSpace, _offeredCapacity, _physicalCapacity, and setAvailabilityPool().

void stdair::LegCabin::setSoldSeat ( const NbOfSeats_T &  iSoldSeat )

inline

Set the number of sold seat.

Definition at line 194 of file LegCabin.hpp.

References _soldSeat.

void stdair::LegCabin::setCommittedSpace ( const CommittedSpace_T &  iCommittedSpace )

inline

Set the value of committed space.

Definition at line 199 of file LegCabin.hpp.

References _committedSpace.

void stdair::LegCabin::setAvailabilityPool ( const Availability_T &  iAvailabilityPool )

inline

Set the value of availability pool.

Definition at line 204 of file LegCabin.hpp.

References _availabilityPool.

Referenced by setCapacities().

void stdair::LegCabin::setAvailability ( const Availability_T &  iAvailability )

inline

Set the value of availability.

Definition at line 209 of file LegCabin.hpp.

References _availability.

void stdair::LegCabin::setCurrentBidPrice ( const BidPrice_T &  iBidPrice )

inline

Set the current Bid-Price.

Definition at line 214 of file LegCabin.hpp.

References _currentBidPrice.

void stdair::LegCabin::setPreviousBidPrice ( const BidPrice_T &  iBidPrice )

inline

Set the previous Bid-Price.

Definition at line 219 of file LegCabin.hpp.

References _previousBidPrice.

void stdair::LegCabin::updatePreviousBidPrice ( )

inline

Update the previous bid price value with the current one.

Definition at line 224 of file LegCabin.hpp.

References _currentBidPrice, and _previousBidPrice.

void stdair::LegCabin::setRegradeAdjustment ( const CapacityAdjustment_T &  iRegradeAdjustment )

inline

Get the capacity adjustment due to check-in (DCS) regrade.

Definition at line 229 of file LegCabin.hpp.

References _dcsRegrade.

void stdair::LegCabin::setAuthorizationLevel ( const AuthorizationLevel_T &  iAU )

inline

Set the Authorisation Level (AU).

Definition at line 234 of file LegCabin.hpp.

References _au.

void stdair::LegCabin::setUPR ( const UPR_T &  iUPR )

inline

Set the Unsold Protection (UPR).

Definition at line 239 of file LegCabin.hpp.

References _upr.

void stdair::LegCabin::setNetAvailability ( const Availability_T &  iNAV )

inline

Set the Net Availability (NAV).

Definition at line 244 of file LegCabin.hpp.

References _nav.

void stdair::LegCabin::setGrossAvailability ( const Availability_T &  iGAV )

inline

Set the Gross Availability (GAV).

Definition at line 249 of file LegCabin.hpp.

References _gav.

void stdair::LegCabin::setAvgCancellationPercentage ( const OverbookingRate_T &  iACP )

inline

Set the Average Cancellation Percentage (ACP).

Definition at line 254 of file LegCabin.hpp.

References _acp.

void stdair::LegCabin::setETB ( const NbOfSeats_T &  iETB )

inline

Set the Expected to Board (ETB).

Definition at line 259 of file LegCabin.hpp.

References _etb.

void stdair::LegCabin::setStaffNbOfSeats ( const NbOfSeats_T &  iStaffSeats )

inline

Set the Number of staff sold seats.

Definition at line 264 of file LegCabin.hpp.

References _staffNbOfBookings.

void stdair::LegCabin::setWLNbOfSeats ( const NbOfSeats_T &  iWLSeats )

inline

Set the Number of wait-listed sold seats.

Definition at line 269 of file LegCabin.hpp.

References _wlNbOfBookings.

void stdair::LegCabin::setGroupNbOfSeats ( const NbOfSeats_T &  iGroupSeats )

inline

Set the Number of group sold seats.

Definition at line 274 of file LegCabin.hpp.

References _groupNbOfBookings.

void stdair::LegCabin::updateCurrentBidPrice

(

)

Update the bid price (from bid price vector if not empty).

Definition at line 120 of file LegCabin.cpp.

References _availabilityPool, _bidPriceVector, and _currentBidPrice.

void stdair::LegCabin::toStream ( std::ostream &  ioOut ) const

inlinevirtual

Dump a Business Object into an output stream.

Parameters:

ostream&

the output stream.

Implements stdair::BomAbstract.

Definition at line 288 of file LegCabin.hpp.

References toString().

void stdair::LegCabin::fromStream ( std::istream &  ioIn )

inlinevirtual

Read a Business Object from an input stream.

Parameters:

istream&

the input stream.

Implements stdair::BomAbstract.

Definition at line 296 of file LegCabin.hpp.

std::string stdair::LegCabin::toString ( ) const

virtual

Get the serialised version of the Business Object.

Implements stdair::BomAbstract.

Definition at line 89 of file LegCabin.cpp.

References describeKey().

Referenced by toStream().

const std::string stdair::LegCabin::describeKey ( ) const

inline

Get a string describing the key.

Definition at line 307 of file LegCabin.hpp.

References _key, and stdair::LegCabinKey::toString().

Referenced by toString().

const std::string stdair::LegCabin::displayVirtualClassList

(

)

const

Display the virtual class list content.

Definition at line 96 of file LegCabin.cpp.

References _virtualClassList, stdair::VirtualClassStruct::getCumulatedBookingLimit(), stdair::VirtualClassStruct::getCumulatedProtection(), and stdair::VirtualClassStruct::getYield().

void stdair::LegCabin::updateFromReservation

(

const NbOfBookings_T &

iNbOfBookings

)

Register a sale.

Definition at line 114 of file LegCabin.cpp.

References _availabilityPool, _committedSpace, and _offeredCapacity.

void stdair::LegCabin::addVirtualClass ( const VirtualClassStruct &  iVC )

inline

Add a virtual class to the list.

Definition at line 327 of file LegCabin.hpp.

References _virtualClassList.

void stdair::LegCabin::emptyVirtualClassList ( )

inline

Empty the virtual class list.

Definition at line 334 of file LegCabin.hpp.

References _virtualClassList.

void stdair::LegCabin::emptyBidPriceVector ( )

inline

Empty the bid price vector.

Definition at line 341 of file LegCabin.hpp.

References _bidPriceVector.

void stdair::LegCabin::addDemandInformation	(	const YieldValue_T &	iYield,
		const MeanValue_T &	iMeanValue,
		const StdDevValue_T &	iStdDevValue
	)

Add demand information.

Definition at line 133 of file LegCabin.cpp.

References _yieldLevelDemandMap.

void stdair::LegCabin::emptyYieldLevelDemandMap ( )

inline

Reset the (yield level,demand) map.

Definition at line 354 of file LegCabin.hpp.

References _yieldLevelDemandMap.

---

Friends And Related Function Documentation

friend class FacBom

friend

Definition at line 26 of file LegCabin.hpp.

friend class FacCloneBom

friend

Definition at line 27 of file LegCabin.hpp.

friend class FacBomManager

friend

Definition at line 28 of file LegCabin.hpp.

---

Member Data Documentation

Key_T stdair::LegCabin::_key

protected

Primary key (cabin code).

Definition at line 387 of file LegCabin.hpp.

Referenced by describeKey(), getCabinCode(), and getKey().

BomAbstract* stdair::LegCabin::_parent

protected

Pointer on the parent class (LegDate).

Definition at line 392 of file LegCabin.hpp.

Referenced by getParent().

HolderMap_T stdair::LegCabin::_holderMap

protected

Map holding the children (Bucket objects).

Definition at line 397 of file LegCabin.hpp.

Referenced by getHolderMap().

CabinCapacity_T stdair::LegCabin::_offeredCapacity

protected

Saleable capacity of the cabin.

Definition at line 400 of file LegCabin.hpp.

Referenced by getOfferedCapacity(), setCapacities(), and updateFromReservation().

CabinCapacity_T stdair::LegCabin::_physicalCapacity

protected

Physical capacity of the cabin.

Definition at line 403 of file LegCabin.hpp.

Referenced by getPhysicalCapacity(), and setCapacities().

NbOfSeats_T stdair::LegCabin::_soldSeat

protected

Aggregated number of sold seats.

Definition at line 406 of file LegCabin.hpp.

Referenced by getSoldSeat(), and setSoldSeat().

CommittedSpace_T stdair::LegCabin::_committedSpace

protected

Definition at line 409 of file LegCabin.hpp.

Referenced by getCommittedSpace(), setCapacities(), setCommittedSpace(), and updateFromReservation().

Availability_T stdair::LegCabin::_availabilityPool

protected

Availability pool.

Definition at line 412 of file LegCabin.hpp.

Referenced by getAvailabilityPool(), setAvailabilityPool(), updateCurrentBidPrice(), and updateFromReservation().

Availability_T stdair::LegCabin::_availability

protected

Availability.

Definition at line 415 of file LegCabin.hpp.

Referenced by getAvailability(), and setAvailability().

BidPrice_T stdair::LegCabin::_currentBidPrice

protected

Current Bid-Price (BP).

Definition at line 418 of file LegCabin.hpp.

Referenced by getCurrentBidPrice(), setCurrentBidPrice(), updateCurrentBidPrice(), and updatePreviousBidPrice().

BidPrice_T stdair::LegCabin::_previousBidPrice

protected

Previous Bid-Price (BP).

Definition at line 421 of file LegCabin.hpp.

Referenced by getPreviousBidPrice(), setPreviousBidPrice(), and updatePreviousBidPrice().

BidPriceVector_T stdair::LegCabin::_bidPriceVector

protected

Bid-Price Vector (BPV).

Definition at line 424 of file LegCabin.hpp.

Referenced by emptyBidPriceVector(), getBidPriceVector(), and updateCurrentBidPrice().

VirtualClassList_T stdair::LegCabin::_virtualClassList

protected

List of virtual classes (for revenue management optimisation).

Definition at line 427 of file LegCabin.hpp.

Referenced by addVirtualClass(), displayVirtualClassList(), emptyVirtualClassList(), and getVirtualClassList().

YieldLevelDemandMap_T stdair::LegCabin::_yieldLevelDemandMap

protected

Map holding the demand information indexed by yield.

Definition at line 430 of file LegCabin.hpp.

Referenced by addDemandInformation(), emptyYieldLevelDemandMap(), and getYieldLevelDemandMap().

CapacityAdjustment_T stdair::LegCabin::_dcsRegrade

Capacity adjustment of the cabin, due to check-in (DCS) regrade.

Definition at line 435 of file LegCabin.hpp.

Referenced by getRegradeAdjustment(), and setRegradeAdjustment().

AuthorizationLevel_T stdair::LegCabin::_au

Authorisation Level (AU).

Definition at line 438 of file LegCabin.hpp.

Referenced by getAuthorizationLevel(), and setAuthorizationLevel().

UPR_T stdair::LegCabin::_upr

Unsold Protection (UPR).

Definition at line 441 of file LegCabin.hpp.

Referenced by getUPR(), and setUPR().

Availability_T stdair::LegCabin::_nav

Net Availability (NAV).

Definition at line 444 of file LegCabin.hpp.

Referenced by getNetAvailability(), and setNetAvailability().

Availability_T stdair::LegCabin::_gav

Gross Availability (GAV).

Definition at line 447 of file LegCabin.hpp.

Referenced by getGrossAvailability(), and setGrossAvailability().

OverbookingRate_T stdair::LegCabin::_acp

Average Cancellation Percentage (ACP).

Definition at line 450 of file LegCabin.hpp.

Referenced by getAvgCancellationPercentage(), and setAvgCancellationPercentage().

NbOfSeats_T stdair::LegCabin::_etb

Expected to Board (ETB).

Definition at line 453 of file LegCabin.hpp.

Referenced by getETB(), and setETB().

NbOfSeats_T stdair::LegCabin::_staffNbOfBookings

Number of staff bookings.

Definition at line 456 of file LegCabin.hpp.

Referenced by getStaffNbOfSeats(), and setStaffNbOfSeats().

NbOfSeats_T stdair::LegCabin::_wlNbOfBookings

Number of wait-listed bookings.

Definition at line 459 of file LegCabin.hpp.

Referenced by getWLNbOfSeats(), and setWLNbOfSeats().

NbOfSeats_T stdair::LegCabin::_groupNbOfBookings

Number of group bookings.

Definition at line 462 of file LegCabin.hpp.

Referenced by getGroupNbOfSeats(), and setGroupNbOfSeats().

---

The documentation for this class was generated from the following files:

• stdair/bom/LegCabin.hpp
• stdair/bom/LegCabin.cpp