SysTutorials

Linux Manual Pages › Section 3

tenor(3)

QuantLib::InterestRateIndex – base class for interest rate indexes

Synopsis

virtual Date valueDate (const Date &fixingDate) const
virtual Date maturityDate (const Date &valueDate) const =0
Protected Member Functions
virtual Rate forecastFixing (const Date &fixingDate) const =0
Protected Attributes

Inherits QuantLib::Index, and QuantLib::Observer. Inherited by BMAIndex, IborIndex, and SwapIndex.

Public Member Functions

InterestRateIndex (const std::string &familyName, const Period &tenor, Natural settlementDays, const Currency &currency, const Calendar &fixingCalendar, const DayCounter &dayCounter)
Index interface
virtual Date valueDate (const Date &fixingDate) const

virtual Date maturityDate (const Date &valueDate) const =0

Protected Member Functions
virtual Rate forecastFixing (const Date &fixingDate) const =0

Protected Attributes Observer interface
virtual Date valueDate (const Date &fixingDate) const

virtual Date maturityDate (const Date &valueDate) const =0

Protected Member Functions
virtual Rate forecastFixing (const Date &fixingDate) const =0

Protected Attributes Inspectors
virtual Date valueDate (const Date &fixingDate) const

virtual Date maturityDate (const Date &valueDate) const =0

Protected Member Functions
virtual Rate forecastFixing (const Date &fixingDate) const =0

Protected Attributes Date calculations
These method can be overridden to implement particular conventions (e.g. EurLibor)

virtual Date valueDate (const Date &fixingDate) const
virtual Date maturityDate (const Date &valueDate) const =0
Protected Member Functions
virtual Rate forecastFixing (const Date &fixingDate) const =0
Protected Attributes

std::string familyName_

Period tenor_

Natural fixingDays_

Calendar fixingCalendar_

Currency currency_

DayCounter dayCounter_

Detailed Description

base class for interest rate indexes

Possible enhancements

add methods returning InterestRate

Member Function Documentation

std::string name () const [virtual]

Returns the name of the index.

Warning

This method is used for output and comparison between indexes. It is not meant to be used for writing switch-on-type code.

Implements Index.

Reimplemented in BMAIndex.

Rate fixing (const Date & fixingDate, bool forecastTodaysFixing = false) const [virtual]

returns the fixing at the given date

the date passed as arguments must be the actual calendar date of the fixing; no settlement days must be used.

Implements Index.

void update () [virtual]

This method must be implemented in derived classes. An instance of Observer does not call this method directly: instead, it will be called by the observables the instance registered with when they need to notify any changes.

Implements Observer.

Author

Generated automatically by Doxygen for QuantLib from the source code.