FractionalDividend Class Reference

Predetermined cash flow. More...

#include <ql/cashflows/dividend.hpp>

Inheritance diagram for FractionalDividend:

Public Member Functions
	FractionalDividend (Real rate, const Date &date)
	FractionalDividend (Real rate, Real nominal, const Date &date)
Dividend interface
Real	amount () const override
	returns the amount of the cash flow
Real	amount (Real underlying) const override
Public Member Functions inherited from Dividend
	Dividend (const Date &date)
Date	date () const override
void	accept (AcyclicVisitor &) override
Public Member Functions inherited from CashFlow
bool	hasOccurred (const Date &refDate=Date(), ext::optional< bool > includeRefDate=ext::nullopt) const override
	returns true if an event has already occurred before a date
void	performCalculations () const override
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
Public Member Functions inherited from Event
Public Member Functions inherited from Observable
	Observable (const Observable &)
Observable &	operator= (const Observable &)
	Observable (Observable &&)=delete
Observable &	operator= (Observable &&)=delete
void	notifyObservers ()
Public Member Functions inherited from LazyObject
void	update () override
bool	isCalculated () const
void	forwardFirstNotificationOnly ()
void	alwaysForwardNotifications ()
void	recalculate ()
void	freeze ()
void	unfreeze ()
Public Member Functions inherited from Observer
	Observer (const Observer &)
Observer &	operator= (const Observer &)
std::pair< iterator, bool >	registerWith (const ext::shared_ptr< Observable > &)
void	registerWithObservables (const ext::shared_ptr< Observer > &)
Size	unregisterWith (const ext::shared_ptr< Observable > &)
void	unregisterWithAll ()
virtual void	deepUpdate ()

Inspectors
Real	rate_
Real	nominal_
Real	rate () const
Real	nominal () const

Additional Inherited Members
Public Types inherited from Observer
typedef set_type::iterator	iterator
virtual void	calculate () const
Date	date_
bool	calculated_ = false
bool	frozen_ = false
bool	alwaysForward_

Detailed Description

Predetermined cash flow.

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

Member Function Documentation

amount() [1/2]

Real amount ( ) const

overridevirtual

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.

amount() [2/2]

Real amount ( Real underlying ) const

overridevirtual

Implements Dividend.