QuantLib: a free/open-source library for quantitative finance
fully annotated source code - version 1.34
Loading...
Searching...
No Matches
Public Member Functions | List of all members
FixedDividend Class Reference

Predetermined cash flow. More...

#include <dividend.hpp>

+ Inheritance diagram for FixedDividend:
+ Collaboration diagram for FixedDividend:

Public Member Functions

 FixedDividend (Real amount, const Date &date)
 
- Public Member Functions inherited from Dividend
 Dividend (const Date &date)
 
Date date () const override
 
void accept (AcyclicVisitor &) override
 
- 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 &)
 
Observableoperator= (const Observable &)
 
 Observable (Observable &&)=delete
 
Observableoperator= (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 &)
 
Observeroperator= (const Observer &)
 
virtual ~Observer ()
 
std::pair< iterator, boolregisterWith (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 ()
 

Dividend interface

Real amount_
 
Real amount () const override
 returns the amount of the cash flow More...
 
Real amount (Real) const 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 Dividend
Date date_
 
- 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 59 of file dividend.hpp.

Constructor & Destructor Documentation

◆ FixedDividend()

FixedDividend ( Real  amount,
const Date date 
)

Definition at line 61 of file dividend.hpp.

Member Function Documentation

◆ amount() [1/2]

Real amount ( ) const
overridevirtual

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.

Definition at line 65 of file dividend.hpp.

◆ amount() [2/2]

Real amount ( Real  ) const
overridevirtual

Implements Dividend.

Definition at line 66 of file dividend.hpp.

Member Data Documentation

◆ amount_

Real amount_
protected

Definition at line 69 of file dividend.hpp.