Class SingleSpringApp

Displays the SingleSpringSim simulation.

Hierarchy (view full)

AbstractApp<SingleSpringSim>
- SingleSpringApp

Implements

Constructors

constructor

new SingleSpringApp(elem_ids, opt_name?): SingleSpringApp
Parameters
- elem_ids: ElementIDs
  specifies the names of the HTML elementId's to look for in the HTML document; these elements are where the user interface of the simulation is created.
- Optional opt_name: string
  name of this as a Subject
Returns SingleSpringApp
Overrides AbstractApp<SingleSpringSim>.constructor
- Defined in sims/springs/SingleSpringApp.ts:41

Methods

addControl

addControl(control): LabControl
Add the control to the set of simulation controls.
Parameters
- control: LabControl
Returns LabControl
the control that was passed in
Inherited from AbstractApp.addControl
- Defined in sims/common/AbstractApp.ts:216

addObserver

addObserver(observer): void
Adds the given Observer to this Subject's list of Observers, so that the Observer will be notified of changes in this Subject. An Observer may call Subject.addObserver during its observe method.
Parameters
- observer: Observer
  the Observer to add
Returns void
Implementation of Subject.addObserver
Inherited from AbstractApp.addObserver
- Defined in lab/util/AbstractSubject.ts:67

addParameter

addParameter(parameter): void
Adds the Parameter to the list of this Subject's available Parameters.
Parameters
- parameter: Parameter
  the Parameter to add
Returns void
Throws
if a Parameter with the same name already exists.
Inherited from AbstractApp.addParameter
- Defined in lab/util/AbstractSubject.ts:100

addPlaybackControls

addPlaybackControls(): void
Returns void
Inherited from AbstractApp.addPlaybackControls
- Defined in sims/common/AbstractApp.ts:222

addStandardControls

addStandardControls(): void
Adds the standard set of simulation controls: show energy, show clock, pan-zoom of simView, time step, time rate, diff eq solver, background menu

Returns void
Inherited from AbstractApp.addStandardControls
- Defined in sims/common/AbstractApp.ts:229

addURLScriptButton

addURLScriptButton(): void
Returns void
Inherited from AbstractApp.addURLScriptButton
- Defined in sims/common/AbstractApp.ts:298

broadcast

broadcast(evt): void
Notifies all Observers that this Subject has changed by calling observe on each Observer.

An Observer may call addObserver or removeObserver during its observe method.
Parameters
- evt: SubjectEvent
  a SubjectEvent with information relating to the change
Returns void
Implementation of Subject.broadcast
Inherited from AbstractApp.broadcast
- Defined in lab/util/AbstractSubject.ts:110

broadcastParameter

broadcastParameter(name): void
Notifies all Observers that the Parameter with the given name has changed by calling observe on each Observer.
Parameters
- name: string
  the language-independent or English name of the Parameter that has changed
Returns void
Throws
if there is no Parameter with the given name
Implementation of Subject.broadcastParameter
Inherited from AbstractApp.broadcastParameter
- Defined in lab/util/AbstractSubject.ts:132

defineNames

defineNames(myName): void
Define short-cut name replacement rules. For example sim is replaced by app.sim when myName is app.
Parameters
- myName: string
  the name of this object, valid in global Javascript context.
Returns void
Overrides AbstractApp.defineNames
- Defined in sims/springs/SingleSpringApp.ts:98

eval

eval(script, output?): any
Parameters
- script: string
- output: boolean = true
  whether to print the result to the output text area and add the script to session history; default is true
Returns any
the result of evaluating the string
Inherited from AbstractApp.eval
- Defined in sims/common/AbstractApp.ts:313

`Protected` getBroadcast

getBroadcast(): boolean
Returns whether broadcasting is enabled for this Subject. See setBroadcast.

Returns boolean
whether broadcasting is enabled for this Subject
Inherited from AbstractApp.getBroadcast
- Defined in lab/util/AbstractSubject.ts:144

getClassName

getClassName(): string
Returns name of class of this object.

Returns string
name of class of this object.
Overrides AbstractApp.getClassName
- Defined in sims/springs/SingleSpringApp.ts:93

getName

getName(): string
Return the language-independent name of this Subject for scripting purposes.

Returns string
name the language-independent name of this Subject
Implementation of Subject.getName
Inherited from AbstractApp.getName
- Defined in lab/util/AbstractSubject.ts:154

getObservers

getObservers(): Observer[]
Returns a copy of the list of Observers of this Subject.

Returns Observer[]
a copy of the list of Observers of this Subject.
Implementation of Subject.getObservers
Inherited from AbstractApp.getObservers
- Defined in lab/util/AbstractSubject.ts:159

getParameter

getParameter(name): Parameter
Returns the Parameter with the given name.
Parameters
- name: string
  the language-independent or English name of the Parameter
Returns Parameter
the Parameter with the given name

Throws
if there is no Parameter with the given name
Implementation of Subject.getParameter
Inherited from AbstractApp.getParameter
- Defined in lab/util/AbstractSubject.ts:173

getParameterBoolean

getParameterBoolean(name): ParameterBoolean
Returns the ParameterBoolean with the given name.
Parameters
- name: string
  the language-independent or English name of the ParameterBoolean
Returns ParameterBoolean
the ParameterBoolean with the given name

Throws
if there is no ParameterBoolean with the given name
Implementation of Subject.getParameterBoolean
Inherited from AbstractApp.getParameterBoolean
- Defined in lab/util/AbstractSubject.ts:182

getParameterNumber

getParameterNumber(name): ParameterNumber
Returns the ParameterNumber with the given name.
Parameters
- name: string
  the language-independent or English name of the ParameterNumber
Returns ParameterNumber
the ParameterNumber with the given name

Throws
if there is no ParameterNumber with the given name
Implementation of Subject.getParameterNumber
Inherited from AbstractApp.getParameterNumber
- Defined in lab/util/AbstractSubject.ts:191

getParameterString

getParameterString(name): ParameterString
Returns the ParameterString with the given name.
Parameters
- name: string
  the language-independent or English name of the ParameterString
Returns ParameterString
the ParameterString with the given name

Throws
if there is no ParameterString with the given name
Implementation of Subject.getParameterString
Inherited from AbstractApp.getParameterString
- Defined in lab/util/AbstractSubject.ts:200

getParameters

getParameters(): Parameter[]
Returns a copy of the list of this Subject's available Parameters.

Returns Parameter[]
a copy of the list of available Parameters for this Subject
Implementation of Subject.getParameters
Inherited from AbstractApp.getParameters
- Defined in lab/util/AbstractSubject.ts:209

getSubjects

getSubjects(): Subject[]
Returns list of Subjects contained in this object, possibly including this object itself.

Returns Subject[]
the Subjects contained in this object
Implementation of SubjectList.getSubjects
Inherited from AbstractApp.getSubjects
- Defined in sims/common/AbstractApp.ts:281

makeEasyScript

makeEasyScript(opt_dependent?): void
Creates the EasyScriptParser for this app. See explanation of dependent Subjects in EasyScriptParser documentation.
Parameters
- Optional opt_dependent: Subject[]
  additional dependent Subjects
Returns void
Inherited from AbstractApp.makeEasyScript
- Defined in sims/common/AbstractApp.ts:271

makeLayout

makeLayout(elem_ids): Layout
Parameters
- elem_ids: ElementIDs
Returns Layout
Inherited from AbstractApp.makeLayout
- Defined in sims/common/AbstractApp.ts:200

makeTimeGraph

makeTimeGraph(): TimeGraph1
Returns TimeGraph1
Inherited from AbstractApp.makeTimeGraph
- Defined in sims/common/AbstractApp.ts:378

removeObserver

removeObserver(observer): void
Removes the Observer from this Subject's list of Observers. An Observer may call removeObserver during its observe method.
Parameters
- observer: Observer
  the Observer to detach from list of Observers
Returns void
Implementation of Subject.removeObserver
Inherited from AbstractApp.removeObserver
- Defined in lab/util/AbstractSubject.ts:214

removeParameter

removeParameter(parameter): void
Removes the Parameter from the list of this Subject's available Parameters.
Parameters
- parameter: Parameter
  the Parameter to remove
Returns void
Inherited from AbstractApp.removeParameter
- Defined in lab/util/AbstractSubject.ts:226

`Protected` setBroadcast

setBroadcast(value): boolean
Sets whether this Subject will broadcast events, typically used to temporarily disable broadcasting. Intended to be used in situations where a subclass overrides a method that broadcasts an event. This allows the subclass to prevent the superclass broadcasting that event, so that the subclass can broadcast the event when the method is completed.
Parameters
- value: boolean
  whether this Subject should broadcast events
Returns boolean
the previous value
Inherited from AbstractApp.setBroadcast
- Defined in lab/util/AbstractSubject.ts:238

setup

setup(): void
Returns void
Inherited from AbstractApp.setup
- Defined in sims/common/AbstractApp.ts:330

start

start(): void
Start the application running.

Returns void
Inherited from AbstractApp.start
- Defined in sims/common/AbstractApp.ts:339

toString

toString(): string
Returns string
Inherit Doc
Overrides AbstractApp.toString
- Defined in sims/springs/SingleSpringApp.ts:85

toStringShort

toStringShort(): string
Returns a minimal string representation of this object, usually giving just identity information like the class name and name of the object.

For an object whose main purpose is to represent another Printable object, it is recommended to include the result of calling toStringShort on that other object. For example, calling toStringShort() on a DisplayShape might return something like this:
```
DisplayShape{polygon:Polygon{'chain3'}}
```
Returns string
a minimal string representation of this object.
Implementation of SubjectList.toStringShort
Inherited from AbstractApp.toStringShort
- Defined in lab/util/AbstractSubject.ts:61

`Static` loadClass

loadClass(): void
Force classes to be bundled (by esbuild), so they can be used in Terminal scripts.

Returns void
Inherited from AbstractApp.loadClass
- Defined in sims/common/AbstractApp.ts:320

Class SingleSpringApp

Hierarchy (view full)

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

elem_ids: ElementIDs

Optional opt_name: string

Returns SingleSpringApp

Methods

addControl

Parameters

control: LabControl

Returns LabControl

addObserver

Parameters

observer: Observer

Returns void

addParameter

Parameters

parameter: Parameter

Returns void

Throws

addPlaybackControls

Returns void

addStandardControls

Returns void

addURLScriptButton

Returns void

broadcast

Parameters

evt: SubjectEvent

Returns void

broadcastParameter

Parameters

name: string

Returns void

Throws

defineNames

Parameters

myName: string

Returns void

eval

Parameters

script: string

output: boolean = true

Returns any

Protected getBroadcast

Returns boolean

getClassName

Returns string

getName

Returns string

getObservers

Returns Observer[]

getParameter

Parameters

name: string

Returns Parameter

Throws

getParameterBoolean

Parameters

name: string

Returns ParameterBoolean

Throws

getParameterNumber

Parameters

name: string

Returns ParameterNumber

Throws

getParameterString

Parameters

name: string

Returns ParameterString

Throws

getParameters

Returns Parameter[]

`Optional` opt_name: string

`Protected` getBroadcast

`Optional` opt_dependent: Subject[]

`Protected` setBroadcast

`Static` loadClass