SegmentDate.hpp

Go to the documentation of this file.

#ifndef __STDAIR_BOM_SEGMENTDATE_HPP
#define __STDAIR_BOM_SEGMENTDATE_HPP

// //////////////////////////////////////////////////////////////////////
// Import section
// //////////////////////////////////////////////////////////////////////
// STL
#include <iosfwd>
#include <string>
// StdAir
#include <stdair/stdair_inventory_types.hpp>
#include <stdair/bom/BomAbstract.hpp>
#include <stdair/bom/SegmentDateKey.hpp>
#include <stdair/bom/SegmentDateTypes.hpp>

namespace boost {
  namespace serialization {
    class access;
  }
}

namespace stdair {

  struct SegmentCabinKey;
  class SegmentCabin; 

  // Define the routing leg keys list type.
  typedef std::list<std::string> RoutingLegKeyList_T;

  class SegmentDate : public BomAbstract {
    template <typename BOM> friend class FacBom;  
    template <typename BOM> friend class FacCloneBom;
    friend class FacBomManager;
    friend class boost::serialization::access;
    
  public:
    // ////////// Type definitions ////////////
    typedef SegmentDateKey Key_T;


  public:
    // /////////// Getters /////////////
    const Key_T& getKey() const {
      return _key;
    }

    BomAbstract* const getParent() const {
      return _parent;
    }
    
    const AirportCode_T& getBoardingPoint() const {
      return _key.getBoardingPoint();
    }

    const AirportCode_T& getOffPoint() const {
      return _key.getOffPoint();
    }

    const HolderMap_T& getHolderMap() const {
      return _holderMap;
    }

    const Date_T& getBoardingDate() const {
      return _boardingDate;
    }

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

    const Date_T& getOffDate() const {
      return _offDate;
    }

    const Duration_T& getOffTime() const {
      return _offTime;
    }

    const Duration_T& getElapsedTime() const {
      return _elapsedTime;
    }

    const Distance_T& getDistance() const {
      return _distance;
    }

    const DateOffset_T getDateOffset() const {
      return _offDate - _boardingDate;
    }

    const Duration_T getTimeOffset() const;

    SegmentDate* getOperatingSegmentDate () const {
      return _operatingSegmentDate;
    }
    
    const SegmentDateList_T& getMarketingSegmentDateList () const {
      return _marketingSegmentDateList;
    }
    
    const RoutingLegKeyList_T& getLegKeyList () const {
      return _routingLegKeyList;
    }
    
  public:
    // ///////// Setters //////////
    void setBoardingDate (const Date_T& iBoardingDate) {
      _boardingDate = iBoardingDate;
    }

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

    void setOffDate (const Date_T& iOffDate) {
      _offDate = iOffDate;
    }

    void setOffTime (const Duration_T& iOffTime) {
      _offTime = iOffTime;
    }

    void setElapsedTime (const Duration_T& iElapsedTime) {
      _elapsedTime = iElapsedTime;
    }

    void setDistance (const Distance_T& iDistance) {
      _distance = iDistance;
    }

    void addLegKey (const std::string& iLegKey) {
      _routingLegKeyList.push_back(iLegKey);
    }

  private:
    void linkWithOperating (SegmentDate& iSegmentDate) {
      _operatingSegmentDate = &iSegmentDate;
    }

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

    void fromStream (std::istream& ioIn) {
    }

    std::string toString() const;
    
    const std::string describeKey() const {
      return _key.toString();
    }

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

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


  protected:
    // ////////// Constructors and destructors /////////
    SegmentDate (const Key_T&);

    virtual ~SegmentDate();

  private:
    SegmentDate();

    SegmentDate (const SegmentDate&);


  protected:
    // ////////// Attributes /////////
    Key_T _key;

    BomAbstract* _parent;
    
    HolderMap_T _holderMap;

    SegmentDate* _operatingSegmentDate;

    SegmentDateList_T _marketingSegmentDateList;

    Date_T _boardingDate;

    Duration_T _boardingTime;

    Date_T _offDate;

    Duration_T _offTime;

    Duration_T _elapsedTime;

    Distance_T _distance;

    RoutingLegKeyList_T _routingLegKeyList;
  };

}
#endif // __STDAIR_BOM_SEGMENTDATE_HPP