OvernightLeg Class Reference

helper class building a sequence of overnight coupons More...

#include <ql/cashflows/overnightindexedcoupon.hpp>

Collaboration diagram for OvernightLeg:

Public Member Functions
	OvernightLeg (const Schedule &schedule, ext::shared_ptr< OvernightIndex > overnightIndex)
OvernightLeg &	withNotionals (Real notional)
OvernightLeg &	withNotionals (const std::vector< Real > &notionals)
OvernightLeg &	withPaymentDayCounter (const DayCounter &)
OvernightLeg &	withPaymentAdjustment (BusinessDayConvention)
OvernightLeg &	withPaymentCalendar (const Calendar &)
OvernightLeg &	withPaymentLag (Natural lag)
OvernightLeg &	withGearings (Real gearing)
OvernightLeg &	withGearings (const std::vector< Real > &gearings)
OvernightLeg &	withSpreads (Spread spread)
OvernightLeg &	withSpreads (const std::vector< Spread > &spreads)
OvernightLeg &	withTelescopicValueDates (bool telescopicValueDates)
OvernightLeg &	withAveragingMethod (RateAveraging::Type averagingMethod)
	operator Leg () const

Private Attributes
Schedule	schedule_
ext::shared_ptr< OvernightIndex >	overnightIndex_
std::vector< Real >	notionals_
DayCounter	paymentDayCounter_
Calendar	paymentCalendar_
BusinessDayConvention	paymentAdjustment_ = Following
Natural	paymentLag_ = 0
std::vector< Real >	gearings_
std::vector< Spread >	spreads_
bool	telescopicValueDates_ = false
RateAveraging::Type	averagingMethod_ = RateAveraging::Compound

Detailed Description

helper class building a sequence of overnight coupons

Definition at line 96 of file overnightindexedcoupon.hpp.

Constructor & Destructor Documentation

OvernightLeg()

OvernightLeg	(	const Schedule &	schedule,
		ext::shared_ptr< OvernightIndex >	overnightIndex
	)

Definition at line 272 of file overnightindexedcoupon.cpp.

Member Function Documentation

withNotionals() [1/2]

OvernightLeg & withNotionals

(

Real

notional

)

Definition at line 277 of file overnightindexedcoupon.cpp.

Here is the caller graph for this function:

withNotionals() [2/2]

OvernightLeg & withNotionals

(

const std::vector< Real > &

notionals

)

Definition at line 282 of file overnightindexedcoupon.cpp.

withPaymentDayCounter()

OvernightLeg & withPaymentDayCounter

(

const DayCounter &

dc

)

Definition at line 287 of file overnightindexedcoupon.cpp.

withPaymentAdjustment()

OvernightLeg & withPaymentAdjustment

(

BusinessDayConvention

convention

)

Definition at line 293 of file overnightindexedcoupon.cpp.

Here is the caller graph for this function:

withPaymentCalendar()

OvernightLeg & withPaymentCalendar

(

const Calendar &

cal

)

Definition at line 298 of file overnightindexedcoupon.cpp.

Here is the caller graph for this function:

withPaymentLag()

OvernightLeg & withPaymentLag

(

Natural

lag

)

Definition at line 303 of file overnightindexedcoupon.cpp.

Here is the caller graph for this function:

withGearings() [1/2]

OvernightLeg & withGearings

(

Real

gearing

)

Definition at line 308 of file overnightindexedcoupon.cpp.

withGearings() [2/2]

OvernightLeg & withGearings

(

const std::vector< Real > &

gearings

)

Definition at line 313 of file overnightindexedcoupon.cpp.

withSpreads() [1/2]

OvernightLeg & withSpreads

(

Spread

spread

)

Definition at line 318 of file overnightindexedcoupon.cpp.

Here is the caller graph for this function:

withSpreads() [2/2]

OvernightLeg & withSpreads

(

const std::vector< Spread > &

spreads

)

Definition at line 323 of file overnightindexedcoupon.cpp.

withTelescopicValueDates()

OvernightLeg & withTelescopicValueDates

(

bool

telescopicValueDates

)

Definition at line 328 of file overnightindexedcoupon.cpp.

Here is the caller graph for this function:

withAveragingMethod()

OvernightLeg & withAveragingMethod

(

RateAveraging::Type

averagingMethod

)

Definition at line 333 of file overnightindexedcoupon.cpp.

Here is the caller graph for this function:

operator Leg()

operator Leg

(

)

const

Definition at line 338 of file overnightindexedcoupon.cpp.

Here is the call graph for this function:

Member Data Documentation

schedule_

Schedule schedule_

private

Definition at line 113 of file overnightindexedcoupon.hpp.

overnightIndex_

ext::shared_ptr<OvernightIndex> overnightIndex_

private

Definition at line 114 of file overnightindexedcoupon.hpp.

notionals_

std::vector<Real> notionals_

private

Definition at line 115 of file overnightindexedcoupon.hpp.

paymentDayCounter_

DayCounter paymentDayCounter_

private

Definition at line 116 of file overnightindexedcoupon.hpp.

paymentCalendar_

Calendar paymentCalendar_

private

Definition at line 117 of file overnightindexedcoupon.hpp.

paymentAdjustment_

BusinessDayConvention paymentAdjustment_ = Following

private

Definition at line 118 of file overnightindexedcoupon.hpp.

paymentLag_

Natural paymentLag_ = 0

private

Definition at line 119 of file overnightindexedcoupon.hpp.

gearings_

std::vector<Real> gearings_

private

Definition at line 120 of file overnightindexedcoupon.hpp.

spreads_

std::vector<Spread> spreads_

private

Definition at line 121 of file overnightindexedcoupon.hpp.

telescopicValueDates_

bool telescopicValueDates_ = false

private

Definition at line 122 of file overnightindexedcoupon.hpp.

averagingMethod_

RateAveraging::Type averagingMethod_ = RateAveraging::Compound

private

Definition at line 123 of file overnightindexedcoupon.hpp.