Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Dividend

Predetermined cash flow

This cash flow pays a predetermined amount at a given date.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected _date

_date: Date

_isDisposed

_isDisposed: boolean = false

_observers

_observers: Set<Observer>

Accessors

isDisposed

  • get isDisposed(): boolean

Methods

accept

amount1

amount2

  • Parameters

    Returns Real

date

  • date(): Date

  • Returns Date

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

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

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