EnergyFuture Class Reference
Energy future. More...
#include <ql/experimental/commodities/energyfuture.hpp>
Inheritance diagram for EnergyFuture:
Public Member Functions | |
| EnergyFuture (Integer buySell, Quantity quantity, CommodityUnitCost tradePrice, ext::shared_ptr< CommodityIndex > index, const CommodityType &commodityType, const ext::shared_ptr< SecondaryCosts > &secondaryCosts) | |
| bool | isExpired () const override |
| returns whether the instrument might have value greater than zero. | |
| Quantity | quantity () const override |
| const CommodityUnitCost & | tradePrice () const |
| ext::shared_ptr< CommodityIndex > | index () const |
| Public Member Functions inherited from EnergyCommodity | |
| EnergyCommodity (CommodityType commodityType, const ext::shared_ptr< SecondaryCosts > &secondaryCosts) | |
| const CommodityType & | commodityType () const |
| void | setupArguments (PricingEngine::arguments *) const override |
| void | fetchResults (const PricingEngine::results *) const override |
| Public Member Functions inherited from Commodity | |
| Commodity (ext::shared_ptr< SecondaryCosts > secondaryCosts) | |
| const ext::shared_ptr< SecondaryCosts > & | secondaryCosts () const |
| const SecondaryCostAmounts & | secondaryCostAmounts () const |
| const PricingErrors & | pricingErrors () const |
| void | addPricingError (PricingError::Level errorLevel, const std::string &error, const std::string &detail="") const |
| Public Member Functions inherited from Instrument | |
| Real | NPV () const |
| returns the net present value of the instrument. | |
| Real | errorEstimate () const |
| returns the error estimate on the NPV when available. | |
| const Date & | valuationDate () const |
| returns the date the net present value refers to. | |
| template<typename T> | |
| T | result (const std::string &tag) const |
| returns any additional result returned by the pricing engine. | |
| const std::map< std::string, ext::any > & | additionalResults () const |
| returns all additional result returned by the pricing engine. | |
| void | setPricingEngine (const ext::shared_ptr< PricingEngine > &) |
| set the pricing engine to be used. | |
| Public Member Functions inherited from LazyObject | |
| void | update () override |
| bool | isCalculated () const |
| void | forwardFirstNotificationOnly () |
| void | alwaysForwardNotifications () |
| void | recalculate () |
| void | freeze () |
| void | unfreeze () |
| Public Member Functions inherited from Observable | |
| Observable (const Observable &) | |
| Observable & | operator= (const Observable &) |
| Observable (Observable &&)=delete | |
| Observable & | operator= (Observable &&)=delete |
| void | notifyObservers () |
| Public Member Functions inherited from Observer | |
| Observer (const Observer &) | |
| Observer & | operator= (const Observer &) |
| std::pair< iterator, bool > | registerWith (const ext::shared_ptr< Observable > &) |
| void | registerWithObservables (const ext::shared_ptr< Observer > &) |
| Size | unregisterWith (const ext::shared_ptr< Observable > &) |
| void | unregisterWithAll () |
| virtual void | deepUpdate () |
Protected Member Functions | |
| void | performCalculations () const override |
| Protected Member Functions inherited from EnergyCommodity | |
| Real | calculateUnitCost (const CommodityType &commodityType, const CommodityUnitCost &unitCost, const Date &evaluationDate) const |
| void | calculateSecondaryCostAmounts (const CommodityType &commodityType, Real totalQuantityValue, const Date &evaluationDate) const |
| Protected Member Functions inherited from Instrument | |
| void | calculate () const override |
| virtual void | setupExpired () const |
| void | performCalculations () const override |
Protected Attributes | |
| Integer | buySell_ |
| Quantity | quantity_ |
| CommodityUnitCost | tradePrice_ |
| ext::shared_ptr< CommodityIndex > | index_ |
| Protected Attributes inherited from EnergyCommodity | |
| CommodityType | commodityType_ |
| Protected Attributes inherited from Commodity | |
| ext::shared_ptr< SecondaryCosts > | secondaryCosts_ |
| PricingErrors | pricingErrors_ |
| SecondaryCostAmounts | secondaryCostAmounts_ |
| Protected Attributes inherited from Instrument | |
| Real | NPV_ |
| Real | errorEstimate_ |
| Date | valuationDate_ |
| std::map< std::string, ext::any > | additionalResults_ |
| ext::shared_ptr< PricingEngine > | engine_ |
| bool | calculated_ = false |
| bool | frozen_ = false |
| bool | alwaysForward_ |
Additional Inherited Members | |
| Public Types inherited from EnergyCommodity | |
| enum | DeliverySchedule { Constant , Window , Hourly , Daily , Weekly , Monthly , Quarterly , Yearly } |
| enum | QuantityPeriodicity { Absolute , PerHour , PerDay , PerWeek , PerMonth , PerQuarter , PerYear } |
| enum | PaymentSchedule { WindowSettlement , MonthlySettlement , QuarterlySettlement , YearlySettlement } |
| Public Types inherited from Observer | |
| typedef set_type::iterator | iterator |
| Static Protected Member Functions inherited from EnergyCommodity | |
| static Real | calculateFxConversionFactor (const Currency &fromCurrency, const Currency &toCurrency, const Date &evaluationDate) |
| static Real | calculateUomConversionFactor (const CommodityType &commodityType, const UnitOfMeasure &fromUnitOfMeasure, const UnitOfMeasure &toUnitOfMeasure) |
Detailed Description
Energy future.
Member Function Documentation
◆ isExpired()
|
overridevirtual |
returns whether the instrument might have value greater than zero.
Implements Instrument.
◆ quantity()
|
overridevirtual |
Implements EnergyCommodity.
◆ performCalculations()
|
overrideprotectedvirtual |
This method must implement any calculations which must be (re)done in order to calculate the desired results.
Implements LazyObject.
Generated by Doxygen 1.14.0