SimpleCashFlow Class Reference

Predetermined cash flow. More...

#include <simplecashflow.hpp>

Inheritance diagram for SimpleCashFlow:

Collaboration 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 More...
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 &)
Observable &	operator= (const Observable &)
	Observable (Observable &&)=delete
Observable &	operator= (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 &)
Observer &	operator= (const Observer &)
virtual	~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	update ()=0
virtual void	deepUpdate ()

Visitability
Real	amount_
Date	date_
void	accept (AcyclicVisitor &) 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 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 35 of file simplecashflow.hpp.

Constructor & Destructor Documentation

SimpleCashFlow()

SimpleCashFlow	(	Real	amount,
		const Date &	date
	)

Definition at line 25 of file simplecashflow.cpp.

Member Function Documentation

date()

Date date ( ) const

overridevirtual

Note

This is inherited from the event class

Implements CashFlow.

Definition at line 41 of file simplecashflow.hpp.

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.

Definition at line 45 of file simplecashflow.hpp.

accept()

void accept ( AcyclicVisitor &  v )

overridevirtual

Reimplemented from CashFlow.

Reimplemented in Redemption, and AmortizingPayment.

Definition at line 90 of file simplecashflow.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

amount_

Real amount_

private

Definition at line 52 of file simplecashflow.hpp.

date_

Date date_

private

Definition at line 53 of file simplecashflow.hpp.