QuantLib: a free/open-source library for quantitative finance
Reference manual - version 1.40
Loading...
Searching...
No Matches
SimpleCashFlow Class Reference

Predetermined cash flow. More...

#include <ql/cashflows/simplecashflow.hpp>

Inheritance diagram for SimpleCashFlow:

Public Member Functions

 SimpleCashFlow (Real amount, const Date &date)
Event interface
Date date () const override
CashFlow interface
Real amount () const override
 returns the amount of the cash flow
Public Member Functions inherited from CashFlow
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
void performCalculations () const override
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
Public Member Functions inherited from Event
Public Member Functions inherited from Observable
 Observable (const Observable &)
Observableoperator= (const Observable &)
 Observable (Observable &&)=delete
Observableoperator= (Observable &&)=delete
void notifyObservers ()
Public Member Functions inherited from LazyObject
void update () override
bool isCalculated () const
void forwardFirstNotificationOnly ()
void alwaysForwardNotifications ()
void recalculate ()
void freeze ()
void unfreeze ()
Public Member Functions inherited from Observer
 Observer (const Observer &)
Observeroperator= (const Observer &)
std::pair< iterator, bool > registerWith (const ext::shared_ptr< Observable > &)
void registerWithObservables (const ext::shared_ptr< Observer > &)
Size unregisterWith (const ext::shared_ptr< Observable > &)
void unregisterWithAll ()
virtual void deepUpdate ()

Visitability

void accept (AcyclicVisitor &) override

Additional Inherited Members

Public Types inherited from Observer
typedef set_type::iterator iterator
virtual void calculate () const
bool calculated_ = false
bool frozen_ = false
bool alwaysForward_

Detailed Description

Predetermined cash flow.

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

Member Function Documentation

◆ date()

Date date ( ) const
overridevirtual
Note
This is inherited from the event class

Implements CashFlow.

◆ amount()

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 CashFlow.

◆ accept()

void accept ( AcyclicVisitor & v)
overridevirtual

Reimplemented from CashFlow.