FixedDividend Class Reference

Predetermined cash flow. More...

#include <ql/cashflows/dividend.hpp>

Inheritance diagram for FixedDividend:

Public Member Functions
	FixedDividend (Real amount, const Date &date)
Public Member Functions inherited from Dividend
	Dividend (const Date &date)
Date	date () const
virtual void	accept (AcyclicVisitor &)
Public Member Functions inherited from CashFlow
bool	hasOccurred (const Date &refDate=Date(), boost::optional< bool > includeRefDate=boost::none) const
	returns true if an event has already occurred before a date More...
virtual Date	exCouponDate () const
	returns the date that the cash flow trades exCoupon
bool	tradingExCoupon (const Date &refDate=Date()) const
	returns true if the cashflow is trading ex-coupon on the refDate
Event interface
Visitability
Public Member Functions inherited from Observable
	Observable (const Observable &)
Observable &	operator= (const Observable &)
void	notifyObservers ()

Dividend interface
Real	amount_
virtual Real	amount () const
	returns the amount of the cash flow More...
virtual Real	amount (Real) const

Additional Inherited Members
Protected Attributes inherited from Dividend
Date	date_

Detailed Description

Predetermined cash flow.

This cash flow pays a predetermined amount at a given date.

Examples

ConvertibleBonds.cpp.

Member Function Documentation

amount()

virtual Real amount ( ) const

virtual

returns the amount of the cash flow

Note

The amount is not discounted, i.e., it is the actual amount paid at the cash flow date.

Implements Dividend.