org.drip.analytics.cashflow

Class ComposableUnitFloatingPeriod

java.lang.Object

org.drip.analytics.cashflow.ComposableUnitPeriod

org.drip.analytics.cashflow.ComposableUnitFloatingPeriod

public class ComposableUnitFloatingPeriod
extends ComposableUnitPeriod

ComposableUnitFloatingPeriod contains the cash flow periods' composable sub period details. Currently it holds the accrual start date, the accrual end date, the fixing date, the spread over the index, and the corresponding reference index period.

Author:

Lakshmi Krishnamurthy

Field Summary

Fields inherited from class org.drip.analytics.cashflow.ComposableUnitPeriod

NODE_INSIDE_SEGMENT, NODE_LEFT_OF_SEGMENT, NODE_RIGHT_OF_SEGMENT

Constructor Summary

Constructors

Constructor and Description
ComposableUnitFloatingPeriod(int iStartDate, int iEndDate, java.lang.String strTenor, ReferenceIndexPeriod refIndexPeriod, double dblSpread) The ComposableUnitFloatingPeriod constructor

Method Summary

Modifier and Type	Method and Description
double	baseRate(CurveSurfaceQuoteContainer csqs) Retrieve the Reference Rate for the Floating Period
double	basis() Get the Period Coupon Basis
java.lang.String	couponCurrency() Get the Period Coupon Currency
ReferenceIndexPeriod	referenceIndexPeriod() Retrieve the Reference Index Period

Methods inherited from class org.drip.analytics.cashflow.ComposableUnitPeriod

accrualCompoundingRule, accrualDC, accrualDCF, accrualEOMAdjustment, calendar, couponDC, couponDCFOffOfFreq, couponEOMAdjustment, dateLocation, endDate, freq, fullCouponDCF, fullCouponRate, startDate, tenor

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ComposableUnitFloatingPeriod

public ComposableUnitFloatingPeriod(int iStartDate,
                                    int iEndDate,
                                    java.lang.String strTenor,
                                    ReferenceIndexPeriod refIndexPeriod,
                                    double dblSpread)
                             throws java.lang.Exception

The ComposableUnitFloatingPeriod constructor

Parameters:

iStartDate - Accrual Start Date

iEndDate - Accrual End Date

strTenor - The Composable Period Tenor

refIndexPeriod - The Reference Index Period

dblSpread - The Floater Spread

Throws:

java.lang.Exception - Thrown if the Inputs are Invalid

Method Detail

baseRate

public double baseRate(CurveSurfaceQuoteContainer csqs)
                throws java.lang.Exception

Retrieve the Reference Rate for the Floating Period

Specified by:

baseRate in class ComposableUnitPeriod

Parameters:

csqs - The Market Curve and Surface

Returns:

The Reference Rate for the Floating Period

Throws:

java.lang.Exception - Thrown if the inputs are invalid

basis

public double basis()

Description copied from class: ComposableUnitPeriod

Get the Period Coupon Basis

Specified by:

basis in class ComposableUnitPeriod

Returns:

The Period Coupon Basis

couponCurrency

public java.lang.String couponCurrency()

Description copied from class: ComposableUnitPeriod

Get the Period Coupon Currency

Specified by:

couponCurrency in class ComposableUnitPeriod

Returns:

The Period Coupon Currency

referenceIndexPeriod

public ReferenceIndexPeriod referenceIndexPeriod()

Retrieve the Reference Index Period

Returns:

The Reference Index Period