SecuritySpreadConvention Class Reference

Container for storing Bond Spread Rate conventions. More...

#include <ored/configuration/conventions.hpp>

Inheritance diagram for SecuritySpreadConvention:

Collaboration diagram for SecuritySpreadConvention:

Public Member Functions
Constructors
	SecuritySpreadConvention ()
	Default constructor. More...
	SecuritySpreadConvention (const string &id, const string &dayCounter, const string &compounding, const string &compoundingFrequency)
	SecuritySpreadConvention (const string &id, const string &dayCounter, const string &tenorCalendar, const string &compounding="Continuous", const string &compoundingFrequency="Annual", const string &spotLag="", const string &spotCalendar="", const string &rollConvention="", const string &eom="")
Inspectors
const DayCounter &	dayCounter () const
	Zero rate day counter. More...
const Calendar &	tenorCalendar () const
	Return the calendar used for converting tenor points into dates. More...
Compounding	compounding () const
	Zero rate compounding. More...
Frequency	compoundingFrequency () const
	Zero rate compounding frequency. More...
Natural	spotLag () const
	Zero rate spot lag. More...
const Calendar &	spotCalendar () const
	Calendar used for spot date adjustment. More...
BusinessDayConvention	rollConvention () const
	Business day convention used in converting tenor points into dates. More...
bool	eom ()
	End of month adjustment. More...
bool	tenorBased ()
	Flag to indicate whether the Zero Rate convention is based on a tenor input. More...
Public Member Functions inherited from Convention
virtual	~Convention ()
	Default destructor. More...
const string &	id () const
Type	type () const
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...

Serialisation
DayCounter	dayCounter_
Calendar	tenorCalendar_
Compounding	compounding_
Frequency	compoundingFrequency_
Natural	spotLag_
Calendar	spotCalendar_
BusinessDayConvention	rollConvention_
bool	eom_
bool	tenorBased_
string	strDayCounter_
string	strTenorCalendar_
string	strCompounding_
string	strCompoundingFrequency_
string	strSpotLag_
string	strSpotCalendar_
string	strRollConvention_
string	strEom_
virtual void	fromXML (XMLNode *node) override
virtual XMLNode *	toXML (XMLDocument &doc) const override
virtual void	build () override

Additional Inherited Members
Public Types inherited from Convention
enum class	Type {   Zero , Deposit , Future , FRA ,   OIS , Swap , AverageOIS , TenorBasisSwap ,   TenorBasisTwoSwap , BMABasisSwap , FX , CrossCcyBasis ,   CrossCcyFixFloat , CDS , IborIndex , OvernightIndex ,   SwapIndex , ZeroInflationIndex , InflationSwap , SecuritySpread ,   CMSSpreadOption , CommodityForward , CommodityFuture , FxOption ,   BondYield }
	Supported convention types. More...
Protected Member Functions inherited from Convention
	Convention ()
	Convention (const string &id, Type type)
Protected Attributes inherited from Convention
Type	type_
string	id_

Detailed Description

Container for storing Bond Spread Rate conventions.

Definition at line 1148 of file conventions.hpp.

Constructor & Destructor Documentation

SecuritySpreadConvention() [1/3]

SecuritySpreadConvention

(

)

Default constructor.

Definition at line 1153 of file conventions.hpp.

{}

SecuritySpreadConvention() [2/3]

SecuritySpreadConvention	(	const string &	id,
		const string &	dayCounter,
		const string &	compounding,
		const string &	compoundingFrequency
	)

Definition at line 1337 of file conventions.cpp.

    : Convention(id, Type::SecuritySpread), tenorBased_(false), strDayCounter_(dayCounter),
      strCompounding_(compounding), strCompoundingFrequency_(compoundingFrequency) {
    build();
}

Here is the call graph for this function:

SecuritySpreadConvention() [3/3]

SecuritySpreadConvention	(	const string &	id,
		const string &	dayCounter,
		const string &	tenorCalendar,
		const string &	compounding = "Continuous",
		const string &	compoundingFrequency = "Annual",
		const string &	spotLag = "",
		const string &	spotCalendar = "",
		const string &	rollConvention = "",
		const string &	eom = ""
	)

Definition at line 1344 of file conventions.cpp.

    : Convention(id, Type::SecuritySpread), tenorBased_(true), strDayCounter_(dayCounter),
      strTenorCalendar_(tenorCalendar), strCompounding_(compounding), strCompoundingFrequency_(compoundingFrequency),
      strSpotLag_(spotLag), strSpotCalendar_(spotCalendar), strRollConvention_(rollConvention), strEom_(eom) {
    build();
}

Here is the call graph for this function:

Member Function Documentation

dayCounter()

const DayCounter & dayCounter

(

)

const

Zero rate day counter.

Definition at line 1165 of file conventions.hpp.

{ return dayCounter_; }

tenorCalendar()

const Calendar & tenorCalendar

(

)

const

Return the calendar used for converting tenor points into dates.

Definition at line 1167 of file conventions.hpp.

{ return tenorCalendar_; }

compounding()

Compounding compounding

(

)

const

Zero rate compounding.

Definition at line 1169 of file conventions.hpp.

{ return compounding_; }

compoundingFrequency()

Frequency compoundingFrequency

(

)

const

Zero rate compounding frequency.

Definition at line 1171 of file conventions.hpp.

{ return compoundingFrequency_; }

spotLag()

Natural spotLag

(

)

const

Zero rate spot lag.

Definition at line 1173 of file conventions.hpp.

{ return spotLag_; }

spotCalendar()

const Calendar & spotCalendar

(

)

const

Calendar used for spot date adjustment.

Definition at line 1175 of file conventions.hpp.

{ return spotCalendar_; }

rollConvention()

BusinessDayConvention rollConvention

(

)

const

Business day convention used in converting tenor points into dates.

Definition at line 1177 of file conventions.hpp.

{ return rollConvention_; }

eom()

bool eom

(

)

End of month adjustment.

Definition at line 1179 of file conventions.hpp.

{ return eom_; }

tenorBased()

bool tenorBased

(

)

Flag to indicate whether the Zero Rate convention is based on a tenor input.

Definition at line 1181 of file conventions.hpp.

{ return tenorBased_; }

fromXML()

void fromXML ( XMLNode *  node )

overridevirtual

Implements XMLSerializable.

Definition at line 1368 of file conventions.cpp.

                                                    {
 
    XMLUtils::checkNode(node, "BondSpread");
    type_ = Type::SecuritySpread;
    id_ = XMLUtils::getChildValue(node, "Id", true);
    tenorBased_ = XMLUtils::getChildValueAsBool(node, "TenorBased", true);
 
    // Get string values from xml
    strDayCounter_ = XMLUtils::getChildValue(node, "DayCounter", true);
    strCompoundingFrequency_ = XMLUtils::getChildValue(node, "CompoundingFrequency", false);
    strCompounding_ = XMLUtils::getChildValue(node, "Compounding", false);
    if (tenorBased_) {
        strTenorCalendar_ = XMLUtils::getChildValue(node, "TenorCalendar", true);
        strSpotLag_ = XMLUtils::getChildValue(node, "SpotLag", false);
        strSpotCalendar_ = XMLUtils::getChildValue(node, "SpotCalendar", false);
        strRollConvention_ = XMLUtils::getChildValue(node, "RollConvention", false);
        strEom_ = XMLUtils::getChildValue(node, "EOM", false);
    }
    build();
}

Here is the call graph for this function:

toXML()

XMLNode * toXML ( XMLDocument &  doc ) const

overridevirtual

Implements XMLSerializable.

Definition at line 1389 of file conventions.cpp.

                                                               {
 
    XMLNode* node = doc.allocNode("BondSpread");
    XMLUtils::addChild(doc, node, "Id", id_);
    XMLUtils::addChild(doc, node, "TenorBased", tenorBased_);
    XMLUtils::addChild(doc, node, "DayCounter", strDayCounter_);
    if (!strCompoundingFrequency_.empty())
        XMLUtils::addChild(doc, node, "CompoundingFrequency", strCompoundingFrequency_);
    if (!strCompounding_.empty())
        XMLUtils::addChild(doc, node, "Compounding", strCompounding_);
    if (tenorBased_) {
        XMLUtils::addChild(doc, node, "TenorCalendar", strTenorCalendar_);
        if (!strSpotLag_.empty())
            XMLUtils::addChild(doc, node, "SpotLag", strSpotLag_);
        if (!strSpotCalendar_.empty())
            XMLUtils::addChild(doc, node, "SpotCalendar", strSpotCalendar_);
        if (!strRollConvention_.empty())
            XMLUtils::addChild(doc, node, "RollConvention", strRollConvention_);
        if (!strEom_.empty())
            XMLUtils::addChild(doc, node, "EOM", strEom_);
    }
 
    return node;
}

Here is the call graph for this function:

build()

void build ( )

overridevirtual

Implements Convention.

Definition at line 1355 of file conventions.cpp.

                                     {
    dayCounter_ = parseDayCounter(strDayCounter_);
    compounding_ = strCompounding_.empty() ? Continuous : parseCompounding(strCompounding_);
    compoundingFrequency_ = strCompoundingFrequency_.empty() ? Annual : parseFrequency(strCompoundingFrequency_);
    if (tenorBased_) {
        tenorCalendar_ = parseCalendar(strTenorCalendar_);
        spotLag_ = strSpotLag_.empty() ? 0 : lexical_cast<Natural>(strSpotLag_);
        spotCalendar_ = strSpotCalendar_.empty() ? NullCalendar() : parseCalendar(strSpotCalendar_);
        rollConvention_ = strRollConvention_.empty() ? Following : parseBusinessDayConvention(strRollConvention_);
        eom_ = strEom_.empty() ? false : parseBool(strEom_);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

dayCounter_

DayCounter dayCounter_

private

Definition at line 1192 of file conventions.hpp.

tenorCalendar_

Calendar tenorCalendar_

private

Definition at line 1193 of file conventions.hpp.

compounding_

Compounding compounding_

private

Definition at line 1194 of file conventions.hpp.

compoundingFrequency_

Frequency compoundingFrequency_

private

Definition at line 1195 of file conventions.hpp.

spotLag_

Natural spotLag_

private

Definition at line 1196 of file conventions.hpp.

spotCalendar_

Calendar spotCalendar_

private

Definition at line 1197 of file conventions.hpp.

rollConvention_

BusinessDayConvention rollConvention_

private

Definition at line 1198 of file conventions.hpp.

eom_

bool eom_

private

Definition at line 1199 of file conventions.hpp.

tenorBased_

bool tenorBased_

private

Definition at line 1200 of file conventions.hpp.

strDayCounter_

string strDayCounter_

private

Definition at line 1203 of file conventions.hpp.

strTenorCalendar_

string strTenorCalendar_

private

Definition at line 1204 of file conventions.hpp.

strCompounding_

string strCompounding_

private

Definition at line 1205 of file conventions.hpp.

strCompoundingFrequency_

string strCompoundingFrequency_

private

Definition at line 1206 of file conventions.hpp.

strSpotLag_

string strSpotLag_

private

Definition at line 1207 of file conventions.hpp.

strSpotCalendar_

string strSpotCalendar_

private

Definition at line 1208 of file conventions.hpp.

strRollConvention_

string strRollConvention_

private

Definition at line 1209 of file conventions.hpp.

strEom_

string strEom_

private

Definition at line 1210 of file conventions.hpp.