Dividend Class Reference

Predetermined cash flow. More...

#include <ql/cashflows/dividend.hpp>

Inheritance diagram for Dividend:

List of all members.

Public Member Functions

 Dividend (const Date &date)
virtual Real amount (Real underlying) const =0
Event interface
Date date () const
CashFlow interface
virtual Real amount () const =0
 returns the amount of the cash flow
Visitability
virtual void accept (AcyclicVisitor &)

Protected Attributes

Date date_


Detailed Description

Predetermined cash flow.

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


Member Function Documentation

Date date (  )  const [virtual]

Note:
This is inheriited from the event class

Implements CashFlow.

virtual Real amount (  )  const [pure 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.