SwaptionQuote Class Reference

Swaption data class. More...

#include <ored/marketdata/marketdatum.hpp>

Inheritance diagram for SwaptionQuote:

Collaboration diagram for SwaptionQuote:

Public Member Functions
	SwaptionQuote ()
	SwaptionQuote (Real value, Date asofDate, const string &name, QuoteType quoteType, string ccy, Period expiry, Period term, string dimension, Real strike=0.0, const std::string &quoteTag=std::string(), bool isPayer=true)
	Constructor. More...
QuantLib::ext::shared_ptr< MarketDatum >	clone () override
	Make a copy of the market datum. More...
Public Member Functions inherited from MarketDatum
	MarketDatum ()
	MarketDatum (Real value, Date asofDate, const string &name, QuoteType quoteType, InstrumentType instrumentType)
	Constructor. More...
virtual	~MarketDatum ()
	Default destructor. More...
virtual QuantLib::ext::shared_ptr< MarketDatum >	clone ()
	Make a copy of the market datum. More...
const string &	name () const
const Handle< Quote > &	quote () const
Date	asofDate () const
InstrumentType	instrumentType () const
QuoteType	quoteType () const

Inspectors
string	ccy_
Period	expiry_
Period	term_
string	dimension_
Real	strike_
string	quoteTag_
bool	isPayer_
class	boost::serialization::access
	Serialization. More...
const string &	ccy () const
const Period &	expiry () const
const Period &	term () const
const string &	dimension () const
Real	strike ()
const string &	quoteTag () const
bool	isPayer () const
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

Additional Inherited Members
Public Types inherited from MarketDatum
enum class	InstrumentType {   ZERO , DISCOUNT , MM , MM_FUTURE ,   OI_FUTURE , FRA , IMM_FRA , IR_SWAP ,   BASIS_SWAP , BMA_SWAP , CC_BASIS_SWAP , CC_FIX_FLOAT_SWAP ,   CDS , CDS_INDEX , FX_SPOT , FX_FWD ,   HAZARD_RATE , RECOVERY_RATE , SWAPTION , CAPFLOOR ,   FX_OPTION , ZC_INFLATIONSWAP , ZC_INFLATIONCAPFLOOR , YY_INFLATIONSWAP ,   YY_INFLATIONCAPFLOOR , SEASONALITY , EQUITY_SPOT , EQUITY_FWD ,   EQUITY_DIVIDEND , EQUITY_OPTION , BOND , BOND_OPTION ,   INDEX_CDS_OPTION , COMMODITY_SPOT , COMMODITY_FWD , CORRELATION ,   COMMODITY_OPTION , CPR , RATING , NONE }
	Supported market instrument types. More...
enum class	QuoteType {   BASIS_SPREAD , CREDIT_SPREAD , CONV_CREDIT_SPREAD , YIELD_SPREAD ,   HAZARD_RATE , RATE , RATIO , PRICE ,   RATE_LNVOL , RATE_NVOL , RATE_SLNVOL , BASE_CORRELATION ,   SHIFT , TRANSITION_PROBABILITY , NONE }
	Supported market quote types. More...
Protected Attributes inherited from MarketDatum
Handle< Quote >	quote_
Date	asofDate_
string	name_
InstrumentType	instrumentType_
QuoteType	quoteType_

Detailed Description

Swaption data class.

This class holds single market points of type

• SWAPTION Specific data comprise
• currency
• expiry
• term
• at-the-money flag (is an at-the-money swaption quote?)
• strike

Definition at line 841 of file marketdatum.hpp.

Constructor & Destructor Documentation

SwaptionQuote() [1/2]

SwaptionQuote

(

)

Definition at line 843 of file marketdatum.hpp.

{}

SwaptionQuote() [2/2]

SwaptionQuote	(	Real	value,
		Date	asofDate,
		const string &	name,
		QuoteType	quoteType,
		string	ccy,
		Period	expiry,
		Period	term,
		string	dimension,
		Real	strike = 0.0,
		const std::string &	quoteTag = std::string(),
		bool	isPayer = true
	)

Constructor.

Definition at line 845 of file marketdatum.hpp.

        : MarketDatum(value, asofDate, name, quoteType, InstrumentType::SWAPTION), ccy_(ccy), expiry_(expiry),
          term_(term), dimension_(dimension), strike_(strike), quoteTag_(quoteTag), isPayer_(isPayer) {}

Member Function Documentation

clone()

QuantLib::ext::shared_ptr< MarketDatum > clone ( )

overridevirtual

Make a copy of the market datum.

Reimplemented from MarketDatum.

Definition at line 852 of file marketdatum.hpp.

                                                        {
        return QuantLib::ext::make_shared<SwaptionQuote>(quote_->value(), asofDate_, name_, quoteType_, ccy_, expiry_, term_,
                                                 dimension_, strike_, quoteTag_, isPayer_);
    }

ccy()

const string & ccy

(

)

const

Definition at line 859 of file marketdatum.hpp.

{ return ccy_; }

expiry()

const Period & expiry

(

)

const

Definition at line 860 of file marketdatum.hpp.

{ return expiry_; }

term()

const Period & term

(

)

const

Definition at line 861 of file marketdatum.hpp.

{ return term_; }

dimension()

const string & dimension

(

)

const

Definition at line 862 of file marketdatum.hpp.

{ return dimension_; }

strike()

Real strike

(

)

Definition at line 863 of file marketdatum.hpp.

{ return strike_; }

quoteTag()

const string & quoteTag

(

)

const

Definition at line 864 of file marketdatum.hpp.

{ return quoteTag_; }

isPayer()

bool isPayer

(

)

const

Definition at line 865 of file marketdatum.hpp.

{ return isPayer_; }

serialize()

template void serialize ( Archive &  ar, const unsigned int  version  )

private

Definition at line 452 of file marketdatum.cpp.

                                                                                              {
    ar& boost::serialization::base_object<MarketDatum>(*this);
    ar& ccy_;
    ar& expiry_;
    ar& term_;
    ar& dimension_;
    ar& strike_;
    ar& quoteTag_;
    ar& isPayer_;
}

Friends And Related Function Documentation

boost::serialization::access

friend class boost::serialization::access

friend

Serialization.

Definition at line 876 of file marketdatum.hpp.

Member Data Documentation

ccy_

string ccy_

private

Definition at line 868 of file marketdatum.hpp.

expiry_

Period expiry_

private

Definition at line 869 of file marketdatum.hpp.

term_

Period term_

private

Definition at line 870 of file marketdatum.hpp.

dimension_

string dimension_

private

Definition at line 871 of file marketdatum.hpp.

strike_

Real strike_

private

Definition at line 872 of file marketdatum.hpp.

quoteTag_

string quoteTag_

private

Definition at line 873 of file marketdatum.hpp.

isPayer_

bool isPayer_

private

Definition at line 874 of file marketdatum.hpp.