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

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

#include <stdair/bom/DatePeriod.hpp>

+ Inheritance diagram for stdair::DatePeriod:

Public Types

typedef DatePeriodKey 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 DatePeriod_TgetDatePeriod () const
 
bool isDepartureDateValid (const Date_T &) const
 

Protected Member Functions

 DatePeriod (const Key_T &)
 
virtual ~DatePeriod ()
 

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 date-period.

Definition at line 18 of file DatePeriod.hpp.

Member Typedef Documentation

◆ Key_T

Definition allowing to retrieve the associated BOM key type.

Definition at line 28 of file DatePeriod.hpp.

Constructor & Destructor Documentation

◆ DatePeriod()

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

Main constructor.

Definition at line 27 of file DatePeriod.cpp.

References _key, _parent, and DatePeriod().

Referenced by DatePeriod().

◆ ~DatePeriod()

stdair::DatePeriod::~DatePeriod ( )
protectedvirtual

Destructor.

Definition at line 32 of file DatePeriod.cpp.

Member Function Documentation

◆ toStream()

void stdair::DatePeriod::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 37 of file DatePeriod.hpp.

References toString().

◆ fromStream()

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

Read a Business Object from an input stream.

Parameters
istream&the input stream.

Implements stdair::BomAbstract.

Definition at line 46 of file DatePeriod.hpp.

◆ toString()

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

Get the serialised version of the Business Object.

Implements stdair::BomAbstract.

Definition at line 36 of file DatePeriod.cpp.

References describeKey().

Referenced by toStream().

◆ describeKey()

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

Get a string describing the key.

Definition at line 57 of file DatePeriod.hpp.

References _key.

Referenced by toString().

◆ getKey()

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

Get the primary key (date period).

Definition at line 66 of file DatePeriod.hpp.

References _key.

◆ getParent()

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

Get a reference on the parent object instance.

Definition at line 73 of file DatePeriod.hpp.

References _parent, and stdair::BomAbstract::BomAbstract().

◆ getHolderMap()

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

Get a reference on the children holder.

Definition at line 80 of file DatePeriod.hpp.

References _holderMap.

◆ getDatePeriod()

const DatePeriod_T & stdair::DatePeriod::getDatePeriod ( ) const
inline

Get the date period.

Definition at line 87 of file DatePeriod.hpp.

References _key.

Referenced by isDepartureDateValid().

◆ isDepartureDateValid()

bool stdair::DatePeriod::isDepartureDateValid ( const Date_T & iFlightDate) const

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

Definition at line 43 of file DatePeriod.cpp.

References getDatePeriod().

Referenced by stdair::BomRetriever::retrieveDatePeriodListFromKey().

Friends And Related Symbol Documentation

◆ FacBom

template<typename BOM>
friend class FacBom
friend

Definition at line 19 of file DatePeriod.hpp.

References FacBom.

Referenced by FacBom.

◆ FacCloneBom

template<typename BOM>
friend class FacCloneBom
friend

Definition at line 20 of file DatePeriod.hpp.

References FacCloneBom.

Referenced by FacCloneBom.

◆ FacBomManager

friend class FacBomManager
friend

Definition at line 21 of file DatePeriod.hpp.

References FacBomManager.

Referenced by FacBomManager.

Member Data Documentation

◆ _key

Key_T stdair::DatePeriod::_key
protected

Primary key (date period).

Definition at line 126 of file DatePeriod.hpp.

Referenced by DatePeriod(), describeKey(), getDatePeriod(), and getKey().

◆ _parent

BomAbstract* stdair::DatePeriod::_parent
protected

Pointer on the parent class.

Definition at line 131 of file DatePeriod.hpp.

Referenced by DatePeriod(), and getParent().

◆ _holderMap

HolderMap_T stdair::DatePeriod::_holderMap
protected

Map holding the children.

Definition at line 136 of file DatePeriod.hpp.

Referenced by getHolderMap().


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