AirTSP Logo  1.01.0
C++ Simulated Airline Travel Solution Provider Library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
AIRTSP::OriginDestinationSet Class Reference

Class representing a simple sub-network. More...

#include <airtsp/bom/OriginDestinationSet.hpp>

+ Inheritance diagram for AIRTSP::OriginDestinationSet:

Public Types

typedef OriginDestinationSetKey Key_T
 

Public Member Functions

const Key_TgetKey () const
 
const stdair::AirportCode_T & getDestination () const
 
stdair::BomAbstract *const getParent () const
 
const stdair::HolderMap_T & getHolderMap () const
 
void toStream (std::ostream &ioOut) const
 
void fromStream (std::istream &ioIn)
 
std::string toString () const
 
const std::string describeKey () const
 
template<class Archive >
void serialize (Archive &ar, const unsigned int iFileVersion)
 

Protected Member Functions

 OriginDestinationSet (const Key_T &)
 
 ~OriginDestinationSet ()
 

Protected Attributes

Key_T _key
 
stdair::BomAbstract * _parent
 
stdair::HolderMap_T _holderMap
 

Friends

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

Detailed Description

Class representing a simple sub-network.

That simple sub-network is made of a set of segments (SegmentPathPeriod objects), from the origin airport specified within ReachableUniverse (parent object) to the destination specified in the OriginDestinationSetKey object.

Each segment (composing that OriginDestinationSet object) corresponds to an actual travel solution from the origin to the destination, that is, a path that a traveller can take with actual scheduled flights.

Definition at line 44 of file OriginDestinationSet.hpp.

Member Typedef Documentation

Definition allowing to retrieve the associated BOM key type.

Definition at line 57 of file OriginDestinationSet.hpp.

Constructor & Destructor Documentation

AIRTSP::OriginDestinationSet::OriginDestinationSet ( const Key_T iKey)
protected

Main constructor.

Definition at line 31 of file OriginDestinationSet.cpp.

AIRTSP::OriginDestinationSet::~OriginDestinationSet ( )
protected

Destructor.

Definition at line 36 of file OriginDestinationSet.cpp.

Member Function Documentation

const Key_T& AIRTSP::OriginDestinationSet::getKey ( ) const
inline

Get the primary key (destination airport).

Definition at line 65 of file OriginDestinationSet.hpp.

References _key.

const stdair::AirportCode_T& AIRTSP::OriginDestinationSet::getDestination ( ) const
inline

Get the destination airport (i.e., the primary key).

Definition at line 72 of file OriginDestinationSet.hpp.

References _key, and AIRTSP::OriginDestinationSetKey::getOffPoint().

stdair::BomAbstract* const AIRTSP::OriginDestinationSet::getParent ( ) const
inline

Get the parent (i.e., ReachableUniverse) object.

Definition at line 79 of file OriginDestinationSet.hpp.

References _parent.

const stdair::HolderMap_T& AIRTSP::OriginDestinationSet::getHolderMap ( ) const
inline

Get the map of children holders (SegmentPathPeriod objects).

Definition at line 86 of file OriginDestinationSet.hpp.

References _holderMap.

void AIRTSP::OriginDestinationSet::toStream ( std::ostream &  ioOut) const
inline

Dump a Business Object into an output stream.

Parameters
ostream&the output stream.

Definition at line 98 of file OriginDestinationSet.hpp.

References toString().

void AIRTSP::OriginDestinationSet::fromStream ( std::istream &  ioIn)
inline

Read a Business Object from an input stream.

Parameters
istream&the input stream.

Definition at line 107 of file OriginDestinationSet.hpp.

std::string AIRTSP::OriginDestinationSet::toString ( ) const

Get the serialised version of the Business Object.

Definition at line 40 of file OriginDestinationSet.cpp.

References _key, and AIRTSP::OriginDestinationSetKey::toString().

Referenced by toStream().

const std::string AIRTSP::OriginDestinationSet::describeKey ( ) const
inline

Get a string describing the key.

Definition at line 118 of file OriginDestinationSet.hpp.

References _key, and AIRTSP::OriginDestinationSetKey::toString().

template<class Archive >
void AIRTSP::OriginDestinationSet::serialize ( Archive &  ar,
const unsigned int  iFileVersion 
)

Serialisation.

Definition at line 62 of file OriginDestinationSet.cpp.

References _key.

Friends And Related Function Documentation

template<typename BOM >
friend class stdair::FacBom
friend

Friend classes.

Definition at line 48 of file OriginDestinationSet.hpp.

friend class stdair::FacBomManager
friend

Definition at line 49 of file OriginDestinationSet.hpp.

friend class boost::serialization::access
friend

Definition at line 50 of file OriginDestinationSet.hpp.

Member Data Documentation

Key_T AIRTSP::OriginDestinationSet::_key
protected

Primary key (destination airport code).

Definition at line 168 of file OriginDestinationSet.hpp.

Referenced by describeKey(), getDestination(), getKey(), serialize(), and toString().

stdair::BomAbstract* AIRTSP::OriginDestinationSet::_parent
protected

Pointer on the parent (ReachableUniverse) object.

Definition at line 173 of file OriginDestinationSet.hpp.

Referenced by getParent().

stdair::HolderMap_T AIRTSP::OriginDestinationSet::_holderMap
protected

Map holding the children (SegmentPathPeriod objects).

Definition at line 178 of file OriginDestinationSet.hpp.

Referenced by getHolderMap().


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