Logo Search packages:      
Sourcecode: quantlib version File versions  Download package

QuantLib::FloatingRateCoupon Class Reference

#include <floatingratecoupon.hpp>

Inheritance diagram for QuantLib::FloatingRateCoupon:

QuantLib::Coupon QuantLib::Observer QuantLib::CashFlow QuantLib::Event QuantLib::Observable QuantLib::AverageBMACoupon QuantLib::CappedFlooredCoupon QuantLib::CmsCoupon QuantLib::DigitalCoupon QuantLib::IborCoupon QuantLib::OvernightIndexedCoupon QuantLib::DigitalCmsCoupon QuantLib::DigitalIborCoupon

List of all members.


Detailed Description

base floating-rate coupon class

Definition at line 43 of file floatingratecoupon.hpp.


Public Member Functions

 FloatingRateCoupon (const Date &paymentDate, Real nominal, const Date &startDate, const Date &endDate, Natural fixingDays, const boost::shared_ptr< InterestRateIndex > &index, Real gearing=1.0, Spread spread=0.0, const Date &refPeriodStart=Date(), const Date &refPeriodEnd=Date(), const DayCounter &dayCounter=DayCounter(), bool isInArrears=false)
void notifyObservers ()
boost::shared_ptr
< FloatingRateCouponPricer
pricer () const
void registerWith (const boost::shared_ptr< Observable > &)
void setPricer (const boost::shared_ptr< FloatingRateCouponPricer > &)
void unregisterWith (const boost::shared_ptr< Observable > &)
Visitability
virtual void accept (AcyclicVisitor &)
Inspectors
BigInteger accrualDays () const
 accrual period in days
const DateaccrualEndDate () const
 end of the accrual period
Time accrualPeriod () const
 accrual period as fraction of year
const DateaccrualStartDate () const
 start of the accrual period
Real nominal () const
const DatereferencePeriodEnd () const
 end date of the reference period
const DatereferencePeriodStart () const
 start date of the reference period
Coupon interface
Real accruedAmount (const Date &) const
 accrued amount at the given date
DayCounter dayCounter () const
 day counter for accrual calculation
Real price (const Handle< YieldTermStructure > &discountingCurve) const
Rate rate () const
 accrued rate
Inspectors
virtual Rate adjustedFixing () const
 convexity-adjusted fixing
virtual Rate convexityAdjustment () const
 convexity adjustment
virtual Date fixingDate () const
 fixing date
Natural fixingDays () const
 fixing days
Real gearing () const
 index gearing, i.e. multiplicative coefficient for the index
const boost::shared_ptr
< InterestRateIndex > & 
index () const
 floating index
virtual Rate indexFixing () const
 fixing of the underlying index
bool isInArrears () const
 whether or not the coupon fixes in arrears
Spread spread () const
 spread paid over the fixing of the underlying index
CashFlow interface
Real amount () const
 returns the amount of the cash flow
Event interface
Date date () const
Event interface
bool hasOccurred (const Date &refDate=Date(), boost::optional< bool > includeRefDate=boost::none) const
 returns true if an event has already occurred before a date
Observer interface
void update ()

Protected Member Functions

Rate convexityAdjustmentImpl (Rate fixing) const
 convexity adjustment for the given index fixing

Protected Attributes

Date accrualEndDate_
Date accrualStartDate_
DayCounter dayCounter_
Natural fixingDays_
Real gearing_
boost::shared_ptr
< InterestRateIndex
index_
bool isInArrears_
Real nominal_
Date paymentDate_
boost::shared_ptr
< FloatingRateCouponPricer
pricer_
Date refPeriodEnd_
Date refPeriodStart_
Spread spread_

The documentation for this class was generated from the following files:

Generated by  Doxygen 1.6.0   Back to index