stdair::SegmentCabin Class Reference

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

#include <stdair/bom/SegmentCabin.hpp>

Inheritance diagram for stdair::SegmentCabin:

Public Types
typedef SegmentCabinKey	Key_T

Public Member Functions
const Key_T &	getKey () const
BomAbstract *const	getParent () const
const HolderMap_T &	getHolderMap () const
const CabinCode_T &	getCabinCode () const
const MapKey_T	getFullerKey () const
const SegmentSnapshotTable &	getSegmentSnapshotTable () const
const CabinCapacity_T &	getCapacity () const
const BlockSpace_T &	getBlockSpace () const
const BlockSpace_T &	getMIN () const
const UPR_T &	getUPR () const
const NbOfBookings_T &	getBookingCounter () const
const CommittedSpace_T &	getCommittedSpace () const
const Availability_T &	getAvailabilityPool () const
const BidPrice_T &	getCurrentBidPrice () const
const BidPriceVector_T &	getBidPriceVector () const
const bool	getFareFamilyStatus () const
const PolicyList_T &	getConvexHull () const
void	setSegmentSnapshotTable (SegmentSnapshotTable &ioTable)
void	setCapacity (const CabinCapacity_T &iCapacity)
void	setBlockSpace (const BlockSpace_T &iBlockSpace)
void	setMIN (const BlockSpace_T &iMIN)
void	setUPR (const UPR_T &iUPR)
void	setBookingCounter (const NbOfBookings_T &iBookingCounter)
void	setCommittedSpace (const CommittedSpace_T &iCommittedSpace)
void	setAvailabilityPool (const Availability_T &iAvailabilityPool)
void	setBidPriceVector (const BidPriceVector_T &iBPV)
void	activateFareFamily ()
void	updateFromReservation (const NbOfBookings_T &)
void	resetConvexHull ()
void	addPolicy (Policy &)
void	toStream (std::ostream &ioOut) const
void	fromStream (std::istream &ioIn)
std::string	toString () const
const std::string	describeKey () const
const std::string	describeConvexHull () const
template<class Archive >
void	serialize (Archive &ar, const unsigned int iFileVersion)

Protected Member Functions
	SegmentCabin (const Key_T &)
virtual	~SegmentCabin ()

Protected Attributes
Key_T	_key
BomAbstract *	_parent
HolderMap_T	_holderMap
SegmentSnapshotTable *	_segmentSnapshotTable
CabinCapacity_T	_capacity
BlockSpace_T	_blockSpace
BlockSpace_T	_min
UPR_T	_upr
NbOfBookings_T	_bookingCounter
CommittedSpace_T	_committedSpace
Availability_T	_availabilityPool
BidPriceVector_T	_bidPriceVector
BidPrice_T	_currentBidPrice
bool	_fareFamilyActivation
PolicyList_T	_convexHull

Friends
template<typename BOM >
class	FacBom
template<typename BOM >
class	FacCloneBom
class	FacBomManager
class	boost::serialization::access

Detailed Description

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

Definition at line 33 of file SegmentCabin.hpp.

Member Typedef Documentation

typedef SegmentCabinKey stdair::SegmentCabin::Key_T

Definition allowing to retrieve the associated BOM key type.

Definition at line 44 of file SegmentCabin.hpp.

Constructor & Destructor Documentation

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

protected

Constructor.

Definition at line 39 of file SegmentCabin.cpp.

stdair::SegmentCabin::~SegmentCabin ( )

protectedvirtual

Destructor.

Definition at line 52 of file SegmentCabin.cpp.

Member Function Documentation

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

inline

Get the segment-cabin key (cabin code).

Definition at line 52 of file SegmentCabin.hpp.

References _key.

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

inline

Get the parent object.

Definition at line 59 of file SegmentCabin.hpp.

References _parent.

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

inline

Get the map of children holders.

Definition at line 66 of file SegmentCabin.hpp.

References _holderMap.

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

inline

Get the cabin code (primary key).

Definition at line 73 of file SegmentCabin.hpp.

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

Referenced by getFullerKey().

const MapKey_T stdair::SegmentCabin::getFullerKey

(

)

const

Get the (segment-date, segment-cabin) key (board point, off 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 56 of file SegmentCabin.cpp.

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

const SegmentSnapshotTable& stdair::SegmentCabin::getSegmentSnapshotTable ( ) const

inline

Get the guilltine block.

Definition at line 88 of file SegmentCabin.hpp.

References _segmentSnapshotTable.

const CabinCapacity_T& stdair::SegmentCabin::getCapacity ( ) const

inline

Get the cabin capacity.

Definition at line 94 of file SegmentCabin.hpp.

References _capacity.

const BlockSpace_T& stdair::SegmentCabin::getBlockSpace ( ) const

inline

Get the blocked number of bookings.

Definition at line 99 of file SegmentCabin.hpp.

References _blockSpace.

const BlockSpace_T& stdair::SegmentCabin::getMIN ( ) const

inline

Get the blocked number of bookings.

Definition at line 104 of file SegmentCabin.hpp.

References _min.

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

inline

Unsold Protection (UPR).

Definition at line 109 of file SegmentCabin.hpp.

References _upr.

const NbOfBookings_T& stdair::SegmentCabin::getBookingCounter ( ) const

inline

Get the booking counter.

Definition at line 114 of file SegmentCabin.hpp.

References _bookingCounter.

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

inline

Get the committed Space value.

Definition at line 119 of file SegmentCabin.hpp.

References _committedSpace.

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

inline

Get the availability pool value.

Definition at line 124 of file SegmentCabin.hpp.

References _availabilityPool.

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

inline

Retrieve the current Bid-Price.

Definition at line 129 of file SegmentCabin.hpp.

References _currentBidPrice.

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

inline

Retrieve the Bid-Price Vector.

Definition at line 134 of file SegmentCabin.hpp.

References _bidPriceVector.

const bool stdair::SegmentCabin::getFareFamilyStatus ( ) const

inline

Retrieve the status of fare family.

Definition at line 139 of file SegmentCabin.hpp.

References _fareFamilyActivation.

const PolicyList_T& stdair::SegmentCabin::getConvexHull ( ) const

inline

Retrieve the convex hull.

Definition at line 144 of file SegmentCabin.hpp.

References _convexHull.

void stdair::SegmentCabin::setSegmentSnapshotTable ( SegmentSnapshotTable &  ioTable )

inline

Set the snapshot table.

Definition at line 151 of file SegmentCabin.hpp.

References _segmentSnapshotTable.

void stdair::SegmentCabin::setCapacity ( const CabinCapacity_T &  iCapacity )

inline

Set the cabin capacity.

Definition at line 156 of file SegmentCabin.hpp.

References _capacity.

void stdair::SegmentCabin::setBlockSpace ( const BlockSpace_T &  iBlockSpace )

inline

Set the blocked number of seats.

Definition at line 161 of file SegmentCabin.hpp.

References _blockSpace.

void stdair::SegmentCabin::setMIN ( const BlockSpace_T &  iMIN )

inline

Set the blocked number of seats.

Definition at line 166 of file SegmentCabin.hpp.

References _min.

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

inline

Set the Unsold Protection (UPR).

Definition at line 171 of file SegmentCabin.hpp.

References _upr.

void stdair::SegmentCabin::setBookingCounter ( const NbOfBookings_T &  iBookingCounter )

inline

Set the total number of bookings.

Definition at line 176 of file SegmentCabin.hpp.

References _bookingCounter.

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

inline

Set the value of committed space.

Definition at line 181 of file SegmentCabin.hpp.

References _committedSpace.

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

inline

Set the value of availability pool.

Definition at line 186 of file SegmentCabin.hpp.

References _availabilityPool.

void stdair::SegmentCabin::setBidPriceVector ( const BidPriceVector_T &  iBPV )

inline

Set the Bid-Price Vector.

Definition at line 191 of file SegmentCabin.hpp.

References _bidPriceVector.

void stdair::SegmentCabin::activateFareFamily ( )

inline

Activate fare family.

Definition at line 196 of file SegmentCabin.hpp.

References _fareFamilyActivation.

void stdair::SegmentCabin::updateFromReservation

(

const NbOfBookings_T &

iNbOfBookings

)

Register a sale.

Definition at line 85 of file SegmentCabin.cpp.

References _committedSpace.

void stdair::SegmentCabin::resetConvexHull ( )

inline

Reset the convex hull.

Definition at line 206 of file SegmentCabin.hpp.

References _convexHull.

void stdair::SegmentCabin::addPolicy

(

Policy &

ioPolicy

)

Add a policy to the convex hull. Note: we do not use the FacBomManager here because the convex hull is not a list of children but a temporary list of policies.

Definition at line 90 of file SegmentCabin.cpp.

References _convexHull.

void stdair::SegmentCabin::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 221 of file SegmentCabin.hpp.

References toString().

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

inlinevirtual

Read a Business Object from an input stream.

Parameters

istream&

the input stream.

Implements stdair::BomAbstract.

Definition at line 230 of file SegmentCabin.hpp.

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

virtual

Get the serialised version of the Business Object.

Implements stdair::BomAbstract.

Definition at line 65 of file SegmentCabin.cpp.

References describeKey().

Referenced by toStream().

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

inline

Get a string describing the key.

Definition at line 241 of file SegmentCabin.hpp.

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

Referenced by toString().

const std::string stdair::SegmentCabin::describeConvexHull

(

)

const

Get a string describing the convex hull.

Definition at line 72 of file SegmentCabin.cpp.

References _convexHull, and stdair::Policy::toString().

template<class Archive >

void stdair::SegmentCabin::serialize	(	Archive &	ar,
		const unsigned int	iFileVersion
	)

Serialisation.

Definition at line 229 of file CmdBomSerialiser.cpp.

References _key.

Friends And Related Function Documentation

template<typename BOM >

friend class FacBom

friend

Definition at line 34 of file SegmentCabin.hpp.

template<typename BOM >

friend class FacCloneBom

friend

Definition at line 35 of file SegmentCabin.hpp.

friend class FacBomManager

friend

Definition at line 36 of file SegmentCabin.hpp.

friend class boost::serialization::access

friend

Definition at line 37 of file SegmentCabin.hpp.

Member Data Documentation

Key_T stdair::SegmentCabin::_key

protected

Primary key (cabin code).

Definition at line 300 of file SegmentCabin.hpp.

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

BomAbstract* stdair::SegmentCabin::_parent

protected

Pointer on the parent class (SegmentDate).

Definition at line 305 of file SegmentCabin.hpp.

Referenced by getParent().

HolderMap_T stdair::SegmentCabin::_holderMap

protected

Map holding the children (FareFamily or BookingClass objects).

Definition at line 310 of file SegmentCabin.hpp.

Referenced by getHolderMap().

SegmentSnapshotTable* stdair::SegmentCabin::_segmentSnapshotTable

protected

The data table used for Revenue Management activities.

Definition at line 315 of file SegmentCabin.hpp.

Referenced by getSegmentSnapshotTable(), and setSegmentSnapshotTable().

CabinCapacity_T stdair::SegmentCabin::_capacity

protected

Capacity of the cabin.

Definition at line 318 of file SegmentCabin.hpp.

Referenced by getCapacity(), and setCapacity().

BlockSpace_T stdair::SegmentCabin::_blockSpace

protected

Blocked capacity.

Definition at line 321 of file SegmentCabin.hpp.

Referenced by getBlockSpace(), and setBlockSpace().

BlockSpace_T stdair::SegmentCabin::_min

protected

Blocked number of seats.

Definition at line 324 of file SegmentCabin.hpp.

Referenced by getMIN(), and setMIN().

UPR_T stdair::SegmentCabin::_upr

protected

Unsold Protection (UPR).

Definition at line 327 of file SegmentCabin.hpp.

Referenced by getUPR(), and setUPR().

NbOfBookings_T stdair::SegmentCabin::_bookingCounter

protected

Aggregated number of bookings.

Definition at line 330 of file SegmentCabin.hpp.

Referenced by getBookingCounter(), and setBookingCounter().

CommittedSpace_T stdair::SegmentCabin::_committedSpace

protected

Aggreated committed space.

Definition at line 333 of file SegmentCabin.hpp.

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

Availability_T stdair::SegmentCabin::_availabilityPool

protected

Aggregated availability pool.

Definition at line 336 of file SegmentCabin.hpp.

Referenced by getAvailabilityPool(), and setAvailabilityPool().

BidPriceVector_T stdair::SegmentCabin::_bidPriceVector

protected

Bid-Price Vector (BPV).

Definition at line 339 of file SegmentCabin.hpp.

Referenced by getBidPriceVector(), and setBidPriceVector().

BidPrice_T stdair::SegmentCabin::_currentBidPrice

protected

Current Bid-Price (BP).

Definition at line 342 of file SegmentCabin.hpp.

Referenced by getCurrentBidPrice().

bool stdair::SegmentCabin::_fareFamilyActivation

protected

Indicate if fare family is in use.

Definition at line 345 of file SegmentCabin.hpp.

Referenced by activateFareFamily(), and getFareFamilyStatus().

PolicyList_T stdair::SegmentCabin::_convexHull

protected

The convex hull of MRT.

Definition at line 348 of file SegmentCabin.hpp.

Referenced by addPolicy(), describeConvexHull(), getConvexHull(), and resetConvexHull().

---

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

• stdair/bom/SegmentCabin.hpp
• stdair/bom/SegmentCabin.cpp
• stdair/command/CmdBomSerialiser.cpp