FareFamily.hpp

Go to the documentation of this file.

#ifndef __STDAIR_BOM_FAREFAMILY_HPP
#define __STDAIR_BOM_FAREFAMILY_HPP

// //////////////////////////////////////////////////////////////////////
// Import section
// //////////////////////////////////////////////////////////////////////
// STL
#include <iosfwd>
#include <string>
// StdAir
#include <stdair/stdair_rm_types.hpp>
#include <stdair/bom/BomAbstract.hpp>
#include <stdair/bom/FareFamilyKey.hpp>
#include <stdair/bom/FareFamilyTypes.hpp>

namespace boost {
  namespace serialization {
    class access;
  }
}

namespace stdair {

  class FareFamily : 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 FareFamilyKey Key_T;


  public:
    // /////////// Getters ////////////
    const Key_T& getKey() const {
      return _key;
    }
    
    BomAbstract* const getParent() const {
      return _parent;
    }

    const FamilyCode_T& getFamilyCode() const {
      return _key.getFamilyCode();
    }

    const HolderMap_T& getHolderMap() const {
      return _holderMap;
    }
    
    const FRAT5Curve_T& getFrat5Curve () const {
      return _frat5Curve;
    }
        
    const FFDisutilityCurve_T& getDisutilityCurve () const {
      return _disutilityCurve;
    }
    
    const MeanValue_T& getMean () const { return _mean; }
    const StdDevValue_T& getStdDev () const {return _stdDev; }

    const MeanStdDevPairVector_T& getMeanStdDev () const {return _meanStdDev; }


  public:
    // /////////// Setters ////////////
    void setFrat5Curve (const FRAT5Curve_T& iFRAT5Curve) {
      _frat5Curve = iFRAT5Curve;
    }
    
    void setDisutilityCurve (const FFDisutilityCurve_T& iDisutilityCurve) {
      _disutilityCurve = iDisutilityCurve;
    }
    
    void setMean (const MeanValue_T& iMean) { _mean = iMean; }
    void setStdDev (const StdDevValue_T& iStdDev) { _stdDev = iStdDev; }
    
    void setMeanStdDev (const MeanStdDevPairVector_T& iMeanStdDev){ 
      _meanStdDev = iMeanStdDev; 
    }


  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 /////////
    FareFamily (const Key_T&);

    virtual ~FareFamily();


  private:
    FareFamily();

    FareFamily (const FareFamily&);


  public:
    // ////////// Attributes /////////
    Key_T _key;

    BomAbstract* _parent;
    
    HolderMap_T _holderMap;

    FRAT5Curve_T _frat5Curve;

    FFDisutilityCurve_T _disutilityCurve;

    MeanValue_T _mean;
    StdDevValue_T _stdDev;

    MeanStdDevPairVector_T _meanStdDev;
  };

}
#endif // __STDAIR_BOM_FAREFAMILY_HPP