StdAir Logo  1.00.13
C++ Standard Airline IT Object Library
Loading...
Searching...
No Matches
stdair::TimePeriod Class Reference

Class representing the actual attributes for a fare time-period. More...

#include <stdair/bom/TimePeriod.hpp>

+ Inheritance diagram for stdair::TimePeriod:

Public Types

typedef TimePeriodKey Key_T
 

Public Member Functions

void toStream (std::ostream &ioOut) const
 
void fromStream (std::istream &ioIn)
 
std::string toString () const
 
const std::string describeKey () const
 
const Key_TgetKey () const
 
BomAbstract *const getParent () const
 
const HolderMap_TgetHolderMap () const
 
const Time_TgetTimeRangeStart () const
 
const Time_TgetTimeRangeEnd () const
 
bool isDepartureTimeValid (const Time_T &) const
 

Protected Member Functions

 TimePeriod (const Key_T &)
 
virtual ~TimePeriod ()
 

Protected Attributes

Key_T _key
 
BomAbstract_parent
 
HolderMap_T _holderMap
 

Friends

template<typename BOM >
class FacBom
 
template<typename BOM >
class FacCloneBom
 
class FacBomManager
 

Detailed Description

Class representing the actual attributes for a fare time-period.

Definition at line 18 of file TimePeriod.hpp.

Member Typedef Documentation

◆ Key_T

Definition allowing to retrieve the associated BOM key type.

Definition at line 28 of file TimePeriod.hpp.

Constructor & Destructor Documentation

◆ TimePeriod()

stdair::TimePeriod::TimePeriod ( const Key_T & iKey)
protected

Main constructor.

Definition at line 27 of file TimePeriod.cpp.

◆ ~TimePeriod()

stdair::TimePeriod::~TimePeriod ( )
protectedvirtual

Destructor.

Definition at line 32 of file TimePeriod.cpp.

Member Function Documentation

◆ toStream()

void stdair::TimePeriod::toStream ( std::ostream & ioOut) const
inlinevirtual

Dump a Business Object into an output stream.

Parameters
ostream&the output stream.

Implements stdair::BomAbstract.

Definition at line 38 of file TimePeriod.hpp.

References toString().

◆ fromStream()

void stdair::TimePeriod::fromStream ( std::istream & ioIn)
inlinevirtual

Read a Business Object from an input stream.

Parameters
istream&the input stream.

Implements stdair::BomAbstract.

Definition at line 47 of file TimePeriod.hpp.

◆ toString()

std::string stdair::TimePeriod::toString ( ) const
virtual

Get the serialised version of the Business Object.

Implements stdair::BomAbstract.

Definition at line 36 of file TimePeriod.cpp.

References describeKey().

Referenced by toStream().

◆ describeKey()

const std::string stdair::TimePeriod::describeKey ( ) const
inline

Get a string describing the key.

Definition at line 58 of file TimePeriod.hpp.

References _key, and stdair::TimePeriodKey::toString().

Referenced by toString().

◆ getKey()

const Key_T & stdair::TimePeriod::getKey ( ) const
inline

Get the primary key (time range start, time range end).

Definition at line 67 of file TimePeriod.hpp.

References _key.

◆ getParent()

BomAbstract *const stdair::TimePeriod::getParent ( ) const
inline

Get a reference on the parent object instance.

Definition at line 74 of file TimePeriod.hpp.

References _parent.

◆ getHolderMap()

const HolderMap_T & stdair::TimePeriod::getHolderMap ( ) const
inline

Get a reference on the children holder.

Definition at line 81 of file TimePeriod.hpp.

References _holderMap.

◆ getTimeRangeStart()

const Time_T & stdair::TimePeriod::getTimeRangeStart ( ) const
inline

Get the time range start.

Definition at line 88 of file TimePeriod.hpp.

References _key, and stdair::TimePeriodKey::getTimeRangeStart().

Referenced by isDepartureTimeValid().

◆ getTimeRangeEnd()

const Time_T & stdair::TimePeriod::getTimeRangeEnd ( ) const
inline

Get the time range end

Definition at line 95 of file TimePeriod.hpp.

References _key, and stdair::TimePeriodKey::getTimeRangeEnd().

Referenced by isDepartureTimeValid().

◆ isDepartureTimeValid()

bool stdair::TimePeriod::isDepartureTimeValid ( const Time_T & iFlightTime) const

Check if the given departure time is included in the departure period of the segment path.

Definition at line 43 of file TimePeriod.cpp.

References getTimeRangeEnd(), getTimeRangeStart(), and STDAIR_LOG_DEBUG.

Friends And Related Symbol Documentation

◆ FacBom

template<typename BOM >
friend class FacBom
friend

Definition at line 19 of file TimePeriod.hpp.

◆ FacCloneBom

template<typename BOM >
friend class FacCloneBom
friend

Definition at line 20 of file TimePeriod.hpp.

◆ FacBomManager

friend class FacBomManager
friend

Definition at line 21 of file TimePeriod.hpp.

Member Data Documentation

◆ _key

Key_T stdair::TimePeriod::_key
protected

Primary key (flight number and departure date).

Definition at line 133 of file TimePeriod.hpp.

Referenced by describeKey(), getKey(), getTimeRangeEnd(), and getTimeRangeStart().

◆ _parent

BomAbstract* stdair::TimePeriod::_parent
protected

Pointer on the parent class (Inventory).

Definition at line 138 of file TimePeriod.hpp.

Referenced by getParent().

◆ _holderMap

HolderMap_T stdair::TimePeriod::_holderMap
protected

Map holding the children.

Definition at line 143 of file TimePeriod.hpp.

Referenced by getHolderMap().


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