Header menu logo issie

WaveSimSelect Module

Functions and values

Function or value Description

cap sheet

Full Usage: cap sheet

Parameters:
    sheet : string

Returns: string

return sheet with all latters capitalised

sheet : string
Returns: string

caseCompAndPortName name

Full Usage: caseCompAndPortName name

Parameters:
    name : string

Returns: string
name : string
Returns: string

getInputName withComp comp port

Full Usage: getInputName withComp comp port

Parameters:
Returns: string

Get names for waves that are from Input ports TODO: unify this with DrawBlock and widthInferror logic

withComp : bool
comp : FastComponent
port : InputPortNumber
Returns: string

getInputPortName compType port

Full Usage: getInputPortName compType port

Parameters:
Returns: string

Get port names for waves that are from Input ports. Appended to comp.Label

compType : ComponentType
port : InputPortNumber
Returns: string

getName index fastSim

Full Usage: getName index fastSim

Parameters:
Returns: string

Get name for a wave. Names are generated from component label, port name, and bit width of wave.

index : WaveIndexT
fastSim : FastSimulation
Returns: string

getOutputName withComp comp port fastSim

Full Usage: getOutputName withComp comp port fastSim

Parameters:
Returns: string

Get names for waves that are from Output ports TODO: unify this with DrawBlock and widthInferror logic

withComp : bool
comp : FastComponent
port : OutputPortNumber
fastSim : FastSimulation
Returns: string

getOutputPortName compType port

Full Usage: getOutputPortName compType port

Parameters:
Returns: string

Get port names for waves that are from Output ports Appended to comp.Label

compType : ComponentType
port : OutputPortNumber
Returns: string

makeWave ws fastSim wi

Full Usage: makeWave ws fastSim wi

Parameters:
Returns: Wave

Make Wave for each component and port on sheet

ws : WaveSimModel
fastSim : FastSimulation
wi : WaveIndexT
Returns: Wave

nameWithSheet fastSim dispName waveIndex

Full Usage: nameWithSheet fastSim dispName waveIndex

Parameters:
Returns: string

The sheet name here is the runtime (simulation) sheet instance name Derived from sheet name with disambiguation if needed

fastSim : FastSimulation
dispName : string
waveIndex : WaveIndexT
Returns: string

selectRamButton wsModel dispatch

Full Usage: selectRamButton wsModel dispatch

Parameters:
Returns: ReactElement

Button to activate RAM selection modal.

wsModel : WaveSimModel
dispatch : Msg -> unit
Returns: ReactElement

selectRamModal wsModel dispatch

Full Usage: selectRamModal wsModel dispatch

Parameters:
Returns: ReactElement

Modal that, when active, allows users to select RAMs to view their contents.

wsModel : WaveSimModel
dispatch : Msg -> unit
Returns: ReactElement

selectWavesButton wsModel dispatch

Full Usage: selectWavesButton wsModel dispatch

Parameters:
Returns: ReactElement

Button to activate wave selection modal

wsModel : WaveSimModel
dispatch : Msg -> unit
Returns: ReactElement

toggleRamSelection (arg1, arg2) ramLabel wsModel dispatch

Full Usage: toggleRamSelection (arg1, arg2) ramLabel wsModel dispatch

Parameters:
Returns: 'a

Toggle if a RAM's contents is selected for viewing.

arg0 : ComponentId
arg1 : ComponentId list
ramLabel : string
wsModel : WaveSimModel
dispatch : Msg -> 'a
Returns: 'a

Type something to start searching.