Logo
Reference manual - version qle_version
CommodityBasisFutureIndex Class Reference

Commodity Basis Future Index. More...

#include <qle/indexes/commoditybasisfutureindex.hpp>

Inheritance diagram for CommodityBasisFutureIndex:

Public Member Functions

 CommodityBasisFutureIndex (const std::string &underlyingName, const QuantLib::Date &expiryDate, const QuantLib::Calendar &fixingCalendar, const QuantLib::ext::shared_ptr< FutureExpiryCalculator > &basisFec, const QuantLib::ext::shared_ptr< QuantExt::CommodityIndex > &baseIndex, const QuantLib::ext::shared_ptr< FutureExpiryCalculator > &baseFec, const QuantLib::Handle< QuantExt::PriceTermStructure > &priceCurve=QuantLib::Handle< QuantExt::PriceTermStructure >(), const bool addBasis=true, const QuantLib::Size monthOffset=0, const bool baseIsAveraging=false, const bool priceAsHistoricalFixing=true)
 CommodityBasisFutureIndex (const std::string &underlyingName, const QuantLib::Date &expiryDate, const QuantLib::Calendar &fixingCalendar, const QuantLib::ext::shared_ptr< CommodityBasisPriceTermStructure > &priceCurve)
QuantLib::ext::shared_ptr< CommodityIndexclone (const QuantLib::Date &expiryDate=QuantLib::Date(), const QuantLib::Date &optionExpiryDate=QuantLib::Date(), const QuantLib::ext::optional< QuantLib::Handle< PriceTermStructure > > &ts=QuantLib::ext::nullopt) const override
 Implement the base clone. Ajust the base future to match the same contract month.
QuantLib::Real pastFixing (const QuantLib::Date &fixingDate) const override
const QuantLib::ext::shared_ptr< QuantExt::CommodityIndex > & baseIndex ()
QuantLib::ext::shared_ptr< QuantLib::CashFlow > baseCashflow (const QuantLib::Date &paymentDate=QuantLib::Date()) const
Public Member Functions inherited from CommodityFuturesIndex
 CommodityFuturesIndex (const std::string &underlyingName, const Date &expiryDate, const Calendar &fixingCalendar, const Handle< QuantExt::PriceTermStructure > &priceCurve=Handle< QuantExt::PriceTermStructure >(), const Date &optionExpiryDate=Date())
 CommodityFuturesIndex (const std::string &underlyingName, const Date &expiryDate, const Calendar &fixingCalendar, bool keepDays, const Handle< QuantExt::PriceTermStructure > &priceCurve=Handle< QuantExt::PriceTermStructure >(), const Date &optionExpiryDate=Date())
QuantLib::ext::shared_ptr< CommodityIndexclone (const QuantLib::Date &expiryDate=QuantLib::Date(), const Date &optionExpiryDate=QuantLib::Date(), const QuantLib::ext::optional< QuantLib::Handle< PriceTermStructure > > &ts=QuantLib::ext::nullopt) const override
 Implement the base clone.
Public Member Functions inherited from CommodityIndex
 CommodityIndex (const std::string &underlyingName, const QuantLib::Date &expiryDate, const Calendar &fixingCalendar, const Handle< QuantExt::PriceTermStructure > &priceCurve=Handle< QuantExt::PriceTermStructure >(), const QuantLib::Date &optionExpiryDate=QuantLib::Date())
 CommodityIndex (const std::string &underlyingName, const QuantLib::Date &expiryDate, const Calendar &fixingCalendar, bool keepDays, const Handle< QuantExt::PriceTermStructure > &priceCurve=Handle< QuantExt::PriceTermStructure >(), const QuantLib::Date &optionExpiryDate=QuantLib::Date())
std::string name () const override
Calendar fixingCalendar () const override
bool isValidFixingDate (const Date &fixingDate) const override
Real fixing (const Date &fixingDate, bool forecastTodaysFixing=false) const override
void update () override
std::string underlyingName () const
const Handle< QuantExt::PriceTermStructure > & priceCurve () const
bool isFuturesIndex () const
const QuantLib::Date & expiryDate () const
const QuantLib::Date & optionExpiryDate () const
bool keepDays () const
virtual Real forecastFixing (const Date &fixingDate) const
virtual Real forecastFixing (const Time &fixingTime) const override
 returns the fixing at the given time
virtual Real pastFixing (const Date &fixingDate) const override
 returns a past fixing at the given date

Additional Inherited Members

void init ()
std::string underlyingName_
Date expiryDate_
Calendar fixingCalendar_
Handle< QuantExt::PriceTermStructurecurve_
std::string name_
bool isFuturesIndex_
bool keepDays_
Date optionExpiryDate_

Detailed Description

Commodity Basis Future Index.

This index can represent futures prices derived from basis future index and a base future index