#include <ored/portfolio/windowbarrieroption.hpp>

Inheritance diagram for WindowBarrierOption:

Collaboration diagram for WindowBarrierOption:

Public Member Functions
	WindowBarrierOption (const std::string &tradeType="WindowBarrierOption")

	WindowBarrierOption (const std::string &currency, const std::string &fixingAmount, const TradeStrike &strike, const QuantLib::ext::shared_ptr< Underlying > &underlying, const std::string &startDate, const std::string &endDate, const OptionData &optionData, const BarrierData &barrier)

void	build (const QuantLib::ext::shared_ptr< EngineFactory > &) override

void	setIsdaTaxonomyFields () override

void	fromXML (XMLNode *node) override

XMLNode *	toXML (XMLDocument &doc) const override

Public Member Functions inherited from ScriptedTrade
	ScriptedTrade (const std::string &tradeType="ScriptedTrade", const Envelope &env=Envelope())

	ScriptedTrade (const Envelope &env, const std::vector< ScriptedTradeEventData > &events, const std::vector< ScriptedTradeValueTypeData > &numbers, const std::vector< ScriptedTradeValueTypeData > &indices, const std::vector< ScriptedTradeValueTypeData > &currencies, const std::vector< ScriptedTradeValueTypeData > &daycounters, const std::map< std::string, ScriptedTradeScriptData > &script, const std::string &productTag, const std::string &tradeType="ScriptedTrade")

	ScriptedTrade (const Envelope &env, const std::vector< ScriptedTradeEventData > &events, const std::vector< ScriptedTradeValueTypeData > &numbers, const std::vector< ScriptedTradeValueTypeData > &indices, const std::vector< ScriptedTradeValueTypeData > &currencies, const std::vector< ScriptedTradeValueTypeData > &daycounters, const std::string &scriptName, const std::string &tradeType="ScriptedTrade")

void	clear ()

void	build (const QuantLib::ext::shared_ptr< EngineFactory > &) override

QuantLib::Real	notional () const override
	Return the current notional in npvCurrency. See individual sub-classes for the precise definition. More...

std::string	notionalCurrency () const override

void	fromXML (XMLNode *node) override

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

void	build (const QuantLib::ext::shared_ptr< EngineFactory > &engineFactory, const PremiumData &premiumData, const Real premiumMultiplier)

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

virtual void	setIsdaTaxonomyFields ()

const std::vector< ScriptedTradeEventData > &	events () const

const std::vector< ScriptedTradeValueTypeData > &	numbers () const

const std::vector< ScriptedTradeValueTypeData > &	indices () const

const std::vector< ScriptedTradeValueTypeData > &	currencies () const

const std::vector< ScriptedTradeValueTypeData > &	daycounters () const

const std::map< std::string, ScriptedTradeScriptData > &	script () const

const std::string &	productTag () const

const std::string &	scriptName () const

const std::string &	simmProductClass () const

const std::string &	scheduleProductClass () const

const ScriptedTradeScriptData &	script (const std::string &purpose, const bool fallBackOnEmptyPurpose=true) const

Public Member Functions inherited from Trade
	Trade ()
	Default constructor. More...

	Trade (const string &tradeType, const Envelope &env=Envelope(), const TradeActions &ta=TradeActions())
	Base class constructor. More...

virtual	~Trade ()
	Default destructor. More...

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

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

void	reset ()
	Reset trade, clear all base class data. This does not reset accumulated timings for this trade. More...

void	resetPricingStats (const std::size_t numberOfPricings=0, const boost::timer::nanosecond_type cumulativePricingTime=0)
	Reset accumulated timings to given values. More...

string &	id ()
	Set the trade id. More...

void	setEnvelope (const Envelope &envelope)
	Set the envelope with counterparty and portfolio info. More...

void	setAdditionalData (const std::map< std::string, boost::any > &additionalData)

TradeActions &	tradeActions ()
	Set the trade actions. More...

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

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. More...

virtual const std::map< std::string, boost::any > &	additionalData () const
	returns all additional data returned by the trade once built More...

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. More...

virtual bool	hasCashflows () const

boost::timer::nanosecond_type	getCumulativePricingTime () const
	Get cumulative timing spent on pricing. More...

std::size_t	getNumberOfPricings () const
	Get number of pricings. More...

Public Member Functions inherited from XMLSerializable
virtual	~XMLSerializable ()

virtual void	fromXML (XMLNode *node)=0

virtual XMLNode *	toXML (XMLDocument &doc) const =0

void	fromFile (const std::string &filename)

void	toFile (const std::string &filename) const

void	fromXMLString (const std::string &xml)
	Parse from XML string. More...

std::string	toXMLString () const
	Parse from XML string. More...

Inspectors
std::string	currency_

std::string	fixingAmount_

TradeStrike	strike_

QuantLib::ext::shared_ptr< Underlying >	underlying_

std::string	startDate_

std::string	endDate_

OptionData	optionData_

BarrierData	barrier_

const std::string &	name () const

void	initIndices ()

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 ScriptedTrade
std::vector< ScriptedTradeEventData >	events_

std::vector< ScriptedTradeValueTypeData >	numbers_

std::vector< ScriptedTradeValueTypeData >	indices_

std::vector< ScriptedTradeValueTypeData >	currencies_

std::vector< ScriptedTradeValueTypeData >	daycounters_

std::map< std::string, ScriptedTradeScriptData >	script_

std::string	productTag_

std::string	scriptName_

std::string	simmProductClass_

std::string	scheduleProductClass_

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_

Detailed Description

Definition at line 36 of file windowbarrieroption.hpp.

Constructor & Destructor Documentation

◆ WindowBarrierOption() [1/2]

WindowBarrierOption ( const std::string & tradeType = "WindowBarrierOption" )

explicit

Definition at line 38 of file windowbarrieroption.hpp.

38: ScriptedTrade(tradeType) {}

ore::data::ScriptedTrade::ScriptedTrade

ScriptedTrade(const std::string &tradeType="ScriptedTrade", const Envelope &env=Envelope())

Definition: scriptedtrade.hpp:205

ore::data::Trade::tradeType

const string & tradeType() const

Definition: trade.hpp:133

◆ WindowBarrierOption() [2/2]

WindowBarrierOption	(	const std::string &	currency,
		const std::string &	fixingAmount,
		const TradeStrike &	strike,
		const QuantLib::ext::shared_ptr< Underlying > &	underlying,
		const std::string &	startDate,
		const std::string &	endDate,
		const OptionData &	optionData,
		const BarrierData &	barrier
	)

Definition at line 39 of file windowbarrieroption.hpp.

        : currency_(currency), fixingAmount_(fixingAmount), strike_(strike), underlying_(underlying),
          startDate_(startDate), endDate_(endDate), optionData_(optionData), barrier_(barrier) {
        initIndices();
    }

Here is the call graph for this function:

Member Function Documentation

◆ build()

void build ( const QuantLib::ext::shared_ptr< EngineFactory > & )

overridevirtual

Build QuantLib/QuantExt instrument, link pricing engine. If build() is called multiple times, reset() should be called between these calls.

Reimplemented from ScriptedTrade.

Definition at line 58 of file windowbarrieroption.cpp.

                                                                                   {
 
    // set script parameters
 
    clear();
    initIndices();
 
    if (strike_.currency().empty())
        strike_.setCurrency(currency_);
 
    currencies_.emplace_back("Currency", "PayCcy", currency_);
    numbers_.emplace_back("Number", "Quantity", fixingAmount_);
    numbers_.emplace_back("Number", "Strike", boost::lexical_cast<std::string>(strike_.value()));
    events_.emplace_back("StartDate", startDate_);
    events_.emplace_back("EndDate", endDate_);
 
    auto positionType = parsePositionType(optionData_.longShort());
    numbers_.emplace_back("Number", "LongShort", positionType == Position::Long ? "1" : "-1");
    numbers_.emplace_back("Number", "PutCall",
                          parseOptionType(optionData_.callPut()) == Option::Type::Call ? "1" : "-1");
 
    QL_REQUIRE(optionData_.exerciseDates().size() == 1, "WindowBarrierOption: one exercise date required, got " << optionData_.exerciseDates().size());
    events_.emplace_back("Expiry", optionData_.exerciseDates().front());
 
    std::string settlementDate = optionData_.exerciseDates().front();
    if(optionData_.paymentData()) {
        QL_REQUIRE(optionData_.paymentData()->dates().size() == 1,
                   "WindowBarrierOption: exactly one payment date required under PaymentData/Dates/Date");
    }
    events_.emplace_back("Settlement", settlementDate);
 
    std::string barrierType;
    QL_REQUIRE(barrier_.style().empty() || barrier_.style() == "American",
               "expected barrier style American, got " << barrier_.style());
    QL_REQUIRE(barrier_.levels().size() == 1,
               "WindowBarrierOption: exactly one barrier level required, got " << barrier_.levels().size());
    if (barrier_.type() == "UpAndOut")
        barrierType = "4";
    else if (barrier_.type() == "UpAndIn")
        barrierType = "2";
    else if (barrier_.type() == "DownAndOut")
        barrierType = "3";
    else if (barrier_.type() == "DownAndIn")
        barrierType = "1";
    else {
        QL_FAIL("WindowBarrierOption: invalid barrier level " << barrier_.type());
    }
    numbers_.emplace_back("Number", "BarrierType", barrierType);
    numbers_.emplace_back("Number", "BarrierLevel", boost::lexical_cast<std::string>(barrier_.levels().front().value()));
 
    // set product tag
 
    productTag_ = "SingleAssetOption({AssetClass})";
 
    // set script
 
    script_[""] = ScriptedTradeScriptData(
        window_barrier_script, "Option",
        {{"currentNotional", "currentNotional"},
         {"notionalCurrency", "PayCcy"},
         {"TriggerProbability", "TriggerProbability"},
         {"ExerciseProbability", "ExerciseProbability"}},
        {}, {}, {ScriptedTradeScriptData::CalibrationData("Underlying", {"Strike", "BarrierLevel"})});
 
    // build trade
 
    ScriptedTrade::build(factory, optionData_.premiumData(), positionType == QuantLib::Position::Long ? -1.0 : 1.0);
 
    additionalData_["isdaTransaction"] = string("");
}

Here is the call graph for this function:

◆ setIsdaTaxonomyFields()

void setIsdaTaxonomyFields ( )

overridevirtual

Reimplemented from ScriptedTrade.

Definition at line 129 of file windowbarrieroption.cpp.

                                                {
    ScriptedTrade::setIsdaTaxonomyFields();
 
    // ISDA taxonomy, asset class set in the base class build
    // asset class set in the base class already
    std::string assetClass = boost::any_cast<std::string>(additionalData_["isdaAssetClass"]);
    if (assetClass == "Equity") {
        additionalData_["isdaBaseProduct"] = string("Other");
        additionalData_["isdaSubProduct"] = string("Price Return Basic Performance");
    } else if (assetClass == "Commodity") {
        // isda taxonomy missing for this class, using the same as equity
        additionalData_["isdaBaseProduct"] = string("Other");
        additionalData_["isdaSubProduct"] = string("Price Return Basic Performance");
    } else if (assetClass == "Foreign Exchange") {
        additionalData_["isdaBaseProduct"] = string("Exotic");
        additionalData_["isdaSubProduct"] = string("Target");
    } else {
        WLOG("ISDA taxonomy incomplete for trade " << id());
    }
}

Here is the call graph for this function:

◆ fromXML()

void fromXML ( XMLNode * node )

overridevirtual

Reimplemented from ScriptedTrade.

Definition at line 154 of file windowbarrieroption.cpp.

                                               {
    Trade::fromXML(node);
    XMLNode* dataNode = XMLUtils::getChildNode(node, tradeType() + "Data");
    QL_REQUIRE(dataNode, tradeType() + "Data node not found");
    fixingAmount_ = XMLUtils::getChildValue(dataNode, "FixingAmount");
 
    currency_ = XMLUtils::getChildValue(dataNode, "Currency");
    strike_.fromXML(dataNode, true, false);
 
    XMLNode* tmp = XMLUtils::getChildNode(dataNode, "Underlying");
    if (!tmp)
        tmp = XMLUtils::getChildNode(dataNode, "Name");
    UnderlyingBuilder underlyingBuilder;
    underlyingBuilder.fromXML(tmp);
    underlying_ = underlyingBuilder.underlying();
 
    optionData_.fromXML(XMLUtils::getChildNode(dataNode, "OptionData"));
    startDate_ = XMLUtils::getChildValue(dataNode, "StartDate");
    endDate_ = XMLUtils::getChildValue(dataNode, "EndDate");
 
    auto barrierNode = XMLUtils::getChildNode(dataNode, "BarrierData");
    QL_REQUIRE(barrierNode, "No BarrierData node");
    barrier_.fromXML(barrierNode);
    initIndices();
}

Here is the call graph for this function:

◆ toXML()

XMLNode * toXML ( XMLDocument & doc ) const

overridevirtual

Reimplemented from ScriptedTrade.

Definition at line 180 of file windowbarrieroption.cpp.

                                                          {
    XMLNode* node = Trade::toXML(doc);
    XMLNode* dataNode = doc.allocNode(tradeType() + "Data");
    XMLUtils::appendNode(node, dataNode);
    XMLUtils::addChild(doc, dataNode, "FixingAmount", fixingAmount_);
    XMLUtils::addChild(doc, dataNode, "Currency", currency_);
 
    XMLUtils::appendNode(dataNode, strike_.toXML(doc));
 
    XMLUtils::appendNode(dataNode, underlying_->toXML(doc));
    XMLUtils::appendNode(dataNode, optionData_.toXML(doc));
    XMLUtils::addChild(doc, dataNode, "StartDate", startDate_);
    XMLUtils::addChild(doc, dataNode, "EndDate", endDate_);
    XMLUtils::appendNode(dataNode, barrier_.toXML(doc));
 
    return node;
}

Here is the call graph for this function:

◆ name()

const std::string & name ( ) const

Definition at line 53 of file windowbarrieroption.hpp.

53{ return underlying_->name(); }

◆ initIndices()

void initIndices ( )

private

Definition at line 150 of file windowbarrieroption.cpp.

                                      {
    indices_.emplace_back("Index", "Underlying", scriptedIndexName(underlying_));
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ currency_

std::string currency_

private

Definition at line 58 of file windowbarrieroption.hpp.

◆ fixingAmount_

std::string fixingAmount_

private

Definition at line 58 of file windowbarrieroption.hpp.

◆ strike_

TradeStrike strike_

private

Definition at line 59 of file windowbarrieroption.hpp.

◆ underlying_

QuantLib::ext::shared_ptr<Underlying> underlying_

private

Definition at line 60 of file windowbarrieroption.hpp.

◆ startDate_

std::string startDate_

private

Definition at line 61 of file windowbarrieroption.hpp.

◆ endDate_

std::string endDate_

private

Definition at line 61 of file windowbarrieroption.hpp.

◆ optionData_

OptionData optionData_

private

Definition at line 62 of file windowbarrieroption.hpp.

◆ barrier_

BarrierData barrier_

private

Definition at line 63 of file windowbarrieroption.hpp.

Public Member Functions

Inspectors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WindowBarrierOption() [1/2]

◆ WindowBarrierOption() [2/2]

Member Function Documentation

◆ build()

◆ setIsdaTaxonomyFields()

◆ fromXML()

◆ toXML()

◆ name()

◆ initIndices()

Member Data Documentation

◆ currency_

◆ fixingAmount_

◆ strike_

◆ underlying_

◆ startDate_

◆ endDate_

◆ optionData_

◆ barrier_