Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CommodityCashFlow

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new CommodityCashFlow(date: Date, discountedAmount: Money, undiscountedAmount: Money, discountedPaymentAmount: Money, undiscountedPaymentAmount: Money, discountFactor: Real, paymentDiscountFactor: Real, finalized: boolean): CommodityCashFlow

Properties

Private _date

_date: Date

Private _discountFactor

_discountFactor: Real

Private _discountedAmount

_discountedAmount: Money

Private _discountedPaymentAmount

_discountedPaymentAmount: Money

Private _finalized

_finalized: boolean

_isDisposed

_isDisposed: boolean = false

_observers

_observers: Set<Observer>

Private _paymentDiscountFactor

_paymentDiscountFactor: Real

Private _undiscountedAmount

_undiscountedAmount: Money

Private _undiscountedPaymentAmount

_undiscountedPaymentAmount: Money

Accessors

isDisposed

  • get isDisposed(): boolean

Methods

accept

amount

  • Returns Real

amount1

currency

  • Returns Currency

date

  • date(): Date

  • Returns Date

discountFactor

  • discountFactor(): Real

  • Returns Real

discountedAmount

  • discountedAmount(): Money

  • Returns Money

discountedPaymentAmount

  • discountedPaymentAmount(): Money

  • Returns Money

dispose

  • dispose(): void

  • Returns void

exCouponDate

  • exCouponDate(): Date

finalized

  • finalized(): boolean

  • Returns boolean

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

paymentDiscountFactor

  • paymentDiscountFactor(): Real

  • Returns Real

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

undiscountedAmount

  • undiscountedAmount(): Money

  • Returns Money

undiscountedPaymentAmount

  • undiscountedPaymentAmount(): Money

  • Returns Money

unregisterObserver