Dividend Class Reference

Predetermined cash flow. More...

#include <ql/cashflows/dividend.hpp>

Inheritance diagram for Dividend:

Collaboration diagram for Dividend:

Public Member Functions
	Dividend (const Date &date)
Event interface
Date	date () const override
CashFlow interface
Real	amount () const override=0
	returns the amount of the cash flow More...
virtual Real	amount (Real underlying) const =0
Public Member Functions inherited from CashFlow
	~CashFlow () override=default
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 More...
void	performCalculations () const override
virtual Date	exCouponDate () const
	returns the date that the cash flow trades exCoupon More...
bool	tradingExCoupon (const Date &refDate=Date()) const
	returns true if the cashflow is trading ex-coupon on the refDate More...
Public Member Functions inherited from Event
	~Event () override=default
Public Member Functions inherited from Observable
	Observable ()
	Observable (const Observable &)
Observable &	operator= (const Observable &)
	Observable (Observable &&)=delete
Observable &	operator= (Observable &&)=delete
virtual	~Observable ()=default
void	notifyObservers ()
Public Member Functions inherited from LazyObject
	LazyObject ()
	~LazyObject () override=default
void	update () override
bool	isCalculated () const
void	forwardFirstNotificationOnly ()
void	alwaysForwardNotifications ()
void	recalculate ()
void	freeze ()
void	unfreeze ()
Public Member Functions inherited from Observer
	Observer ()=default
	Observer (const Observer &)
Observer &	operator= (const Observer &)
virtual	~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	update ()=0
virtual void	deepUpdate ()

Visitability
Date	date_
void	accept (AcyclicVisitor &) override

Additional Inherited Members
Public Types inherited from Observer
typedef set_type::iterator	iterator
Protected Member Functions inherited from LazyObject
virtual void	calculate () const
Protected Attributes inherited from LazyObject
bool	calculated_ = false
bool	frozen_ = false
bool	alwaysForward_

Detailed Description

Predetermined cash flow.

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

Definition at line 36 of file dividend.hpp.

Constructor & Destructor Documentation

Dividend()

Dividend

(

const Date &

date

)

Definition at line 38 of file dividend.hpp.

Member Function Documentation

date()

Date date ( ) const

overridevirtual

Note

This is inherited from the event class

Implements CashFlow.

Definition at line 42 of file dividend.hpp.

amount() [1/2]

Real amount ( ) const

overridepure 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 CashFlow.

Implemented in FixedDividend, and FractionalDividend.

amount() [2/2]

virtual Real amount ( Real  underlying ) const

pure virtual

Implemented in FractionalDividend, and FixedDividend.

accept()

void accept ( AcyclicVisitor &  v )

overridevirtual

Reimplemented from CashFlow.

Definition at line 26 of file dividend.cpp.

Here is the call graph for this function:

Member Data Documentation

date_

Date date_

protected

Definition at line 54 of file dividend.hpp.