Options
All
  • Public
  • Public/Protected
  • All
Menu

coupon accruing over a fixed period

This class implements part of the CashFlow interface but it is still abstract and provides derived classes with methods for accrual period calculations.

Hierarchy

Implemented by

Index

Constructors

constructor

Properties

_accrualEndDate

_accrualEndDate: Date

_accrualPeriod

_accrualPeriod: Real

_accrualStartDate

_accrualStartDate: Date

_exCouponDate

_exCouponDate: Date

_isDisposed

_isDisposed: boolean = false

_nominal

_nominal: Real

_observers

_observers: Set<Observer>

_paymentDate

_paymentDate: Date

_refPeriodEnd

_refPeriodEnd: Date

_refPeriodStart

_refPeriodStart: Date

Accessors

isDisposed

  • get isDisposed(): boolean

Methods

accept

accrualDays

  • accrual period in days

    Returns Integer

accrualEndDate

  • accrualEndDate(): Date
  • end of the accrual period

    Returns Date

accrualPeriod

  • accrualPeriod(): Time
  • accrual period as fraction of year

    Returns Time

accrualStartDate

  • accrualStartDate(): Date
  • start of the accrual period

    Returns Date

accruedAmount

  • accruedAmount(d: Date): Real
  • accrued amount at the given date

    Parameters

    • d: Date

    Returns Real

accruedDays

  • accrued days at the given date

    Parameters

    • d: Date

    Returns Integer

accruedPeriod

  • accruedPeriod(d: Date): Time
  • accrued period as fraction of year at the given date

    Parameters

    • d: Date

    Returns Time

amount1

date

  • date(): Date
  • Returns Date

dayCounter

  • day counter for accrual calculation

    Returns DayCounter

dispose

  • dispose(): void
  • Returns void

exCouponDate

  • exCouponDate(): Date

hasOccurred

  • hasOccurred(refDate?: Date, includeRefDate?: boolean): boolean
  • returns true if an event has already occurred before a date overloads Event::hasOccurred in order to take Settings.includeTodaysCashflows in account

    Parameters

    • Default value refDate: Date = null
    • Default value includeRefDate: boolean = null

    Returns boolean

init

  • init(paymentDate: Date, nominal: Real, accrualStartDate: Date, accrualEndDate: Date, refPeriodStart?: Date, refPeriodEnd?: Date, exCouponDate?: Date): Coupon
  • Parameters

    • paymentDate: Date
    • nominal: Real
    • accrualStartDate: Date
    • accrualEndDate: Date
    • Default value refPeriodStart: Date = null
    • Default value refPeriodEnd: Date = null
    • Default value exCouponDate: Date = null

    Returns Coupon

nominal

  • Returns Real

notifyObservers

  • notifyObservers(): void
  • This method should be called at the end of non-const methods or when the programmer desires to notify any changes.

    Returns void

rate

  • accrued rate

    Returns Rate

referencePeriodEnd

  • referencePeriodEnd(): Date
  • end date of the reference period

    Returns Date

referencePeriodStart

  • referencePeriodStart(): Date
  • start date of the reference period

    Returns Date

registerObserver

tradingExCoupon

  • tradingExCoupon(refDate?: Date): boolean
  • returns true if the cashflow is trading ex-coupon on the refDate

    Parameters

    • Default value refDate: Date = null

    Returns boolean

unregisterObserver