CashflowRow Class Reference

Class representing the row of a cashflow table. More...

#include <qle/cashflows/cashflowtable.hpp>

Collaboration diagram for CashflowRow:

Public Member Functions
	CashflowRow ()
	Default constructor sets all variables to Null value. More...
Initialisers
Functions to initialise the members
CashflowRow &	withStartDate (const QuantLib::Date &startDate)
CashflowRow &	withEndDate (const QuantLib::Date &endDate)
CashflowRow &	withStartNotional (QuantLib::Real startNotional)
CashflowRow &	withEndNotional (QuantLib::Real endNotional)
CashflowRow &	withCouponAmount (QuantLib::Real couponAmount)
CashflowRow &	withAllInRate (QuantLib::Rate allInRate)
CashflowRow &	withRate (QuantLib::Rate rate)
CashflowRow &	withSpread (QuantLib::Spread spread)
CashflowRow &	withDiscount (QuantLib::DiscountFactor discount)

Inspectors
Functions to retrieve the members
QuantLib::Date	startDate_
QuantLib::Date	endDate_
QuantLib::Real	startNotional_
QuantLib::Real	endNotional_
QuantLib::Real	couponAmount_
QuantLib::Rate	allInRate_
QuantLib::Rate	rate_
QuantLib::Spread	spread_
QuantLib::DiscountFactor	discount_
const QuantLib::Date &	startDate () const
const QuantLib::Date &	endDate () const
QuantLib::Real	startNotional () const
QuantLib::Real	endNotional () const
QuantLib::Real	couponAmount () const
QuantLib::Rate	allInRate () const
QuantLib::Rate	rate () const
QuantLib::Spread	spread () const
QuantLib::DiscountFactor	discount () const

Detailed Description

Class representing the row of a cashflow table.

Definition at line 34 of file cashflowtable.hpp.

Constructor & Destructor Documentation

CashflowRow()

CashflowRow

(

)

Default constructor sets all variables to Null value.

Definition at line 26 of file cashflowtable.cpp.

    : startDate_(Null<Date>()), endDate_(Null<Date>()), startNotional_(Null<Real>()), endNotional_(Null<Real>()),
      couponAmount_(Null<Real>()), allInRate_(Null<Rate>()), rate_(Null<Rate>()), spread_(Null<Spread>()),
      discount_(Null<DiscountFactor>()) {}

Member Function Documentation

withStartDate()

CashflowRow & withStartDate

(

const QuantLib::Date &

startDate

)

Definition at line 31 of file cashflowtable.cpp.

                                                             {
    startDate_ = startDate;
    return *this;
}

Here is the call graph for this function:

withEndDate()

CashflowRow & withEndDate

(

const QuantLib::Date &

endDate

)

Definition at line 36 of file cashflowtable.cpp.

                                                         {
    endDate_ = endDate;
    return *this;
}

Here is the call graph for this function:

withStartNotional()

CashflowRow & withStartNotional

(

QuantLib::Real

startNotional

)

Definition at line 41 of file cashflowtable.cpp.

                                                              {
    startNotional_ = startNotional;
    return *this;
}

Here is the call graph for this function:

withEndNotional()

CashflowRow & withEndNotional

(

QuantLib::Real

endNotional

)

Definition at line 46 of file cashflowtable.cpp.

                                                          {
    endNotional_ = endNotional;
    return *this;
}

Here is the call graph for this function:

withCouponAmount()

CashflowRow & withCouponAmount

(

QuantLib::Real

couponAmount

)

Definition at line 51 of file cashflowtable.cpp.

                                                            {
    couponAmount_ = couponAmount;
    return *this;
}

Here is the call graph for this function:

withAllInRate()

CashflowRow & withAllInRate

(

QuantLib::Rate

allInRate

)

Definition at line 56 of file cashflowtable.cpp.

                                                      {
    allInRate_ = allInRate;
    return *this;
}

Here is the call graph for this function:

withRate()

CashflowRow & withRate

(

QuantLib::Rate

rate

)

Definition at line 61 of file cashflowtable.cpp.

                                            {
    rate_ = rate;
    return *this;
}

Here is the call graph for this function:

withSpread()

CashflowRow & withSpread

(

QuantLib::Spread

spread

)

Definition at line 66 of file cashflowtable.cpp.

                                                  {
    spread_ = spread;
    return *this;
}

Here is the call graph for this function:

withDiscount()

CashflowRow & withDiscount

(

QuantLib::DiscountFactor

discount

)

Definition at line 71 of file cashflowtable.cpp.

                                                              {
    discount_ = discount;
    return *this;
}

Here is the call graph for this function:

startDate()

const QuantLib::Date & startDate

(

)

const

Definition at line 56 of file cashflowtable.hpp.

{ return startDate_; }

Here is the caller graph for this function:

endDate()

const QuantLib::Date & endDate

(

)

const

Definition at line 57 of file cashflowtable.hpp.

{ return endDate_; }

Here is the caller graph for this function:

startNotional()

QuantLib::Real startNotional

(

)

const

Definition at line 58 of file cashflowtable.hpp.

{ return startNotional_; }

Here is the caller graph for this function:

endNotional()

QuantLib::Real endNotional

(

)

const

Definition at line 59 of file cashflowtable.hpp.

{ return endNotional_; }

Here is the caller graph for this function:

couponAmount()

QuantLib::Real couponAmount

(

)

const

Definition at line 60 of file cashflowtable.hpp.

{ return couponAmount_; }

Here is the caller graph for this function:

allInRate()

QuantLib::Rate allInRate

(

)

const

Definition at line 61 of file cashflowtable.hpp.

{ return allInRate_; }

Here is the caller graph for this function:

rate()

QuantLib::Rate rate

(

)

const

Definition at line 62 of file cashflowtable.hpp.

{ return rate_; }

Here is the caller graph for this function:

spread()

QuantLib::Spread spread

(

)

const

Definition at line 63 of file cashflowtable.hpp.

{ return spread_; }

Here is the caller graph for this function:

discount()

QuantLib::DiscountFactor discount

(

)

const

Definition at line 64 of file cashflowtable.hpp.

{ return discount_; }

Here is the caller graph for this function:

Member Data Documentation

startDate_

QuantLib::Date startDate_

private

Definition at line 67 of file cashflowtable.hpp.

endDate_

QuantLib::Date endDate_

private

Definition at line 68 of file cashflowtable.hpp.

startNotional_

QuantLib::Real startNotional_

private

Definition at line 69 of file cashflowtable.hpp.

endNotional_

QuantLib::Real endNotional_

private

Definition at line 70 of file cashflowtable.hpp.

couponAmount_

QuantLib::Real couponAmount_

private

Definition at line 71 of file cashflowtable.hpp.

allInRate_

QuantLib::Rate allInRate_

private

Definition at line 72 of file cashflowtable.hpp.

rate_

QuantLib::Rate rate_

private

Definition at line 73 of file cashflowtable.hpp.

spread_

QuantLib::Spread spread_

private

Definition at line 74 of file cashflowtable.hpp.

discount_

QuantLib::DiscountFactor discount_

private

Definition at line 75 of file cashflowtable.hpp.