amount (3) - Linux Manuals

amount: Base class for cash flows.

NAME

QuantLib::CashFlow - Base class for cash flows.

SYNOPSIS

#include <ql/cashflow.hpp>

Inherits QuantLib::Event.

Inherited by CommodityCashFlow, Coupon, Dividend, and SimpleCashFlow.

Public Member Functions

Event interface

virtual Date date () const =0

CashFlow interface

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

Visitability

virtual void accept (AcyclicVisitor &)

Detailed Description

Base class for cash flows.

This class is purely virtual and acts as a base class for the actual cash flow implementations.

Member Function Documentation

virtual Date date () const [pure virtual]

Note:

This is inheriited from the event class

Implements Event.

Implemented in Coupon, Dividend, and SimpleCashFlow.

virtual Real amount () const [pure 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.

Implemented in Dividend, FixedDividend, FractionalDividend, FixedRateCoupon, FloatingRateCoupon, and SimpleCashFlow.

Author

Generated automatically by Doxygen for QuantLib from the source code.