QuantLib
A free/open-source library for quantitative finance
Reference manual - version 1.5
Public Member Functions | Protected Attributes | List of all members
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
virtual Real amount () const
 returns the amount of the cash flow More...
 
virtual Real amount (Real underlying) const
 
Inspectors
Real rate () const
 
Real nominal () const
 
- Public Member Functions inherited from Dividend
 Dividend (const Date &date)
 
Date date () const
 
virtual void accept (AcyclicVisitor &)
 
- Public Member Functions inherited from CashFlow
bool hasOccurred (const Date &refDate=Date(), boost::optional< bool > includeRefDate=boost::none) const
 returns true if an event has already occurred before a date More...
 
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
 
Event interface
Visitability
- Public Member Functions inherited from Observable
 Observable (const Observable &)
 
Observableoperator= (const Observable &)
 
void notifyObservers ()
 

Protected Attributes

Real rate_
 
Real nominal_
 
- Protected Attributes inherited from Dividend
Date date_
 

Detailed Description

Predetermined cash flow.

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

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.