VarsList | myPhysicsLab Docs

Constructors

constructor

  • new VarsList(varNames, localNames, opt_name?): VarsList
  • Parameters

    • varNames: string[]
    • localNames: string[]
    • Optional opt_name: string

    Returns VarsList

Properties

Private histArray_

histArray_: number[][] = []

Private history_

history_: boolean = Util.DEBUG

Private timeIdx_

timeIdx_: number = -1

Static Readonly DELETED

DELETED: "DELETED" = 'DELETED'

Static Readonly TIME

TIME: "TIME" = 'TIME'

Static Readonly VARS_MODIFIED

VARS_MODIFIED: "VARS_MODIFIED" = 'VARS_MODIFIED'

Methods

addObserver

  • addObserver(observer): void
  • Returns void

addParameter

  • addParameter(_parameter): void
  • Returns void

addVariable

  • addVariable(variable): number
  • Returns number

    the index number of the variable

addVariables

  • addVariables(names, localNames): number
  • Parameters

    • names: string[]
    • localNames: string[]

    Returns number

    index index of first ConcreteVariable that was added

broadcast

  • broadcast(evt): void
  • Returns void

broadcastParameter

  • broadcastParameter(name): void
  • Parameters

    • name: string

    Returns void

deleteVariables

  • deleteVariables(index, howMany): void
  • Parameters

    • index: number
    • howMany: number

    Returns void

findOpenSlot_

  • findOpenSlot_(quantity): number
  • Parameters

    • quantity: number

    Returns number

    index of first variable

Protected getBroadcast

  • getBroadcast(): boolean
  • Returns boolean

    whether broadcasting is enabled for this Subject

getClassName

  • getClassName(): string
  • Returns string

    name of class of this object.

getHistory

  • getHistory(): boolean
  • Returns boolean

    true if recent history is being stored

getName

  • getName(): string
  • Returns string

    name the language-independent name of this Subject

getObservers

  • getObservers(): Observer[]
  • Returns Observer[]

    a copy of the list of Observers of this Subject.

getParameter

  • getParameter(name): Parameter
  • Parameters

    • name: string

    Returns Parameter

    the Parameter with the given name

getParameterBoolean

getParameterNumber

getParameterString

getParameters

  • getParameters(): Parameter[]
  • Returns Parameter[]

    a copy of the list of available Parameters for this Subject

getTime

  • getTime(): number
  • Returns number

    the current simulation time

getValue

  • getValue(index): number
  • Parameters

    • index: number

    Returns number

    the current value of the variable of interest

getValues

  • getValues(computed?): number[]
  • Parameters

    • Optional computed: boolean

    Returns number[]

    an array with the current value of each variable. Computed variables have value of NaN unless requested.

getVariable

  • getVariable(id): Variable
  • Parameters

    • id: string | number

    Returns Variable

    the Variable object at the given index or with the given name

incrSequence

  • incrSequence(...indexes): void
  • Parameters

    • Rest ...indexes: number[]

    Returns void

indexOf

  • indexOf(id): number
  • Returns number

    integer index number of the variable, or -1 if not found

numVariables

  • numVariables(): number
  • Returns number

    the number of variables in this VarsList

printHistory

  • printHistory(index?): string
  • Parameters

    • Optional index: number

    Returns string

    the history variables formatted as code to recreate the situation

printOneHistory

  • printOneHistory(idx): string
  • Parameters

    • idx: number

    Returns string

removeObserver

  • removeObserver(observer): void
  • Returns void

removeParameter

  • removeParameter(parameter): void
  • Returns void

saveHistory

  • saveHistory(): void
  • Returns void

Protected setBroadcast

  • setBroadcast(value): boolean
  • Parameters

    • value: boolean

    Returns boolean

    the previous value

setComputed

  • setComputed(...indexes): void
  • Parameters

    • Rest ...indexes: number[]

    Returns void

setHistory

  • setHistory(value): void
  • Parameters

    • value: boolean

    Returns void

setTime

  • setTime(time): void
  • Parameters

    • time: number

    Returns void

setValue

  • setValue(index, value, continuous?): void
  • Parameters

    • index: number
    • value: number
    • Optional continuous: boolean

    Returns void

setValues

  • setValues(vars, continuous?): void
  • Parameters

    • vars: number[]
    • Optional continuous: boolean

    Returns void

timeIndex

  • timeIndex(): number
  • Returns number

    the index of the time variable, or -1 if there is no time variable

toArray

  • toArray(): Variable[]
  • Returns Variable[]

    the set of Variable objects in this VarsList, in their correct ordering.

toString

  • toString(): string
  • Returns string

toStringShort

  • toStringShort(): string
  • Returns string

    a minimal string representation of this object.