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

Public Member Functions | Protected Member Functions | Protected Attributes

QuantLib::FloatingRateCoupon Class Reference

base floating-rate coupon class More...

#include <floatingratecoupon.hpp>

Inheritance diagram for QuantLib::FloatingRateCoupon:
Inheritance graph
[legend]
Collaboration diagram for QuantLib::FloatingRateCoupon:
Collaboration graph
[legend]

List of all members.

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 > &)
CashFlow interface
Real amount () const
 returns the amount of the cash flow
Coupon interface
Rate rate () const
 accrued rate
Real price (const Handle< YieldTermStructure > &discountingCurve) const
DayCounter dayCounter () const
 day counter for accrual calculation
Real accruedAmount (const Date &) const
 accrued amount at the given date
Inspectors
const boost::shared_ptr
< InterestRateIndex > & 
index () const
 floating index
Natural fixingDays () const
 fixing days
virtual Date fixingDate () const
 fixing date
Real gearing () const
 index gearing, i.e. multiplicative coefficient for the index
Spread spread () const
 spread paid over the fixing of the underlying index
virtual Rate indexFixing () const
 fixing of the underlying index
virtual Rate convexityAdjustment () const
 convexity adjustment
virtual Rate adjustedFixing () const
 convexity-adjusted fixing
bool isInArrears () const
 whether or not the coupon fixes in arrears
Observer interface
void update ()
Visitability
virtual void accept (AcyclicVisitor &)
Event interface
Date date () const
Inspectors
Real nominal () const
const DateaccrualStartDate () const
 start of the accrual period
const DateaccrualEndDate () const
 end of the accrual period
const DatereferencePeriodStart () const
 start date of the reference period
const DatereferencePeriodEnd () const
 end date of the reference period
Time accrualPeriod () const
 accrual period as fraction of year
BigInteger accrualDays () const
 accrual period in days
Time accruedPeriod (const Date &) const
 accrued period as fraction of year at the given date
BigInteger accruedDays (const Date &) const
 accrued days at the given date
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

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_

Detailed Description

base floating-rate coupon class

Definition at line 43 of file floatingratecoupon.hpp.


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

Generated by  Doxygen 1.6.0   Back to index