WaveSimTop (issie) | issie

WaveSimTop Module

Namespace: global
Assembly: Renderer.dll

Top-level functions for Waveform Simulator

Functions and values

Function or value	Description
`cancelSpinner model` Full Usage: `cancelSpinner model` Parameters: model : `Model` Returns: `Model`	remove the spinner popup model : `Model` Returns: `Model`
`refreshButtonAction (arg1, arg2) model dispatch arg5` Full Usage: `refreshButtonAction (arg1, arg2) model dispatch arg5` Parameters: arg0 : `Component list` arg1 : `Connection list` model : `'a` dispatch : `Msg -> 'b` arg4 : `'c` Returns: `'b`	Refresh the state of the wave simulator according to the model and canvas state. Redo a new simulation. Set inputs to default values. Then call refreshWaveSim via RefreshWaveSim message. 1st parameter ofrefreshWaveSin will be set true which causes all waves to be necessarily regenerated. arg0 : `Component list` arg1 : `Connection list` model : `'a` dispatch : `Msg -> 'b` arg4 : `'c` Returns: `'b`
`refreshWaveSim newSimulation wsModel model` Full Usage: `refreshWaveSim newSimulation wsModel model` Parameters: newSimulation : `bool` wsModel : `WaveSimModel` model : `Model` Returns: `Model * Cmd<Msg>`	Major function called after changes to extend simulation and/or redo waveforms. Note that after design change simulation must be recreated externally, and the function called with newSimulation = true. That is because this function has no way to know that the simulation has changed. This function performs (as required) three actions. 1. Extend the simulation to the current cycle (if not already done). 2. Remake the Wave headers, one for each selected waveform. 3. Remake (or make for first time) the saved waveform SVGs for all selected waveforms. newSimulation : `bool` wsModel : `WaveSimModel` model : `Model` Returns: `Model * Cmd<Msg>`
`setButtonSpinner payload model` Full Usage: `setButtonSpinner payload model` Parameters: payload : `(Msg -> unit) -> Model -> Model` model : `Model` Returns: `Model`	payload : `(Msg -> unit) -> Model -> Model` model : `Model` Returns: `Model`
`setProgressBar name payload numToDo model` Full Usage: `setProgressBar name payload numToDo model` Parameters: name : `string` payload : `(Msg -> unit) -> Model -> Model` numToDo : `int` model : `Model` Returns: `Model`	Start or update a spinner popup name : `string` payload : `(Msg -> unit) -> Model -> Model` numToDo : `int` model : `Model` Returns: `Model`
`topHalf (arg1, arg2) model dispatch` Full Usage: `topHalf (arg1, arg2) model dispatch` Parameters: arg0 : `Component list` arg1 : `Connection list` model : `Model` dispatch : `Msg -> unit` Returns: `ReactElement * bool`	ReactElement showing instructions and wave sim buttons arg0 : `Component list` arg1 : `Connection list` model : `Model` dispatch : `Msg -> unit` Returns: `ReactElement * bool`
`viewWaveSim (arg1, arg2) model dispatch` Full Usage: `viewWaveSim (arg1, arg2) model dispatch` Parameters: arg0 : `Component list` arg1 : `Connection list` model : `Model` dispatch : `Msg -> unit` Returns: `ReactElement`	Entry point to the waveform simulator. arg0 : `Component list` arg1 : `Connection list` model : `Model` dispatch : `Msg -> unit` Returns: `ReactElement`