ScaledCashFlow Class Reference

scalable cashflow More...

#include <qle/cashflows/scaledcoupon.hpp>

Inheritance diagram for ScaledCashFlow:

Collaboration diagram for ScaledCashFlow:

Public Member Functions
	ScaledCashFlow (Real multiplier, QuantLib::ext::shared_ptr< CashFlow > underlying)
Date	date () const override
Real	amount () const override

Private Attributes
Real	multiplier_
QuantLib::ext::shared_ptr< CashFlow >	underlying_

Detailed Description

scalable cashflow

CashFlow that returns the scaled results for an underlying cashflow

Definition at line 38 of file scaledcoupon.hpp.

Constructor & Destructor Documentation

ScaledCashFlow()

ScaledCashFlow	(	Real	multiplier,
		QuantLib::ext::shared_ptr< CashFlow >	underlying
	)

Definition at line 40 of file scaledcoupon.hpp.

        : multiplier_(multiplier), underlying_(underlying) {}

Member Function Documentation

date()

Date date ( ) const

override

Definition at line 43 of file scaledcoupon.hpp.

{ return underlying_->date(); }

amount()

Real amount ( ) const

override

Definition at line 44 of file scaledcoupon.hpp.

{ return underlying_->amount() * multiplier_; }

Member Data Documentation

multiplier_

Real multiplier_

private

Definition at line 47 of file scaledcoupon.hpp.

underlying_

QuantLib::ext::shared_ptr<CashFlow> underlying_

private

Definition at line 48 of file scaledcoupon.hpp.