Reference manual - version ored_version
#include <ored/portfolio/commoditydigitalapo.hpp>
Inheritance diagram for CommodityDigitalAveragePriceOption:Public Member Functions | |
| CommodityDigitalAveragePriceOption (const ore::data::Envelope &envelope, const ore::data::OptionData &optionData, QuantLib::Real strike, QuantLib::Real digitalCashPayoff, const std::string ¤cy, const std::string &name, CommodityPriceType priceType, const std::string &startDate, const std::string &endDate, const std::string &paymentCalendar, const std::string &paymentLag, const std::string &paymentConvention, const std::string &pricingCalendar, const std::string &paymentDate="", QuantLib::Real gearing=1.0, QuantLib::Spread spread=0.0, QuantExt::CommodityQuantityFrequency commodityQuantityFrequency=QuantExt::CommodityQuantityFrequency::PerCalculationPeriod, CommodityPayRelativeTo commodityPayRelativeTo=CommodityPayRelativeTo::CalculationPeriodEndDate, QuantLib::Natural futureMonthOffset=0, QuantLib::Natural deliveryRollDays=0, bool includePeriodEnd=true, const BarrierData &barrierData={}, const std::string &fxIndex="") | |
| void | build (const QuantLib::ext::shared_ptr< ore::data::EngineFactory > &engineFactory) override |
| std::map< AssetClass, std::set< std::string > > | underlyingIndices (const QuantLib::ext::shared_ptr< ReferenceDataManager > &referenceDataManager=nullptr) const override |
| Add underlying Commodity names. | |
Inspectors | |
| const ore::data::OptionData & | optionData () |
| const ore::data::BarrierData & | barrierData () |
| QuantLib::Real | strike () const |
| QuantLib::Real | digitalCashPayoff () const |
| const std::string & | currency () const |
| const std::string & | name () const |
| CommodityPriceType | priceType () const |
| const std::string & | startDate () const |
| const std::string & | endDate () const |
| const std::string & | paymentCalendar () const |
| const std::string & | paymentLag () const |
| const std::string & | paymentConvention () const |
| const std::string & | pricingCalendar () const |
| const std::string & | paymentDate () const |
| QuantLib::Real | gearing () const |
| QuantLib::Spread | spread () const |
| QuantExt::CommodityQuantityFrequency | commodityQuantityFrequency () const |
| CommodityPayRelativeTo | commodityPayRelativeTo () const |
| QuantLib::Natural | futureMonthOffset () const |
| QuantLib::Natural | deliveryRollDays () const |
| bool | includePeriodEnd () const |
| const std::string & | fxIndex () const |
Serialisation | |
| virtual void | fromXML (ore::data::XMLNode *node) override |
| virtual ore::data::XMLNode * | toXML (ore::data::XMLDocument &doc) const override |
| Public Member Functions inherited from Trade | |
| Trade () | |
| Default constructor. | |
| Trade (const string &tradeType, const Envelope &env=Envelope(), const TradeActions &ta=TradeActions()) | |
| Base class constructor. | |
| virtual | ~Trade () |
| Default destructor. | |
| virtual void | build (const QuantLib::ext::shared_ptr< EngineFactory > &)=0 |
| virtual std::map< std::string, RequiredFixings::FixingDates > | fixings (const QuantLib::Date &settlementDate=QuantLib::Date()) const |
| const RequiredFixings & | requiredFixings () const |
| void | reset () |
| Reset trade, clear all base class data. This does not reset accumulated timings for this trade. | |
| void | resetPricingStats (const std::size_t numberOfPricings=0, const boost::timer::nanosecond_type cumulativePricingTime=0) |
| Reset accumulated timings to given values. | |
| string & | id () |
| Set the trade id. | |
| void | setEnvelope (const Envelope &envelope) |
| Set the envelope with counterparty and portfolio info. | |
| void | setAdditionalData (const std::map< std::string, boost::any > &additionalData) |
| TradeActions & | tradeActions () |
| Set the trade actions. | |
| const string & | id () const |
| const string & | tradeType () const |
| const Envelope & | envelope () const |
| const set< string > & | portfolioIds () const |
| const TradeActions & | tradeActions () const |
| const QuantLib::ext::shared_ptr< InstrumentWrapper > & | instrument () const |
| const std::vector< QuantLib::Leg > & | legs () const |
| const std::vector< string > & | legCurrencies () const |
| const std::vector< bool > & | legPayers () const |
| const string & | npvCurrency () const |
| virtual QuantLib::Real | notional () const |
| Return the current notional in npvCurrency. See individual sub-classes for the precise definition. | |
| virtual string | notionalCurrency () const |
| const Date & | maturity () const |
| virtual bool | isExpired (const Date &d) |
| const string & | issuer () const |
| template<typename T > | |
| T | additionalDatum (const std::string &tag) const |
| returns any additional datum. | |
| virtual const std::map< std::string, boost::any > & | additionalData () const |
| returns all additional data returned by the trade once built | |
| const std::string & | sensitivityTemplate () const |
| void | validate () const |
| Utility to validate that everything that needs to be set in this base class is actually set. | |
| boost::timer::nanosecond_type | getCumulativePricingTime () const |
| Get cumulative timing spent on pricing. | |
| std::size_t | getNumberOfPricings () const |
| Get number of pricings. | |
| Public Member Functions inherited from XMLSerializable | |
| void | fromFile (const std::string &filename) |
| void | toFile (const std::string &filename) const |
| void | fromXMLString (const std::string &xml) |
| Parse from XML string. | |
| std::string | toXMLString () const |
| Parse from XML string. | |
Trade | |
| bool | hasCashflows () const override |
Additional Inherited Members | |
| Protected Member Functions inherited from Trade | |
| Date | addPremiums (std::vector< QuantLib::ext::shared_ptr< Instrument >> &instruments, std::vector< Real > &multipliers, const Real tradeMultiplier, const PremiumData &premiumData, const Real premiumMultiplier, const Currency &tradeCurrency, const QuantLib::ext::shared_ptr< EngineFactory > &factory, const string &configuration) |
| void | setLegBasedAdditionalData (const Size legNo, Size resultLegId=Null< Size >()) const |
| void | setSensitivityTemplate (const EngineBuilder &builder) |
| void | setSensitivityTemplate (const std::string &id) |
| Protected Attributes inherited from Trade | |
| string | tradeType_ |
| QuantLib::ext::shared_ptr< InstrumentWrapper > | instrument_ |
| std::vector< QuantLib::Leg > | legs_ |
| std::vector< string > | legCurrencies_ |
| std::vector< bool > | legPayers_ |
| string | npvCurrency_ |
| QuantLib::Real | notional_ |
| string | notionalCurrency_ |
| Date | maturity_ |
| string | issuer_ |
| string | sensitivityTemplate_ |
| bool | sensitivityTemplateSet_ = false |
| std::size_t | savedNumberOfPricings_ = 0 |
| boost::timer::nanosecond_type | savedCumulativePricingTime_ = 0 |
| RequiredFixings | requiredFixings_ |
| std::map< std::string, boost::any > | additionalData_ |
Serializable Commodity Average Price Option
|
overridevirtual |
Utility method indicating if the trade has cashflows for the cashflow report. The default implementation returns true so that a trade is automatically considered when cashflows are being written. To prevent a trade from being asked for its cashflows, the method can be overridden to return false.
Reimplemented from Trade.
