Logo
Reference manual - version ored_version
CommodityOptionStrip Class Reference

#include <ored/portfolio/commodityoptionstrip.hpp>

Inheritance diagram for CommodityOptionStrip:

Public Member Functions

 CommodityOptionStrip (const ore::data::Envelope &envelope, const ore::data::LegData &legData, const std::vector< QuantLib::Position::Type > &callPositions, const std::vector< QuantLib::Real > &callStrikes, const std::vector< QuantLib::Position::Type > &putPositions, const std::vector< QuantLib::Real > &putStrikes, QuantLib::Real premium=0.0, const std::string &premiumCurrency="", const QuantLib::Date &premiumPayDate=QuantLib::Date(), const std::string &style="", const std::string &settlement="", const BarrierData &callBarrierData={}, const BarrierData &putBarrierData={}, const std::string &fxIndex="", const bool isDigital=false, Real payoffPerUnit=0.0)
void build (const QuantLib::ext::shared_ptr< ore::data::EngineFactory > &engineFactory) override
 Implement the build method.
std::map< ore::data::AssetClass, std::set< std::string > > underlyingIndices (const QuantLib::ext::shared_ptr< ReferenceDataManager > &referenceDataManager=nullptr) const override
 Add underlying Commodity names.
Inspectors
const ore::data::LegDatalegData () const
const std::vector< QuantLib::Position::Type > & callPositions () const
const std::vector< QuantLib::Real > & callStrikes () const
const std::vector< QuantLib::Position::Type > & putPositions () const
const std::vector< QuantLib::Real > & putStrikes () const
const PremiumDatapremiumDate () const
const std::string & style () const
const std::string & settlement () const
const std::string & fxIndex () const
const BarrierDatacallBarrierData () const
const BarrierDataputBarrierData () const
const bool isDigital () const
const Real payoffPerUnit () const
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::FixingDatesfixings (const QuantLib::Date &settlementDate=QuantLib::Date()) const
const RequiredFixingsrequiredFixings () 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.
stringid ()
 Set the trade id.
void setId (const std::string &id)
void setEnvelope (const Envelope &envelope)
 Set the envelope with counterparty and portfolio info.
void setAdditionalData (const std::map< std::string, QuantLib::ext::any > &additionalData)
TradeActionstradeActions ()
 Set the trade actions.
const stringid () const
const stringtradeType () const
const Envelopeenvelope () const
const set< string > & portfolioIds () const
const TradeActionstradeActions () 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 std::map< size_t, LegCashflowInclusion > & legCashflowInclusion () const
const stringnpvCurrency () 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
const stringmaturityType () const
virtual bool isExpired (const Date &d) const
const stringissuer () const
template<typename T>
additionalDatum (const std::string &tag) const
 returns any additional datum.
virtual const std::map< std::string, QuantLib::ext::any > & additionalData () const
 returns all additional data returned by the trade once built
const std::string & sensitivityTemplate () const
const std::set< std::tuple< std::set< std::string >, std::string, std::string > > & productModelEngine () 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.
void addProductModelEngine (const EngineBuilder &builder)
void addProductModelEngine (const std::set< std::tuple< std::set< std::string >, std::string, std::string > > &productModelEngine)
void setSensitivityTemplate (const EngineBuilder &builder)
void setSensitivityTemplate (const std::string &id)
virtual std::vector< TradeCashflowReportDatacashflows (const std::string &baseCurrency, const QuantLib::ext::shared_ptr< ore::data::Market > &market, const std::string &configuration, const bool includePastCashflows) const
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.
std::string toXMLStringUnformatted () const

Serialisation

virtual void fromXML (ore::data::XMLNode *node) override
virtual ore::data::XMLNode * toXML (ore::data::XMLDocument &doc) const override

Additional Inherited Members

enum class  LegCashflowInclusion { IfNoEngineCashflows , Never , Always }
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 string &discountCurve, const QuantLib::ext::shared_ptr< EngineFactory > &factory, const string &configuration)
void setLegBasedAdditionalData (const Size legNo, Size resultLegId=Null< Size >()) const
void updateProductModelEngineAdditionalData ()
string tradeType_
QuantLib::ext::shared_ptr< InstrumentWrapperinstrument_
std::vector< QuantLib::Leg > legs_
std::vector< stringlegCurrencies_
std::vector< bool > legPayers_
std::map< std::size_t, LegCashflowInclusion > legCashflowInclusion_
string npvCurrency_
QuantLib::Real notional_
string notionalCurrency_
Date maturity_
string maturityType_
string issuer_
string sensitivityTemplate_
bool sensitivityTemplateSet_ = false
std::set< std::tuple< std::set< std::string >, std::string, std::string > > productModelEngine_
Date lastRelevantDate_ = Null<Date>()
std::size_t savedNumberOfPricings_ = 0
boost::timer::nanosecond_type savedCumulativePricingTime_ = 0
RequiredFixings requiredFixings_
std::map< std::string, QuantLib::ext::any > additionalData_

Detailed Description

Serializable Commodity option strip

Member Function Documentation

◆ underlyingIndices()

std::map< ore::data::AssetClass, std::set< std::string > > underlyingIndices ( const QuantLib::ext::shared_ptr< ReferenceDataManager > & referenceDataManager = nullptr) const
overridevirtual

Add underlying Commodity names.

Reimplemented from Trade.

◆ fromXML()

virtual void fromXML ( ore::data::XMLNode * node)
overridevirtual

Reimplemented from Trade.

◆ toXML()

virtual ore::data::XMLNode * toXML ( ore::data::XMLDocument & doc) const
overridevirtual

Reimplemented from Trade.