Options
All
  • Public
  • Public/Protected
  • All
Menu

purely virtual base class for indexes

warning

this class performs no check that the provided/requested fixings are for dates in the past, i.e. for dates less than or equal to the evaluation date. It is up to the client code to take care of possible inconsistencies due to "seeing in the future"

Hierarchy

Implemented by

Index

Constructors

constructor

Properties

_isDisposed

_isDisposed: boolean = false

_observers

_observers: Set<Observer>

Accessors

isDisposed

  • get isDisposed(): boolean

Methods

addFixing

  • addFixing(fixingDate: Date, fixing: Real, forceOverwrite?: boolean): void
  • stores the historical fixing at the given date

    the date passed as arguments must be the actual calendar date of the fixing; no settlement days must be used.

    Parameters

    • fixingDate: Date
    • fixing: Real
    • Default value forceOverwrite: boolean = false

    Returns void

addFixings1

  • stores historical fixings from a TimeSeries

    the dates in the TimeSeries must be the actual calendar dates of the fixings; no settlement days must be used.

    Parameters

    Returns void

addFixings2

  • addFixings2(d: Date[], dBegin: Size, dEnd: Size, v: Real[], vBegin: Size, forceOverwrite?: boolean): void
  • stores historical fixings at the given dates

    the dates passed as arguments must be the actual calendar dates of the fixings; no settlement days must be used.

    Parameters

    • d: Date[]
    • dBegin: Size
    • dEnd: Size
    • v: Real[]
    • vBegin: Size
    • Default value forceOverwrite: boolean = false

    Returns void

allowsNativeFixings

  • allowsNativeFixings(): boolean
  • check if index allows for native fixings.

    If this returns false, calls to addFixing and similar methods will raise an exception.

    Returns boolean

checkNativeFixingsAllowed

  • checkNativeFixingsAllowed(): void
  • check if index allows for native fixings

    Returns void

clearFixings

  • clearFixings(): void
  • clears all stored historical fixings

    Returns void

dispose

  • dispose(): void
  • Returns void

fixing

  • fixing(fixingDate: Date, forecastTodaysFixing?: boolean): Real
  • returns the fixing at the given date

    the date passed as arguments must be the actual calendar date of the fixing; no settlement days must be used.

    Parameters

    • fixingDate: Date
    • Default value forecastTodaysFixing: boolean = false

    Returns Real

fixingCalendar

  • returns the calendar defining valid fixing dates

    Returns Calendar

isValidFixingDate

  • isValidFixingDate(fixingDate: Date): boolean
  • returns TRUE if the fixing date is a valid one

    Parameters

    • fixingDate: Date

    Returns boolean

name

  • name(): string
  • Returns string

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

timeSeries

  • returns the fixing TimeSeries

    Returns TimeSeries<Real>

unregisterObserver