AIRTSP::SegmentPathPeriodKey Struct Reference

Structure representing the key of a segment/path. More...

#include <airtsp/bom/SegmentPathPeriodKey.hpp>

Inheritance diagram for AIRTSP::SegmentPathPeriodKey:

Public Member Functions
	SegmentPathPeriodKey (const stdair::PeriodStruct &, const stdair::Duration_T &iBoardingTime, const stdair::Duration_T &iElapsed, const DateOffsetList_T &, const stdair::NbOfAirlines_T &)
	SegmentPathPeriodKey ()
	SegmentPathPeriodKey (const SegmentPathPeriodKey &)
	~SegmentPathPeriodKey ()
const stdair::PeriodStruct &	getPeriod () const
const DateOffsetList_T &	getBoardingDateOffsetList () const
const stdair::NbOfSegments_T	getNbOfSegments () const
const stdair::NbOfAirlines_T &	getNbOfAirlines () const
const stdair::Duration_T &	getElapsedTime () const
const stdair::Duration_T &	getBoardingTime () const
void	setPeriod (const stdair::PeriodStruct &iPeriod)
void	setBoardingDateOffsetList (const DateOffsetList_T &iList)
void	setNbOfAirlines (const stdair::NbOfAirlines_T &iNbOfAirlines)
void	setElapsedTime (const stdair::Duration_T &iElapsed)
void	setBoardingTime (const stdair::Duration_T &iBoardingTime)
const bool	isValid () const
void	toStream (std::ostream &ioOut) const
void	fromStream (std::istream &ioIn)
const std::string	toString () const
template<class Archive >
void	serialize (Archive &ar, const unsigned int iFileVersion)

Friends
class	boost::serialization::access

Detailed Description

Structure representing the key of a segment/path.

That key specifies a travel solution from a geographical point (origin airport) to another (destination airport).

Definition at line 33 of file SegmentPathPeriodKey.hpp.

Constructor & Destructor Documentation

AIRTSP::SegmentPathPeriodKey::SegmentPathPeriodKey	(	const stdair::PeriodStruct &	iPeriod,
		const stdair::Duration_T &	iBoardingTime,
		const stdair::Duration_T &	iElapsed,
		const DateOffsetList_T &	iBoardingDateOffsetList,
		const stdair::NbOfAirlines_T &	iNbOfAirlines
	)

Constructor.

Definition at line 40 of file SegmentPathPeriodKey.cpp.

AIRTSP::SegmentPathPeriodKey::SegmentPathPeriodKey

(

)

Default constructor.

Definition at line 22 of file SegmentPathPeriodKey.cpp.

AIRTSP::SegmentPathPeriodKey::SegmentPathPeriodKey

(

const SegmentPathPeriodKey &

iSPPK

)

Copy constructor.

Definition at line 30 of file SegmentPathPeriodKey.cpp.

AIRTSP::SegmentPathPeriodKey::~SegmentPathPeriodKey

(

)

Destructor.

Definition at line 53 of file SegmentPathPeriodKey.cpp.

Member Function Documentation

const stdair::PeriodStruct& AIRTSP::SegmentPathPeriodKey::getPeriod ( ) const

inline

Get the active days-of-week.

Definition at line 68 of file SegmentPathPeriodKey.hpp.

Referenced by AIRTSP::SegmentPathPeriod::getDeparturePeriod().

const DateOffsetList_T& AIRTSP::SegmentPathPeriodKey::getBoardingDateOffsetList ( ) const

inline

Get the list of boarding date off-sets.

Definition at line 75 of file SegmentPathPeriodKey.hpp.

Referenced by AIRTSP::SegmentPathPeriod::getBoardingDateOffsetList().

const stdair::NbOfSegments_T AIRTSP::SegmentPathPeriodKey::getNbOfSegments ( ) const

inline

Get the number of segments.

Definition at line 82 of file SegmentPathPeriodKey.hpp.

Referenced by AIRTSP::SegmentPathPeriod::getNbOfSegments().

const stdair::NbOfAirlines_T& AIRTSP::SegmentPathPeriodKey::getNbOfAirlines ( ) const

inline

Get the number of airlines.

Definition at line 89 of file SegmentPathPeriodKey.hpp.

Referenced by AIRTSP::SegmentPathPeriod::getNbOfAirlines().

const stdair::Duration_T& AIRTSP::SegmentPathPeriodKey::getElapsedTime ( ) const

inline

Get the elapsed time.

Definition at line 96 of file SegmentPathPeriodKey.hpp.

Referenced by AIRTSP::SegmentPathPeriod::getElapsedTime().

const stdair::Duration_T& AIRTSP::SegmentPathPeriodKey::getBoardingTime ( ) const

inline

Get the boarding time.

Definition at line 103 of file SegmentPathPeriodKey.hpp.

Referenced by AIRTSP::SegmentPathPeriod::getBoardingTime().

void AIRTSP::SegmentPathPeriodKey::setPeriod ( const stdair::PeriodStruct &  iPeriod )

inline

Set the active days-of-week.

Definition at line 111 of file SegmentPathPeriodKey.hpp.

Referenced by AIRTSP::SegmentPathPeriod::connectWithAnotherSegment().

void AIRTSP::SegmentPathPeriodKey::setBoardingDateOffsetList ( const DateOffsetList_T &  iList )

inline

Definition at line 115 of file SegmentPathPeriodKey.hpp.

Referenced by AIRTSP::SegmentPathPeriod::connectWithAnotherSegment().

void AIRTSP::SegmentPathPeriodKey::setNbOfAirlines ( const stdair::NbOfAirlines_T &  iNbOfAirlines )

inline

Set the number of airlines.

Definition at line 120 of file SegmentPathPeriodKey.hpp.

void AIRTSP::SegmentPathPeriodKey::setElapsedTime ( const stdair::Duration_T &  iElapsed )

inline

Set the elapsed time.

Definition at line 125 of file SegmentPathPeriodKey.hpp.

Referenced by AIRTSP::SegmentPathPeriod::connectWithAnotherSegment().

void AIRTSP::SegmentPathPeriodKey::setBoardingTime ( const stdair::Duration_T &  iBoardingTime )

inline

Set the boarding time.

Definition at line 130 of file SegmentPathPeriodKey.hpp.

Referenced by AIRTSP::SegmentPathPeriod::connectWithAnotherSegment().

const bool AIRTSP::SegmentPathPeriodKey::isValid ( ) const

inline

Check if the key is valid (i.e. the departure period is valid).

Definition at line 138 of file SegmentPathPeriodKey.hpp.

void AIRTSP::SegmentPathPeriodKey::toStream

(

std::ostream &

ioOut

)

const

Dump a Business Object Key into an output stream.

Parameters

ostream&

the output stream.

Definition at line 57 of file SegmentPathPeriodKey.cpp.

References toString().

void AIRTSP::SegmentPathPeriodKey::fromStream

(

std::istream &

ioIn

)

Read a Business Object Key from an input stream.

Parameters

istream&

the input stream.

Definition at line 62 of file SegmentPathPeriodKey.cpp.

const std::string AIRTSP::SegmentPathPeriodKey::toString

(

)

const

Get the serialised version of the Business Object Key.

That string is unique, at the level of a given Business Object, when among children of a given parent Business Object.

For instance, "H" and "K" allow to differentiate among two marketing classes for the same segment-date.

Definition at line 66 of file SegmentPathPeriodKey.cpp.

Referenced by AIRTSP::SegmentPathPeriod::describeKey(), toStream(), and AIRTSP::SegmentPathPeriod::toString().

template<class Archive >

void AIRTSP::SegmentPathPeriodKey::serialize	(	Archive &	ar,
		const unsigned int	iFileVersion
	)

Serialisation.

Definition at line 98 of file SegmentPathPeriodKey.cpp.

Friends And Related Function Documentation

friend class boost::serialization::access

friend

Definition at line 34 of file SegmentPathPeriodKey.hpp.

---

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

• airtsp/bom/SegmentPathPeriodKey.hpp
• airtsp/bom/SegmentPathPeriodKey.cpp