Logo
Reference manual - version ored_version
Public Member Functions | Static Public Member Functions | List of all members
SyntheticCDO Class Reference

Serializable CDS Index Tranche (Synthetic CDO) More...

#include <ored/portfolio/cdo.hpp>

+ Inheritance diagram for SyntheticCDO:

Public Member Functions

 SyntheticCDO (const Envelope &env, const LegData &leg, const string &qualifier, const BasketData &basketData, double attachmentPoint, double detachmentPoint, const bool settlesAccrual=true, const QuantExt::CreditDefaultSwap::ProtectionPaymentTime protectionPaymentTime=QuantExt::CreditDefaultSwap::ProtectionPaymentTime::atDefault, const string &protectionStart=string(), const string &upfrontDate=string(), const Real upfrontFee=Null< Real >(), const bool rebatesAccrual=true, Real recoveryRate=Null< Real >())
 
virtual void build (const QuantLib::ext::shared_ptr< EngineFactory > &) override
 
const string & qualifier () const
 Inspectors.
 
const LegDataleg () const
 
const BasketDatabasketData () const
 
const double & attachmentPoint () const
 
const double & detachmentPoint () const
 
QuantExt::CreditDefaultSwap::ProtectionPaymentTime protectionPaymentTime () const
 
const string & protectionStart () const
 
const string & upfrontDate () const
 
const double & upfrontFee () const
 
bool settlesAccrual () const
 
bool rebatesAccrual () const
 
const Real & recoveryRate () const
 
bool useSensitivitySimplification () const
 
const std::map< std::string, Real > & basketConstituents () const
 
virtual void fromXML (XMLNode *node) override
 
virtual XMLNodetoXML (XMLDocument &doc) const override
 
std::string creditCurveIdWithTerm () const
 
void setIndexStartDateHint (const QuantLib::Date &d) const
 
const QuantLib::Date & indexStartDateHint () 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 std::map< std::string, RequiredFixings::FixingDatesfixings (const QuantLib::Date &settlementDate=QuantLib::Date()) const
 
const RequiredFixingsrequiredFixings () 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.
 
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)
 
TradeActionstradeActions ()
 Set the trade actions.
 
const string & id () const
 
const string & tradeType () 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 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 >
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.
 
virtual bool hasCashflows () const
 
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.
 

Static Public Member Functions

static vector< Time > extractTimeGridDefaultCurve (const QuantLib::Handle< QuantLib::DefaultProbabilityTermStructure > &dpts)
 
static QuantLib::Handle< QuantLib::DefaultProbabilityTermStructure > buildCalibratedConstiuentCurve (const QuantLib::Handle< QuantLib::DefaultProbabilityTermStructure > &curve, const QuantLib::ext::shared_ptr< SimpleQuote > &calibrationFactor)
 

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< InstrumentWrapperinstrument_
 
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 CDS Index Tranche (Synthetic CDO)

Member Function Documentation

◆ build()

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

Implements Trade.

◆ creditCurveIdWithTerm()

std::string creditCurveIdWithTerm ( ) const

Get credit curve id with term suffix "_5Y". If the creditCurveId contains such a suffix already this is used. Otherwise we try to imply it from the schedule. If that is not possible, the creditCurveId without tenor is returned.

◆ setIndexStartDateHint()

void setIndexStartDateHint ( const QuantLib::Date &  d) const

If set this is used to derive the term instead of the schedule start date. A concession to bad trade setups really, where the start date is not set to the index effective date

◆ indexStartDateHint()

const QuantLib::Date& indexStartDateHint ( ) const

Get the index start date hint, or null if it was never set