Header menu logo issie

SimulationView Module

Types and nested modules

Type/Module Description

Constants

SimCache

Functions and values

Function or value Description

InputDefaultsEqualInputs fs model clocktick

Full Usage: InputDefaultsEqualInputs fs model clocktick

Parameters:
Returns: bool
fs : FastSimulation
model : Model
clocktick : int
Returns: bool

InputDefaultsEqualInputsRefresh fs model

Full Usage: InputDefaultsEqualInputsRefresh fs model

Parameters:
Returns: bool
fs : FastSimulation
model : Model
Returns: bool

cacheIsEqual cache ldcs

Full Usage: cacheIsEqual cache ldcs

Parameters:
Returns: bool
cache : SimCache
ldcs : LoadedComponent list
Returns: bool

changeBase dispatch numBase

Full Usage: changeBase dispatch numBase

Parameters:
Returns: 'a
dispatch : Msg -> 'a
numBase : NumberBase
Returns: 'a

cmd block

Full Usage: cmd block

Parameters:
    block : Async<unit> -> unit

Returns: ('a -> Async<'b>) -> 'a -> ('b -> 'c) -> Cmd<'c>
block : Async<unit> -> unit
Returns: ('a -> Async<'b>) -> 'a -> ('b -> 'c) -> Cmd<'c>

doBatchOfMsgsAsynch msgs

Full Usage: doBatchOfMsgsAsynch msgs

Parameters:
    msgs : Msg seq

Returns: Cmd<Msg>
msgs : Msg seq
Returns: Cmd<Msg>

getPosRotNextToPort port model dist

Full Usage: getPosRotNextToPort port model dist

Parameters:
Returns: (XYPos * Rotation) option

get the position and rotation for inserting a new component next to the given port at a given distance the rotation is such that the original left side of the component (input side) faces the given port returns None if another symbol is in the way

port : Port
model : Model
dist : float
Returns: (XYPos * Rotation) option

getSimErrFeedbackMessages simError model

Full Usage: getSimErrFeedbackMessages simError model

Parameters:
Returns: Msg list
simError : SimulationError
model : Model
Returns: Msg list

makeDummySimulationError msg

Full Usage: makeDummySimulationError msg

Parameters:
    msg : string

Returns: SimulationError
msg : string
Returns: SimulationError

makeIOLabel label width

Full Usage: makeIOLabel label width

Parameters:
    label : string
    width : int

Returns: string

Pretty print a label with its width.

label : string
width : int
Returns: string

prepareSimulationMemoized simulationArraySize openFileName diagramName (arg4, arg5) loadedDependencies

Full Usage: prepareSimulationMemoized simulationArraySize openFileName diagramName (arg4, arg5) loadedDependencies

Parameters:
Returns: Result<SimulationData, SimulationError> * CanvasState

Start up a simulation, doing all necessary checks and generating simulation errors if necesary. The code to do this is quite long so results are memoized.

simulationArraySize : int
openFileName : string
diagramName : string
arg3 : Component list
arg4 : Connection list
loadedDependencies : LoadedComponent list
Returns: Result<SimulationData, SimulationError> * CanvasState

setFastSimInputsToDefault fs

Full Usage: setFastSimInputsToDefault fs

Parameters:
fs : FastSimulation

setInputDefaultsFromInputs fs dispatch clocktick

Full Usage: setInputDefaultsFromInputs fs dispatch clocktick

Parameters:
fs : FastSimulation
dispatch : Msg -> Unit
clocktick : int

setSimErrorFeedback simError model dispatch

Full Usage: setSimErrorFeedback simError model dispatch

Parameters:
simError : SimulationError
model : Model
dispatch : Msg -> Unit

simCache

Full Usage: simCache

Returns: SimCache

Used to store last canvas state and its simulation

Returns: SimCache

simCacheInit ()

Full Usage: simCacheInit ()

Parameters:
    () : unit

Returns: SimCache
() : unit
Returns: SimCache

simReset dispatch

Full Usage: simReset dispatch

Parameters:
    dispatch : Msg -> unit

dispatch : Msg -> unit

simulateModel simulatedSheet simulationArraySize (arg3, arg4) model

Full Usage: simulateModel simulatedSheet simulationArraySize (arg3, arg4) model

Parameters:
Returns: Result<SimulationData, SimulationError> * CanvasState

Start simulating the current Diagram. Return SimulationData that can be used to extend the simulation as needed, or error if simulation fails. Note that simulation is only redone if current canvas changes.

simulatedSheet : string option
simulationArraySize : int
arg2 : Component list
arg3 : Connection list
model : Model
Returns: Result<SimulationData, SimulationError> * CanvasState

simulateWithProgressBar simProg model

Full Usage: simulateWithProgressBar simProg model

Parameters:
Returns: Model * Cmd<Msg>
simProg : SimulationProgress
model : Model
Returns: Model * Cmd<Msg>

simulateWithTime timeOut steps simData

Full Usage: simulateWithTime timeOut steps simData

Parameters:
Returns: float
timeOut : 'a
steps : int
simData : SimulationData
Returns: float

simulationClockChangeAction dispatch simData model'

Full Usage: simulationClockChangeAction dispatch simData model'

Parameters:
dispatch : Msg -> unit
simData : SimulationData
model' : Model

storedstateisEqual cache ldcs

Full Usage: storedstateisEqual cache ldcs

Parameters:
Returns: bool
cache : SimCache
ldcs : LoadedComponent list
Returns: bool

tryGetSimData (arg1, arg2) model

Full Usage: tryGetSimData (arg1, arg2) model

Parameters:
Returns: Result<SimulationData, SimulationError>
arg0 : Component list
arg1 : Connection list
model : Model
Returns: Result<SimulationData, SimulationError>

tryStartSimulationAfterErrorFix simType model

Full Usage: tryStartSimulationAfterErrorFix simType model

Parameters:
Returns: Model * Cmd<Msg>
simType : SimSubTab
model : Model
Returns: Model * Cmd<Msg>

verilogOutput vType model dispatch

Full Usage: verilogOutput vType model dispatch

Parameters:

save verilog file TODO: the simulation error display here is shared with step simulation and also waveform simulation - maybe it should be a subfunction.

vType : VMode
model : Model
dispatch : Msg -> Unit

viewSimulation (arg1, arg2) model dispatch

Full Usage: viewSimulation (arg1, arg2) model dispatch

Parameters:
Returns: ReactElement
arg0 : Component list
arg1 : Connection list
model : Model
dispatch : Msg -> Unit
Returns: ReactElement

viewSimulationError (comps, conns) simError model simType dispatch

Full Usage: viewSimulationError (comps, conns) simError model simType dispatch

Parameters:
Returns: ReactElement
comps : Component list
conns : Connection list
simError : SimulationError
model : Model
simType : SimSubTab
dispatch : Msg -> unit
Returns: ReactElement

Type something to start searching.