QuantLib_Dividend man page

Dividend — Predetermined cash flow.  


#include <ql/cashflows/dividend.hpp>

Inherits CashFlow.

Inherited by FixedDividend, and FractionalDividend.

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


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]


This is inherited from the event class

Implements CashFlow.

virtual Real amount () const [pure virtual]

returns the amount of the cash flow


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

Implements CashFlow.

Implemented in FractionalDividend, and FixedDividend.


Generated automatically by Doxygen for QuantLib from the source code.

Referenced By

date_(3) and Dividend(3) are aliases of QuantLib_Dividend(3).

Fri Jun 2 2017 Version 1.10 QuantLib