Serializable Equity Position. More...

#include <ored/portfolio/equityposition.hpp>

Inheritance diagram for EquityPosition:

Collaboration diagram for EquityPosition:

Public Member Functions
	EquityPosition ()

	EquityPosition (const Envelope &env, const EquityPositionData &data)

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

void	fromXML (XMLNode *node) override

XMLNode *	toXML (XMLDocument &doc) const override

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

const EquityPositionData &	data () const

const std::vector< QuantLib::ext::shared_ptr< QuantExt::EquityIndex2 > > &	indices () const

const std::vector< Real > &	weights () const

bool	isSingleCurrency () const

void	setNpvCurrencyConversion (const std::string &ccy, const Handle< Quote > &conversion)

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

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

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

Private Attributes
EquityPositionData	data_

std::vector< QuantLib::ext::shared_ptr< QuantExt::EquityIndex2 > >	indices_

std::vector< Real >	weights_

std::vector< Handle< Quote > >	fxConversion_

bool	isSingleCurrency_

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_

Detailed Description

Serializable Equity Position.

Definition at line 52 of file equityposition.hpp.

Constructor & Destructor Documentation

◆ EquityPosition() [1/2]

EquityPosition ( )

Definition at line 54 of file equityposition.hpp.

54: Trade("EquityPosition") {}

ore::data::Trade::Trade

Trade()

Default constructor.

Definition: trade.hpp:59

◆ EquityPosition() [2/2]

EquityPosition	(	const Envelope &	env,
		const EquityPositionData &	data
	)

Definition at line 55 of file equityposition.hpp.

55: Trade("EquityPosition", env), data_(data) {}

ore::data::EquityPosition::data

const EquityPositionData & data() const

Definition: equityposition.hpp:65

ore::data::EquityPosition::data_

EquityPositionData data_

Definition: equityposition.hpp:75

Member Function Documentation

◆ build()

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

override

Definition at line 48 of file equityposition.cpp.

                                                                                           {
 
    // ISDA taxonomy: not a derivative, but define the asset class at least
    // so that we can determine a TRS asset class that has an EQ position underlying
    additionalData_["isdaAssetClass"] = string("Equity");
    additionalData_["isdaBaseProduct"] = string("");
    additionalData_["isdaSubProduct"] = string("");
    additionalData_["isdaTransaction"] = string("");
 
    DLOG("EquityPosition::build() called for " << id());
    QL_REQUIRE(!data_.underlyings().empty(), "EquityPosition::build(): no underlyings given");
    indices_.clear();
    weights_.clear();
    fxConversion_.clear();
 
    std::vector<std::string> currencies;
    for (auto const& u : data_.underlyings()) {
        indices_.push_back(
            *engineFactory->market()->equityCurve(u.name(), engineFactory->configuration(MarketContext::pricing)));
        weights_.push_back(u.weight());
        QL_REQUIRE(!indices_.back()->currency().empty(),
                   "did not get currency for equity name '" << u.name() << "', is this set up?");
        currencies.push_back(indices_.back()->currency().code());
    }
 
    // get fx quotes
 
    isSingleCurrency_ = true;
    npvCurrency_ = currencies.front();
    for (auto const& c : currencies) {
        // we use fxSpot() as opposed to fxRate() here to ensure consistency between NPV() and the fixing of an
        // equivalent index representing the same basket
        fxConversion_.push_back(
            engineFactory->market()->fxSpot(c + npvCurrency_, engineFactory->configuration(MarketContext::pricing)));
        if (npvCurrency_ != c)
            isSingleCurrency_ = false;
    }
 
    // set instrument
    auto qlInstr =
        QuantLib::ext::make_shared<EquityPositionInstrumentWrapper>(data_.quantity(), indices_, weights_, fxConversion_);
    qlInstr->setPricingEngine(QuantLib::ext::make_shared<EquityPositionInstrumentWrapperEngine>());
    setSensitivityTemplate(std::string());
    instrument_ = QuantLib::ext::make_shared<VanillaInstrument>(qlInstr);
 
    // no sensible way to set these members
    maturity_ = Date::maxDate();
    notional_ = Null<Real>();
    notionalCurrency_ = "";
    
    // leave legs empty
}

Here is the call graph for this function:

◆ fromXML()

void fromXML ( XMLNode * node )

overridevirtual

Reimplemented from Trade.

Definition at line 107 of file equityposition.cpp.

                                          {
    Trade::fromXML(node);
    data_.fromXML(XMLUtils::getChildNode(node, "EquityPositionData"));
}

Here is the call graph for this function:

◆ toXML()

XMLNode * toXML ( XMLDocument & doc ) const

overridevirtual

Reimplemented from Trade.

Definition at line 112 of file equityposition.cpp.

                                                     {
    XMLNode* node = Trade::toXML(doc);
    XMLUtils::appendNode(node, data_.toXML(doc));
    return node;
}

Here is the call graph for this function:

◆ underlyingIndices()

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

overridevirtual

Reimplemented from Trade.

Definition at line 119 of file equityposition.cpp.

                                                                                                               {
    std::map<AssetClass, std::set<std::string>> result;
    for (auto const& u : data_.underlyings()) {
        result[AssetClass::EQ].insert(u.name());
    }
    return result;
}

Here is the call graph for this function:

◆ data()

const EquityPositionData & data ( ) const

Definition at line 65 of file equityposition.hpp.

65{ return data_; }

◆ indices()

const std::vector< QuantLib::ext::shared_ptr< QuantExt::EquityIndex2 > > & indices ( ) const

Definition at line 66 of file equityposition.hpp.

66{ return indices_; }

◆ weights()

const std::vector< Real > & weights ( ) const

Definition at line 67 of file equityposition.hpp.

67{ return weights_; }

◆ isSingleCurrency()

bool isSingleCurrency ( ) const

Definition at line 68 of file equityposition.hpp.

68{ return isSingleCurrency_; }

◆ setNpvCurrencyConversion()

void setNpvCurrencyConversion	(	const std::string &	ccy,
		const Handle< Quote > &	conversion
	)

we allow to set the npv currency to a different currency than the default npv currency = first asset's currency; in this case a conversion rate from the default to the new currency has to be provided

Definition at line 101 of file equityposition.cpp.

                                                                                                   {
    npvCurrency_ = ccy;
    QuantLib::ext::static_pointer_cast<EquityPositionInstrumentWrapper>(instrument_->qlInstrument())
        ->setNpvCurrencyConversion(conversion);
}

Member Data Documentation

◆ data_

EquityPositionData data_

private

Definition at line 75 of file equityposition.hpp.

◆ indices_

std::vector<QuantLib::ext::shared_ptr<QuantExt::EquityIndex2> > indices_

private

Definition at line 77 of file equityposition.hpp.

◆ weights_

std::vector<Real> weights_

private

Definition at line 78 of file equityposition.hpp.

◆ fxConversion_

std::vector<Handle<Quote> > fxConversion_

private

Definition at line 79 of file equityposition.hpp.

◆ isSingleCurrency_

bool isSingleCurrency_

private

Definition at line 80 of file equityposition.hpp.

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EquityPosition() [1/2]

◆ EquityPosition() [2/2]

Member Function Documentation

◆ build()

◆ fromXML()

◆ toXML()

◆ underlyingIndices()

◆ data()

◆ indices()

◆ weights()

◆ isSingleCurrency()

◆ setNpvCurrencyConversion()

Member Data Documentation

◆ data_

◆ indices_

◆ weights_

◆ fxConversion_

◆ isSingleCurrency_