TRADEMGEN::DemandCharacteristics Struct Reference

Class modeling the characteristics of a demand type. More...

#include <trademgen/basic/DemandCharacteristics.hpp>

Inheritance diagram for TRADEMGEN::DemandCharacteristics:

Public Member Functions
const stdair::AirportCode_T &	getPOSValue (const stdair::Probability_T &iCumulativeProbability) const
bool	checkPOSValue (const stdair::AirportCode_T &iPOS) const
const std::string	describe () const
	DemandCharacteristics (const ArrivalPatternCumulativeDistribution_T &, const POSProbabilityMassFunction_T &, const ChannelProbabilityMassFunction_T &, const TripTypeProbabilityMassFunction_T &, const StayDurationProbabilityMassFunction_T &, const FrequentFlyerProbabilityMassFunction_T &, const stdair::ChangeFeesRatio_T &, const stdair::Disutility_T &, const stdair::NonRefundableRatio_T &, const stdair::Disutility_T &, const PreferredDepartureTimeContinuousDistribution_T &, const stdair::WTP_T &, const ValueOfTimeContinuousDistribution_T &)
	DemandCharacteristics ()
	DemandCharacteristics (const DemandCharacteristics &)
	~DemandCharacteristics ()

Public Attributes
ContinuousFloatDuration_T	_arrivalPattern
POSProbabilityMass_T	_posProbabilityMass
ChannelProbabilityMass_T	_channelProbabilityMass
TripTypeProbabilityMass_T	_tripTypeProbabilityMass
StayDurationProbabilityMass_T	_stayDurationProbabilityMass
FrequentFlyerProbabilityMass_T	_frequentFlyerProbabilityMass
stdair::ChangeFeesRatio_T	_changeFeeProb
stdair::Disutility_T	_changeFeeDisutility
stdair::NonRefundableRatio_T	_nonRefundableProb
stdair::Disutility_T	_nonRefundableDisutility
PreferredDepartureTimeCumulativeDistribution_T	_preferredDepartureTimeCumulativeDistribution
stdair::WTP_T	_minWTP
CumulativeDistribution_T	_frat5Pattern
ValueOfTimeCumulativeDistribution_T	_valueOfTimeCumulativeDistribution

Detailed Description

Class modeling the characteristics of a demand type.

Definition at line 21 of file DemandCharacteristics.hpp.

Constructor & Destructor Documentation

DemandCharacteristics() [1/3]

TRADEMGEN::DemandCharacteristics::DemandCharacteristics	(	const ArrivalPatternCumulativeDistribution_T &	iArrivalPattern,
		const POSProbabilityMassFunction_T &	iPOSProbMass,
		const ChannelProbabilityMassFunction_T &	iChannelProbMass,
		const TripTypeProbabilityMassFunction_T &	iTripTypeProbMass,
		const StayDurationProbabilityMassFunction_T &	iStayDurationProbMass,
		const FrequentFlyerProbabilityMassFunction_T &	iFrequentFlyerProbMass,
		const stdair::ChangeFeesRatio_T &	iChangeFeeProb,
		const stdair::Disutility_T &	iChangeFeeDisutility,
		const stdair::NonRefundableRatio_T &	iNonRefundableProb,
		const stdair::Disutility_T &	iNonRefundableDisutility,
		const PreferredDepartureTimeContinuousDistribution_T &	iPreferredDepartureTimeContinuousDistribution,
		const stdair::WTP_T &	iMinWTP,
		const ValueOfTimeContinuousDistribution_T &	iValueOfTimeContinuousDistribution )

Constructor.

Definition at line 49 of file DemandCharacteristics.cpp.

References _arrivalPattern, _changeFeeDisutility, _changeFeeProb, _channelProbabilityMass, _frat5Pattern, _frequentFlyerProbabilityMass, _minWTP, _nonRefundableDisutility, _nonRefundableProb, _posProbabilityMass, _preferredDepartureTimeCumulativeDistribution, _stayDurationProbabilityMass, _tripTypeProbabilityMass, _valueOfTimeCumulativeDistribution, and TRADEMGEN::DEFAULT_FRAT5_PATTERN.

Referenced by DemandCharacteristics().

DemandCharacteristics() [2/3]

TRADEMGEN::DemandCharacteristics::DemandCharacteristics

(

)

Default constructor.

Definition at line 16 of file DemandCharacteristics.cpp.

References _arrivalPattern, _changeFeeDisutility, _changeFeeProb, _channelProbabilityMass, _frat5Pattern, _frequentFlyerProbabilityMass, _minWTP, _nonRefundableDisutility, _nonRefundableProb, _posProbabilityMass, _preferredDepartureTimeCumulativeDistribution, _stayDurationProbabilityMass, _tripTypeProbabilityMass, _valueOfTimeCumulativeDistribution, and TRADEMGEN::DEFAULT_FRAT5_PATTERN.

Referenced by TRADEMGEN::DemandStream::setDemandCharacteristics().

DemandCharacteristics() [3/3]

TRADEMGEN::DemandCharacteristics::DemandCharacteristics

(

const DemandCharacteristics &

iDC

)

Copy constructor.

Definition at line 31 of file DemandCharacteristics.cpp.

References _arrivalPattern, _changeFeeDisutility, _changeFeeProb, _channelProbabilityMass, _frat5Pattern, _frequentFlyerProbabilityMass, _minWTP, _nonRefundableDisutility, _nonRefundableProb, _posProbabilityMass, _preferredDepartureTimeCumulativeDistribution, _stayDurationProbabilityMass, _tripTypeProbabilityMass, _valueOfTimeCumulativeDistribution, and DemandCharacteristics().

~DemandCharacteristics()

TRADEMGEN::DemandCharacteristics::~DemandCharacteristics

(

)

Destructor.

Definition at line 79 of file DemandCharacteristics.cpp.

Member Function Documentation

getPOSValue()

const stdair::AirportCode_T & TRADEMGEN::DemandCharacteristics::getPOSValue

(

const stdair::Probability_T &

iCumulativeProbability

)

const

Get the POS corresponding to the cumulative probability

Definition at line 83 of file DemandCharacteristics.cpp.

References _posProbabilityMass, and TRADEMGEN::CategoricalAttributeLite< T >::getValue().

Referenced by TRADEMGEN::DemandStream::generatePOS().

checkPOSValue()

bool TRADEMGEN::DemandCharacteristics::checkPOSValue

(

const stdair::AirportCode_T &

iPOS

)

const

Check that the POS is within the distribution.

Definition at line 89 of file DemandCharacteristics.cpp.

References _posProbabilityMass, and TRADEMGEN::CategoricalAttributeLite< T >::checkValue().

describe()

const std::string TRADEMGEN::DemandCharacteristics::describe

(

)

const

Give a description of the structure (for display purposes).

Definition at line 95 of file DemandCharacteristics.cpp.

References _arrivalPattern, _changeFeeDisutility, _changeFeeProb, _channelProbabilityMass, _frequentFlyerProbabilityMass, _minWTP, _nonRefundableDisutility, _nonRefundableProb, _posProbabilityMass, _preferredDepartureTimeCumulativeDistribution, _stayDurationProbabilityMass, _tripTypeProbabilityMass, _valueOfTimeCumulativeDistribution, TRADEMGEN::ContinuousAttributeLite< T >::displayCumulativeDistribution(), and TRADEMGEN::CategoricalAttributeLite< T >::displayProbabilityMass().

Referenced by TRADEMGEN::DemandStream::display().

Member Data Documentation

_arrivalPattern

ContinuousFloatDuration_T TRADEMGEN::DemandCharacteristics::_arrivalPattern

Arrival pattern (cumulative distribution of timing of arrival of requests (negative number of days between departure date and request date).

Definition at line 87 of file DemandCharacteristics.hpp.

Referenced by DemandCharacteristics(), DemandCharacteristics(), DemandCharacteristics(), describe(), TRADEMGEN::DemandStream::generateTimeOfRequestPoissonProcess(), and TRADEMGEN::DemandStream::generateTimeOfRequestStatisticsOrder().

_posProbabilityMass

POSProbabilityMass_T TRADEMGEN::DemandCharacteristics::_posProbabilityMass

POS probability mass.

Definition at line 92 of file DemandCharacteristics.hpp.

Referenced by checkPOSValue(), DemandCharacteristics(), DemandCharacteristics(), DemandCharacteristics(), describe(), and getPOSValue().

_channelProbabilityMass

ChannelProbabilityMass_T TRADEMGEN::DemandCharacteristics::_channelProbabilityMass

Channel probability mass.

Definition at line 97 of file DemandCharacteristics.hpp.

Referenced by DemandCharacteristics(), DemandCharacteristics(), DemandCharacteristics(), describe(), and TRADEMGEN::DemandStream::generateChannel().

_tripTypeProbabilityMass

TripTypeProbabilityMass_T TRADEMGEN::DemandCharacteristics::_tripTypeProbabilityMass

Trip type probability mass.

Definition at line 102 of file DemandCharacteristics.hpp.

Referenced by DemandCharacteristics(), DemandCharacteristics(), DemandCharacteristics(), describe(), and TRADEMGEN::DemandStream::generateTripType().

_stayDurationProbabilityMass

StayDurationProbabilityMass_T TRADEMGEN::DemandCharacteristics::_stayDurationProbabilityMass

Stay duration probability mass.

Definition at line 107 of file DemandCharacteristics.hpp.

Referenced by DemandCharacteristics(), DemandCharacteristics(), DemandCharacteristics(), describe(), and TRADEMGEN::DemandStream::generateStayDuration().

_frequentFlyerProbabilityMass

FrequentFlyerProbabilityMass_T TRADEMGEN::DemandCharacteristics::_frequentFlyerProbabilityMass

Frequent flyer probability mass.

Definition at line 112 of file DemandCharacteristics.hpp.

Referenced by DemandCharacteristics(), DemandCharacteristics(), DemandCharacteristics(), describe(), and TRADEMGEN::DemandStream::generateFrequentFlyer().

_changeFeeProb

stdair::ChangeFeesRatio_T TRADEMGEN::DemandCharacteristics::_changeFeeProb

Change fee restriction acceptation probability.

Definition at line 117 of file DemandCharacteristics.hpp.

Referenced by DemandCharacteristics(), DemandCharacteristics(), DemandCharacteristics(), describe(), and TRADEMGEN::DemandStream::generateChangeFees().

_changeFeeDisutility

stdair::Disutility_T TRADEMGEN::DemandCharacteristics::_changeFeeDisutility

Change fee disutility.

Definition at line 122 of file DemandCharacteristics.hpp.

Referenced by DemandCharacteristics(), DemandCharacteristics(), DemandCharacteristics(), describe(), TRADEMGEN::DemandStream::generateNextRequest(), and TRADEMGEN::DemandStream::getChangeFeeDisutility().

_nonRefundableProb

stdair::NonRefundableRatio_T TRADEMGEN::DemandCharacteristics::_nonRefundableProb

Non refundable restriction acceptation probability.

Definition at line 127 of file DemandCharacteristics.hpp.

Referenced by DemandCharacteristics(), DemandCharacteristics(), DemandCharacteristics(), describe(), and TRADEMGEN::DemandStream::generateNonRefundable().

_nonRefundableDisutility

stdair::Disutility_T TRADEMGEN::DemandCharacteristics::_nonRefundableDisutility

Non refundable disutility.

Definition at line 132 of file DemandCharacteristics.hpp.

Referenced by DemandCharacteristics(), DemandCharacteristics(), DemandCharacteristics(), describe(), TRADEMGEN::DemandStream::generateNextRequest(), and TRADEMGEN::DemandStream::getNonRefundableDisutility().

_preferredDepartureTimeCumulativeDistribution

PreferredDepartureTimeCumulativeDistribution_T TRADEMGEN::DemandCharacteristics::_preferredDepartureTimeCumulativeDistribution

Preferred departure time cumulative distribution.

Definition at line 137 of file DemandCharacteristics.hpp.

Referenced by DemandCharacteristics(), DemandCharacteristics(), DemandCharacteristics(), and describe().

_minWTP

stdair::WTP_T TRADEMGEN::DemandCharacteristics::_minWTP

Min Willingness-to-pay, used for the computation of the WTP of each request.

Definition at line 143 of file DemandCharacteristics.hpp.

Referenced by DemandCharacteristics(), DemandCharacteristics(), DemandCharacteristics(), describe(), and TRADEMGEN::DemandStream::generateWTP().

_frat5Pattern

CumulativeDistribution_T TRADEMGEN::DemandCharacteristics::_frat5Pattern

FRAT5 pattern, used for the computation of WTP.

Definition at line 148 of file DemandCharacteristics.hpp.

Referenced by DemandCharacteristics(), DemandCharacteristics(), DemandCharacteristics(), and TRADEMGEN::DemandStream::generateWTP().

_valueOfTimeCumulativeDistribution

ValueOfTimeCumulativeDistribution_T TRADEMGEN::DemandCharacteristics::_valueOfTimeCumulativeDistribution

Value of time cumulative distribution.

Definition at line 153 of file DemandCharacteristics.hpp.

Referenced by DemandCharacteristics(), DemandCharacteristics(), DemandCharacteristics(), describe(), and TRADEMGEN::DemandStream::generateValueOfTime().

---

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

• trademgen/basic/DemandCharacteristics.hpp
• trademgen/basic/DemandCharacteristics.cpp