Class SimulationStateBuilder

Builds a SimulationState for use with all simulation functions

Required to set:

currentPosition: number
trackName: string

Hierarchy

SimulationStateBuilder

Implements

Partial<recordUtil.SimulationState>

Index

Constructors

Properties

currentPosition? hasPassedTrackEnd modelDirection timeInterval trackName?

Methods

build withCurrentPosition withHasPassedTrackEnd withModelDirection withTimeInterval withTrackName

Constructors

constructor

new SimulationStateBuilder(): recordUtil.SimulationStateBuilder
Returns recordUtil.SimulationStateBuilder
- Defined in src/recordUtil/simulationStateBuilder.ts:19

Properties

`Optional` currentPosition

currentPosition?: number

hasPassedTrackEnd

hasPassedTrackEnd: boolean

modelDirection

modelDirection: boolean

timeInterval

timeInterval: number

`Optional` trackName

trackName?: string

Methods

build

build(): Result<recordUtil.SimulationState, string>
Returns Result<recordUtil.SimulationState, string>
- Defined in src/recordUtil/simulationStateBuilder.ts:27

withCurrentPosition

withCurrentPosition(position: number): recordUtil.SimulationStateBuilder
Parameters
- position: number
Returns recordUtil.SimulationStateBuilder
- Defined in src/recordUtil/simulationStateBuilder.ts:45

withHasPassedTrackEnd

withHasPassedTrackEnd(value: boolean): recordUtil.SimulationStateBuilder
Parameters
- value: boolean
Returns recordUtil.SimulationStateBuilder
- Defined in src/recordUtil/simulationStateBuilder.ts:69

withModelDirection

withModelDirection(direction: boolean): recordUtil.SimulationStateBuilder
Parameters
- direction: boolean
Returns recordUtil.SimulationStateBuilder
- Defined in src/recordUtil/simulationStateBuilder.ts:51

withTimeInterval

withTimeInterval(interval: number): recordUtil.SimulationStateBuilder
Parameters
- interval: number
Returns recordUtil.SimulationStateBuilder
- Defined in src/recordUtil/simulationStateBuilder.ts:63

withTrackName

withTrackName(name: string): recordUtil.SimulationStateBuilder
Parameters
- name: string
Returns recordUtil.SimulationStateBuilder
- Defined in src/recordUtil/simulationStateBuilder.ts:57

Generated using TypeDoc