AirSched Logo  0.1.4
C++ Simulated Airline Schedule Manager Library
AIRSCHED::SegmentPathPeriodKey Struct Reference

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

#include <airsched/bom/SegmentPathPeriodKey.hpp>

Inheritance diagram for AIRSCHED::SegmentPathPeriodKey:

List of all members.

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_TgetBoardingDateOffsetList () 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

AIRSCHED::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.

AIRSCHED::SegmentPathPeriodKey::SegmentPathPeriodKey ( )

Default constructor.

Definition at line 22 of file SegmentPathPeriodKey.cpp.

AIRSCHED::SegmentPathPeriodKey::SegmentPathPeriodKey ( const SegmentPathPeriodKey iSPPK)

Copy constructor.

Definition at line 30 of file SegmentPathPeriodKey.cpp.

AIRSCHED::SegmentPathPeriodKey::~SegmentPathPeriodKey ( )

Destructor.

Definition at line 53 of file SegmentPathPeriodKey.cpp.


Member Function Documentation

const stdair::PeriodStruct& AIRSCHED::SegmentPathPeriodKey::getPeriod ( ) const [inline]

Get the active days-of-week.

Definition at line 68 of file SegmentPathPeriodKey.hpp.

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

const DateOffsetList_T& AIRSCHED::SegmentPathPeriodKey::getBoardingDateOffsetList ( ) const [inline]

Get the list of boarding date off-sets.

Definition at line 75 of file SegmentPathPeriodKey.hpp.

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

const stdair::NbOfSegments_T AIRSCHED::SegmentPathPeriodKey::getNbOfSegments ( ) const [inline]

Get the number of segments.

Definition at line 82 of file SegmentPathPeriodKey.hpp.

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

const stdair::NbOfAirlines_T& AIRSCHED::SegmentPathPeriodKey::getNbOfAirlines ( ) const [inline]

Get the number of airlines.

Definition at line 89 of file SegmentPathPeriodKey.hpp.

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

const stdair::Duration_T& AIRSCHED::SegmentPathPeriodKey::getElapsedTime ( ) const [inline]

Get the elapsed time.

Definition at line 96 of file SegmentPathPeriodKey.hpp.

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

const stdair::Duration_T& AIRSCHED::SegmentPathPeriodKey::getBoardingTime ( ) const [inline]

Get the boarding time.

Definition at line 103 of file SegmentPathPeriodKey.hpp.

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

void AIRSCHED::SegmentPathPeriodKey::setPeriod ( const stdair::PeriodStruct &  iPeriod) [inline]

Set the active days-of-week.

Definition at line 111 of file SegmentPathPeriodKey.hpp.

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

void AIRSCHED::SegmentPathPeriodKey::setBoardingDateOffsetList ( const DateOffsetList_T iList) [inline]
void AIRSCHED::SegmentPathPeriodKey::setNbOfAirlines ( const stdair::NbOfAirlines_T &  iNbOfAirlines) [inline]

Set the number of airlines.

Definition at line 120 of file SegmentPathPeriodKey.hpp.

void AIRSCHED::SegmentPathPeriodKey::setElapsedTime ( const stdair::Duration_T &  iElapsed) [inline]

Set the elapsed time.

Definition at line 125 of file SegmentPathPeriodKey.hpp.

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

void AIRSCHED::SegmentPathPeriodKey::setBoardingTime ( const stdair::Duration_T &  iBoardingTime) [inline]

Set the boarding time.

Definition at line 130 of file SegmentPathPeriodKey.hpp.

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

const bool AIRSCHED::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 AIRSCHED::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 AIRSCHED::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 AIRSCHED::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 AIRSCHED::SegmentPathPeriod::describeKey(), toStream(), and AIRSCHED::SegmentPathPeriod::toString().

template<class Archive >
void AIRSCHED::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: