SegmentPathPeriodKey.hpp

Go to the documentation of this file.

#ifndef __AIRTSP_BOM_SEGMENTPATHPERIODKEY_HPP
#define __AIRTSP_BOM_SEGMENTPATHPERIODKEY_HPP

// //////////////////////////////////////////////////////////////////////
// Import section
// //////////////////////////////////////////////////////////////////////
// STL
#include <iosfwd>
#include <string>
// StdAir
#include <stdair/stdair_basic_types.hpp>
#include <stdair/stdair_date_time_types.hpp>
#include <stdair/bom/KeyAbstract.hpp>
#include <stdair/bom/PeriodStruct.hpp>
// AirTSP
#include <airtsp/bom/SegmentPathPeriodTypes.hpp>

namespace boost {
  namespace serialization {
    class access;
  }
}

namespace AIRTSP {

  struct SegmentPathPeriodKey : public stdair::KeyAbstract {
    friend class boost::serialization::access;

    // /////////// Constructors and destructors ///////////
  public:
    SegmentPathPeriodKey (const stdair::PeriodStruct&,
                          const stdair::Duration_T& iBoardingTime,
                          const stdair::Duration_T& iElapsed,
                          const DateOffsetList_T&, 
                          const stdair::NbOfAirlines_T&);

    SegmentPathPeriodKey();
    
    SegmentPathPeriodKey (const SegmentPathPeriodKey&);

    ~SegmentPathPeriodKey();


  public:
    // /////////// Getters //////////
    const stdair::PeriodStruct& getPeriod() const {
      return _period;
    }

    const DateOffsetList_T& getBoardingDateOffsetList() const {
      return _boardingDateOffsetList;
    }
    
    const stdair::NbOfSegments_T getNbOfSegments() const {
      return _boardingDateOffsetList.size();
    }
    
    const stdair::NbOfAirlines_T& getNbOfAirlines() const {
      return _nbOfAirlines;
    }

    const stdair::Duration_T& getElapsedTime() const {
      return _elapsed;
    }

    const stdair::Duration_T& getBoardingTime() const {
      return _boardingTime;
    }


  public:
    // /////////// Setters //////////
    void setPeriod (const stdair::PeriodStruct& iPeriod) {
      _period = iPeriod;
    }

    void setBoardingDateOffsetList (const DateOffsetList_T& iList) {
      _boardingDateOffsetList = iList;
    }
    
    void setNbOfAirlines (const stdair::NbOfAirlines_T& iNbOfAirlines) {
      _nbOfAirlines = iNbOfAirlines;
    }

    void setElapsedTime (const stdair::Duration_T& iElapsed) {
      _elapsed = iElapsed;
    }

    void setBoardingTime (const stdair::Duration_T& iBoardingTime) {
      _boardingTime = iBoardingTime;
    }


  public:
    // /////////// Business methods ////////////
    const bool isValid () const {
      return _period.isValid ();
    }


  public:
    // /////////// Display support methods /////////
    void toStream (std::ostream& ioOut) const;

    void fromStream (std::istream& ioIn);

    const std::string toString() const;


  public:
    // /////////// (Boost) Serialisation support methods /////////
    template<class Archive>
    void serialize (Archive& ar, const unsigned int iFileVersion);

  private:
    void serialisationImplementationExport() const;
    void serialisationImplementationImport();


  private:
    // ///////////////// Attributes ///////////////
    stdair::PeriodStruct _period;
    
    stdair::Duration_T _boardingTime;

    stdair::Duration_T _elapsed;

    DateOffsetList_T _boardingDateOffsetList;

    stdair::NbOfAirlines_T _nbOfAirlines;
  };

}
#endif // __AIRTSP_BOM_SEGMENTPATHPERIODKEY_HPP