YieldRange.hpp

Go to the documentation of this file.

#ifndef __STDAIR_BAS_YIELDRANGE_HPP
#define __STDAIR_BAS_YIELDRANGE_HPP

// //////////////////////////////////////////////////////////////////////
// Import section
// //////////////////////////////////////////////////////////////////////
// STDAIR
#include <stdair/stdair_inventory_types.hpp>
#include <stdair/basic/StructAbstract.hpp>

namespace stdair {

  class YieldRange : public StructAbstract {
  public:
    YieldRange ();
    YieldRange (const YieldRange&);
    YieldRange (const Yield_T iUpperYield);
    YieldRange (const Yield_T iUpperYield, const Yield_T iAverageYield);
    YieldRange (const Yield_T iUpperYield, const Yield_T iAverageYield,
                const Yield_T iLowerYield);
    
    virtual ~YieldRange();
    

    // /////////// Getters ////////////
    Yield_T getUpperYield() const {
      return _upperYield;
    }
    Yield_T getAverageYield() const {
      return _averageYield;
    }
    Yield_T getLowerYield() const {
      return _lowerYield;
    }
    
    // //////// Setters /////////
    void setUpperYield (const Yield_T iUpperYield) {
      _upperYield = iUpperYield;
    }
    void setAverageYield (const Yield_T iAverageYield) {
      _averageYield = iAverageYield;
    }
    void setLowerYield (const Yield_T iLowerYield) {
      _lowerYield = iLowerYield;
    }
    

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

    void fromStream (std::istream&);

    const std::string describe() const;

  private:
    // ////////// Attributes /////////
    Yield_T _upperYield;

    Yield_T _averageYield;

    Yield_T _lowerYield;
  };
}
#endif // __STDAIR_BAS_YIELDRANGE_HPP