AirSched Logo  0.1.4
C++ Simulated Airline Schedule Manager Library
AIRSCHED::ReachableUniverse Class Reference

Class representing the root of the schedule-related BOM tree. More...

#include <airsched/bom/ReachableUniverse.hpp>

Inheritance diagram for AIRSCHED::ReachableUniverse:

List of all members.

Public Types

typedef ReachableUniverseKey Key_T

Public Member Functions

const Key_TgetKey () const
const stdair::AirportCode_T & getOrigin () const
stdair::BomAbstract *const getParent () const
const stdair::HolderMap_T & getHolderMap () const
const SegmentPathPeriodListList_TgetSegmentPathPeriodListList () 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

 ReachableUniverse (const Key_T &)
 ~ReachableUniverse ()

Protected Attributes

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

Friends

class stdair::FacBom
class stdair::FacBomManager
class SegmentPathGenerator
class boost::serialization::access

Detailed Description

Class representing the root of the schedule-related BOM tree.

It is the pending, in the schedule universe, of the stdair::Inventory class. It corresponds to all the destinations, which can be reached from a given geographical point. That latter is an airport for now, and its key (airport code) is specified by the ReachableUniverseKey object.

Definition at line 41 of file ReachableUniverse.hpp.


Member Typedef Documentation

Definition allowing to retrieve the associated BOM key type.

Definition at line 55 of file ReachableUniverse.hpp.


Constructor & Destructor Documentation

AIRSCHED::ReachableUniverse::ReachableUniverse ( const Key_T iKey) [protected]

Main constructor.

Definition at line 32 of file ReachableUniverse.cpp.

AIRSCHED::ReachableUniverse::~ReachableUniverse ( ) [protected]

Destructor.

Definition at line 37 of file ReachableUniverse.cpp.


Member Function Documentation

const Key_T& AIRSCHED::ReachableUniverse::getKey ( ) const [inline]

Get the universe key (airport code representing the departure point of the "reachable universe").

Definition at line 63 of file ReachableUniverse.hpp.

References _key.

const stdair::AirportCode_T& AIRSCHED::ReachableUniverse::getOrigin ( ) const [inline]

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

Definition at line 70 of file ReachableUniverse.hpp.

References _key, and AIRSCHED::ReachableUniverseKey::getBoardingPoint().

stdair::BomAbstract* const AIRSCHED::ReachableUniverse::getParent ( ) const [inline]

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

Definition at line 77 of file ReachableUniverse.hpp.

References _parent.

const stdair::HolderMap_T& AIRSCHED::ReachableUniverse::getHolderMap ( ) const [inline]

Get the map of children holders (OriginDestinationSet objects).

Definition at line 84 of file ReachableUniverse.hpp.

References _holderMap.

const SegmentPathPeriodListList_T& AIRSCHED::ReachableUniverse::getSegmentPathPeriodListList ( ) const [inline]

Get the vector of SegmentPathPeriodLightList objects.

Definition at line 91 of file ReachableUniverse.hpp.

References _segmentPathPeriodListList.

void AIRSCHED::ReachableUniverse::toStream ( std::ostream &  ioOut) const [inline]

Dump a Business Object into an output stream.

Parameters:
ostream&the output stream.

Definition at line 103 of file ReachableUniverse.hpp.

References toString().

void AIRSCHED::ReachableUniverse::fromStream ( std::istream &  ioIn) [inline]

Read a Business Object from an input stream.

Parameters:
istream&the input stream.

Definition at line 112 of file ReachableUniverse.hpp.

std::string AIRSCHED::ReachableUniverse::toString ( ) const

Get the serialised version of the Business Object.

Definition at line 41 of file ReachableUniverse.cpp.

References _key, and AIRSCHED::ReachableUniverseKey::toString().

Referenced by AIRSCHED::BomDisplay::csvDisplay(), and toStream().

const std::string AIRSCHED::ReachableUniverse::describeKey ( ) const [inline]

Get a string describing the key.

Definition at line 123 of file ReachableUniverse.hpp.

References _key, and AIRSCHED::ReachableUniverseKey::toString().

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

Serialisation.

Definition at line 63 of file ReachableUniverse.cpp.

References _key.


Friends And Related Function Documentation

friend class stdair::FacBom [friend]

Friend classes.

Definition at line 45 of file ReachableUniverse.hpp.

friend class stdair::FacBomManager [friend]

Definition at line 46 of file ReachableUniverse.hpp.

friend class SegmentPathGenerator [friend]

Definition at line 47 of file ReachableUniverse.hpp.

friend class boost::serialization::access [friend]

Definition at line 48 of file ReachableUniverse.hpp.


Member Data Documentation

Primary key (origin airport code).

Definition at line 174 of file ReachableUniverse.hpp.

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

stdair::BomAbstract* AIRSCHED::ReachableUniverse::_parent [protected]

Pointer on the parent (BomRoot) object.

Definition at line 179 of file ReachableUniverse.hpp.

Referenced by getParent().

stdair::HolderMap_T AIRSCHED::ReachableUniverse::_holderMap [protected]

Map holding the children (OriginDestinationSet objects).

Definition at line 184 of file ReachableUniverse.hpp.

Referenced by getHolderMap().

The list (actually, a vector) of lists of SegmentPathPeriods, used solely for the construction of the main list of SegmentPathPeriods within the ReachableUniverseStructure.

Definition at line 191 of file ReachableUniverse.hpp.

Referenced by getSegmentPathPeriodListList().


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