QuantLib_FixedDividend man page

FixedDividend — Predetermined cash flow.

Synopsis

#include <ql/cashflows/dividend.hpp>

Inherits Dividend.

Public Member Functions

FixedDividend (Real amount, const Date &date)

Dividend interface

virtual Real amount () const
returns the amount of the cash flow
virtual Real amount (Real) const

Protected Attributes

Real amount_

Detailed Description

Predetermined cash flow.

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

Examples: ConvertibleBonds.cpp.

Member Function Documentation

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.

Author

Generated automatically by Doxygen for QuantLib from the source code.

Referenced By

amount_(3) and FixedDividend(3) are aliases of QuantLib_FixedDividend(3).

Fri Sep 23 2016 Version 1.8.1 QuantLib