com::ftlabs::fisa::Redemption Class Reference

A class to represent any redemption date and rate. More...

#include <Redemption.h>

List of all members.

Public Member Functions
	Redemption (void)
	This will initialize a Redemption with an empty date, a value of 0.0, and a null lastInterestDate.
	Redemption (const FISADate &date, double value)
	This will initialize a Redemption with the provided date and value and will set lastInterestDate to null.
	Redemption (const FISADate &date, double value, const FISADate &lastInterestDate)
	This will initialize a Redemption with the provided date, value, and lastInterestDate.
	Redemption (const Redemption &redemption)
virtual	~Redemption (void)
Redemption &	operator= (const Redemption &redemption)
bool	operator== (const Redemption &redemption) const
bool	operator!= (const Redemption &redemption) const
bool	operator< (const Redemption &redemption) const
bool	operator> (const Redemption &redemption) const
bool	operator<= (const Redemption &redemption) const
bool	operator>= (const Redemption &redemption) const
const FISADate &	getDate (void) const
	Get the redemption date.
void	setDate (const FISADate &date)
	Set the redemption date.
double	getValue (void) const
	Get the redemption value.
void	setValue (double value)
	Set the redemption value.
const FISADate *	getLastInterestDate (void) const
	Get the last interest date, which would be the interest date just prior to redemption.
void	setLastInterestDate (const FISADate *lastInterestDate)
	Set or clear the last interest date, which would be the interest date just prior to redemption.
const FISADate *	generateLastInterestDate (const FISADate &synchronizeDate, const InterestFrequency &interestFrequency, bool eomAdjust)
	Generates a date that would be the interest/dividend date just prior to redemption. This method stores the generated lastInterestDate to this Redemption object and returns the result.
bool	isEmpty (void) const
Private Attributes
FISADate	date
double	value
FISADate *	lastInterestDate

---

Detailed Description

A class to represent any redemption date and rate.

This could be maturity, a call, a put etc...

---

Constructor & Destructor Documentation

com::ftlabs::fisa::Redemption::Redemption

(

void

)

This will initialize a Redemption with an empty date, a value of 0.0, and a null lastInterestDate.

com::ftlabs::fisa::Redemption::Redemption	(	const FISADate &	date,
		double	value
	)

This will initialize a Redemption with the provided date and value and will set lastInterestDate to null.

Parameters:

	date	the date of this Redemption.
	value	the redemtpion value.

com::ftlabs::fisa::Redemption::Redemption	(	const FISADate &	date,
		double	value,
		const FISADate &	lastInterestDate
	)

This will initialize a Redemption with the provided date, value, and lastInterestDate.

Parameters:

	date	the date of this Redemption.
	value	the redemption value.
	lastInterestDate	the interest date just prior to redemption. This value is usually only needed if a Security has an odd last period.

com::ftlabs::fisa::Redemption::Redemption

(

const Redemption &

redemption

)

virtual com::ftlabs::fisa::Redemption::~Redemption

(

void

)

[virtual]

---

Member Function Documentation

Redemption& com::ftlabs::fisa::Redemption::operator=

(

const Redemption &

redemption

)

bool com::ftlabs::fisa::Redemption::operator==

(

const Redemption &

redemption

)

const

bool com::ftlabs::fisa::Redemption::operator!=

(

const Redemption &

redemption

)

const

bool com::ftlabs::fisa::Redemption::operator<

(

const Redemption &

redemption

)

const

bool com::ftlabs::fisa::Redemption::operator>

(

const Redemption &

redemption

)

const

bool com::ftlabs::fisa::Redemption::operator<=

(

const Redemption &

redemption

)

const

bool com::ftlabs::fisa::Redemption::operator>=

(

const Redemption &

redemption

)

const

const FISADate& com::ftlabs::fisa::Redemption::getDate

(

void

)

const

Get the redemption date.

Returns:

the redemption date.

void com::ftlabs::fisa::Redemption::setDate

(

const FISADate &

date

)

Set the redemption date.

Parameters:

date

a redemption date.

double com::ftlabs::fisa::Redemption::getValue

(

void

)

const

Get the redemption value.

Returns:

the redemption value.

void com::ftlabs::fisa::Redemption::setValue

(

double

value

)

Set the redemption value.

Parameters:

value

the redemption value.

const FISADate* com::ftlabs::fisa::Redemption::getLastInterestDate

(

void

)

const

Get the last interest date, which would be the interest date just prior to redemption.

Returns:

The lastInterestDate if set, otherwise will return 0(NULL).

void com::ftlabs::fisa::Redemption::setLastInterestDate

(

const FISADate *

lastInterestDate

)

Set or clear the last interest date, which would be the interest date just prior to redemption.

Parameters:

lastInterestDate

a pointer to the lastInterestDate, or NULL. If the pointer is not zero (NULL), then a copy is made of the object referenced by the pointer and the pointers value is not stored.

const FISADate* com::ftlabs::fisa::Redemption::generateLastInterestDate	(	const FISADate &	synchronizeDate,
		const InterestFrequency &	interestFrequency,
		bool	eomAdjust
	)

Generates a date that would be the interest/dividend date just prior to redemption. This method stores the generated lastInterestDate to this Redemption object and returns the result.

Parameters:

synchronizeDate

a date to synchronize the lastInterestDate to. This will usually be a datedDate, firstInterestDate, or dividendPayDate, but this could also be the redemption date.

Parameters:

	interestFrequency	the interestFrequency to use.
	eomAdjust	Determines whether or not the end of month adjust rule is used.

Returns:

a pointer to the generated lastInterestDate. The lastInterestDate will be deleted upon destruction of this Redemption, or when overwritten with another call to generateLastInterestDate, or setLastInterestDate.

bool com::ftlabs::fisa::Redemption::isEmpty

(

void

)

const

---

Member Data Documentation

FISADate com::ftlabs::fisa::Redemption::date [private]

double com::ftlabs::fisa::Redemption::value [private]

FISADate* com::ftlabs::fisa::Redemption::lastInterestDate [private]

---

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

• C:/Development/FTL/c++/FISA/FISA/Redemption.h

---