com::ftlabs::fisa::PeriodicInterestPaymentSecurity

com::ftlabs::fisa::PeriodicInterestPaymentSecurity Class Reference

#include <PeriodicInterestPaymentSecurity.h>

Inheritance diagram for com::ftlabs::fisa::PeriodicInterestPaymentSecurity:


Public Member Functions
const InterestFrequency &	getInterestFrequency (void) const
	Get the interest frequency.
void	setInterestFrequency (const InterestFrequency &interestFrequency)
	Set the interestFrequency.
const int	getInterestFrequencyValue (void) const
	Get the interest frequency as an integer value.
const FISADate *	getFirstInterestDate (void) const
	Get the firstInterestDate.
void	setFirstInterestDate (const FISADate *firstInterestDate)
	Set the firstInterestDate.
FISADate	getNextInterestPaymentDate (const FISADate &date)
	Get the next interest payment date on or after the provided date.
Protected Member Functions
	PeriodicInterestPaymentSecurity (const Market &market, const Security::ClassID &classID)
	PeriodicInterestPaymentSecurity (const PeriodicInterestPaymentSecurity &security)
virtual	~PeriodicInterestPaymentSecurity (void)
PeriodicInterestPaymentSecurity &	operator= (const PeriodicInterestPaymentSecurity &security)
Private Attributes
const InterestFrequency *	interestFrequency
FISADate *	firstInterestDate

Constructor & Destructor Documentation

com::ftlabs::fisa::PeriodicInterestPaymentSecurity::PeriodicInterestPaymentSecurity	(	const Market &	market,
		const Security::ClassID &	classID
	)			`[protected]`

com::ftlabs::fisa::PeriodicInterestPaymentSecurity::PeriodicInterestPaymentSecurity ( const PeriodicInterestPaymentSecurity & security ) [protected]

virtual com::ftlabs::fisa::PeriodicInterestPaymentSecurity::~PeriodicInterestPaymentSecurity ( void ) [protected, virtual]

Member Function Documentation

PeriodicInterestPaymentSecurity& com::ftlabs::fisa::PeriodicInterestPaymentSecurity::operator= ( const PeriodicInterestPaymentSecurity & security ) [protected]

const InterestFrequency& com::ftlabs::fisa::PeriodicInterestPaymentSecurity::getInterestFrequency ( void ) const

Get the interest frequency.

void com::ftlabs::fisa::PeriodicInterestPaymentSecurity::setInterestFrequency ( const InterestFrequency & interestFrequency )

Set the interestFrequency.

Parameters:

interestFrequency

The interestFrequency.

const int com::ftlabs::fisa::PeriodicInterestPaymentSecurity::getInterestFrequencyValue ( void ) const

Get the interest frequency as an integer value.

const FISADate* com::ftlabs::fisa::PeriodicInterestPaymentSecurity::getFirstInterestDate ( void ) const

Get the firstInterestDate.

Returns:: A pointer to the firstInterestDate, or 0(NULL) if none has been set.

void com::ftlabs::fisa::PeriodicInterestPaymentSecurity::setFirstInterestDate ( const FISADate * firstInterestDate )

Set the firstInterestDate.

Parameters:

firstInterestDate

A pointer to the firstInterestDate, or 0(NULL). If firstInterestDate does not equal 0, then a copy of the referenced object is made, and a pointer to that new object is stored. The original pointer is not stored and may safely be deallocated after this method is called.

FISADate com::ftlabs::fisa::PeriodicInterestPaymentSecurity::getNextInterestPaymentDate ( const FISADate & date )

Get the next interest payment date on or after the provided date.

Parameters:

date

A starting date, usually trade date or settlement date.