BondKey Class Reference

#include <QuantlibPlugin.hpp>

Public Member Functions
	BondKey (const char *issueDate, const char *maturityDate, const char *settlementDate, const Rate rate, const Frequency frequency, bool takeCopies=true)
	BondKey (const BondKey &that)
BondKey &	operator= (const BondKey &that)
const char *	toString ()
const char *	getIssueDate ()
const char *	getMaturityDate ()
const char *	getSettlementDate ()
Rate	getRate ()
Frequency	getFrequency ()

Friends
bool	operator< (const BondKey &lhs, const BondKey &rhs)
bool	operator== (const BondKey &lhs, const BondKey &rhs)
int	compare (BondKey &lhs, BondKey &rhs)
std::size_t	hash_value (const BondKey &x)

Detailed Description

The key used for bond lookups. This is slightly subtle: If takeCopies = false in the constructor then the object will just reference its string arguments, thus avoiding the need to do memory allocation. The downside of that is that those arguments must exist for the lifetime of the BondKey object. If you are unsure about that the just use takeCopies = true (the default).

Constructor & Destructor Documentation

BondKey() [1/2]

BondKey::BondKey	(	const char *	issueDate,
		const char *	maturityDate,
		const char *	settlementDate,
		const Rate	rate,
		const Frequency	frequency,
		bool	takeCopies = true
	)

BondKey Constructor

BondKey() [2/2]

BondKey::BondKey

(

const BondKey &

that

)

BondKey Copy Constructor

Member Function Documentation

getFrequency()

Frequency BondKey::getFrequency ( )

inline

get Frequency

getIssueDate()

const char * BondKey::getIssueDate ( )

inline

get issue date

getMaturityDate()

const char * BondKey::getMaturityDate ( )

inline

get Maturity date

getRate()

Rate BondKey::getRate ( )

inline

get rate

getSettlementDate()

const char * BondKey::getSettlementDate ( )

inline

get settlement date

operator=()

BondKey & BondKey::operator=

(

const BondKey &

that

)

BondKey assignment operator

toString()

const char * BondKey::toString

(

)

to string method

---

The documentation for this class was generated from the following file:

• QuantlibPlugin.hpp