TraDemGen Logo  1.00.0
C++ Simulated Travel Demand Generation Library
 All Classes Namespaces Files Functions Variables Typedefs Friends Pages
TRADEMGEN::DemandStreamKey Struct Reference

#include <trademgen/bom/DemandStreamKey.hpp>

+ Inheritance diagram for TRADEMGEN::DemandStreamKey:

List of all members.

Public Member Functions

 DemandStreamKey (const stdair::AirportCode_T &iOrigin, const stdair::AirportCode_T &iDestination, const stdair::Date_T &iPreferredDepartureDate, const stdair::CabinCode_T &iPreferredCabin)
 DemandStreamKey (const DemandStreamKey &)
 ~DemandStreamKey ()
const stdair::AirportCode_T & getOrigin () const
const stdair::AirportCode_T & getDestination () const
const stdair::Date_T & getPreferredDepartureDate () const
const stdair::CabinCode_T & getPreferredCabin () const
void toStream (std::ostream &ioOut) const
void fromStream (std::istream &ioIn)
const std::string toString () const

Detailed Description

Key of a given demand-stream, made of a pair of required airports/cities (origin and destination), a preferred departure date and a preferred cabin. Those attributes correspond to a the travel requirements of a simulated traveller.

Definition at line 20 of file DemandStreamKey.hpp.


Constructor & Destructor Documentation

TRADEMGEN::DemandStreamKey::DemandStreamKey ( const stdair::AirportCode_T &  iOrigin,
const stdair::AirportCode_T &  iDestination,
const stdair::Date_T &  iPreferredDepartureDate,
const stdair::CabinCode_T &  iPreferredCabin 
)

Constructor.

Definition at line 25 of file DemandStreamKey.cpp.

TRADEMGEN::DemandStreamKey::DemandStreamKey ( const DemandStreamKey iKey)

Default copy constructor.

Definition at line 35 of file DemandStreamKey.cpp.

TRADEMGEN::DemandStreamKey::~DemandStreamKey ( )

Destructor.

Definition at line 42 of file DemandStreamKey.cpp.


Member Function Documentation

const stdair::AirportCode_T& TRADEMGEN::DemandStreamKey::getOrigin ( ) const
inline

Get the origin.

Definition at line 43 of file DemandStreamKey.hpp.

Referenced by TRADEMGEN::DemandStream::generateNextRequest(), and TRADEMGEN::DemandStream::getOrigin().

const stdair::AirportCode_T& TRADEMGEN::DemandStreamKey::getDestination ( ) const
inline

Get the destination.

Definition at line 48 of file DemandStreamKey.hpp.

Referenced by TRADEMGEN::DemandStream::generateNextRequest(), and TRADEMGEN::DemandStream::getDestination().

const stdair::Date_T& TRADEMGEN::DemandStreamKey::getPreferredDepartureDate ( ) const
inline
const stdair::CabinCode_T& TRADEMGEN::DemandStreamKey::getPreferredCabin ( ) const
inline

Get the preferred cabin.

Definition at line 58 of file DemandStreamKey.hpp.

Referenced by TRADEMGEN::DemandStream::generateNextRequest(), and TRADEMGEN::DemandStream::getPreferredCabin().

void TRADEMGEN::DemandStreamKey::toStream ( std::ostream &  ioOut) const

Dump a Business Object Key into an output stream.

Parameters:
ostream&the output stream.

Definition at line 46 of file DemandStreamKey.cpp.

References toString().

void TRADEMGEN::DemandStreamKey::fromStream ( std::istream &  ioIn)

Read a Business Object Key from an input stream.

Parameters:
istream&the input stream.

Definition at line 51 of file DemandStreamKey.cpp.

const std::string TRADEMGEN::DemandStreamKey::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-stream.

Definition at line 55 of file DemandStreamKey.cpp.

Referenced by TRADEMGEN::DemandStream::describeKey(), TRADEMGEN::DemandStream::display(), toStream(), and TRADEMGEN::DemandStream::toString().


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