WaveSimSelect (issie)

WaveSimSelect Module

Namespace: global
Assembly: Renderer.dll

Functions and values

Function or value	Description
`cap sheet` Full Usage: `cap sheet` Parameters: sheet : `string` Returns: `string`	sheet : `string` Returns: `string`
`caseCompAndPortName name` Full Usage: `caseCompAndPortName name` Parameters: name : `string` Returns: `string`	name : `string` Returns: `string`
`checkBoxItem wsModel isChecked waveIds dispatch` Full Usage: `checkBoxItem wsModel isChecked waveIds dispatch` Parameters: wsModel : `WaveSimModel` isChecked : `bool` waveIds : `WaveIndexT list` dispatch : `Msg -> unit` Returns: `ReactElement`	Implemements a checkbox, with toggle state stored in WaveSimModel under ShowDetailMap using waveIds as key. wsModel : `WaveSimModel` isChecked : `bool` waveIds : `WaveIndexT list` dispatch : `Msg -> unit` Returns: `ReactElement`
`checkboxRow wsModel dispatch index` Full Usage: `checkboxRow wsModel dispatch index` Parameters: wsModel : `WaveSimModel` dispatch : `Msg -> unit` index : `WaveIndexT` Returns: `ReactElement`	Table row of a checkbox and name of a wave. wsModel : `WaveSimModel` dispatch : `Msg -> unit` index : `WaveIndexT` Returns: `ReactElement`
`ensureWaveConsistency ws` Full Usage: `ensureWaveConsistency ws` Parameters: ws : `WaveSimModel` Returns: `Wave list * WaveIndexT list`	This is a workaropund for a potential data inconsistency in the waves and selected waves of a FastSimulation it ensure that the selector only lists valid waves by filyering all waves against valid components It would be better to understand the (occasional) bug taht leads to this inconsistency. ws : `WaveSimModel` Returns: `Wave list * WaveIndexT list`
`getInputName withComp comp port` Full Usage: `getInputName withComp comp port` Parameters: withComp : `bool` comp : `FastComponent` port : `InputPortNumber` Returns: `string`	Get names for waves that are from Input ports withComp : `bool` comp : `FastComponent` port : `InputPortNumber` Returns: `string`
`getInputPortName compType port` Full Usage: `getInputPortName compType port` Parameters: compType : `ComponentType` port : `InputPortNumber` 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: index : `WaveIndexT` fastSim : `FastSimulation` 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: withComp : `bool` comp : `FastComponent` port : `OutputPortNumber` fastSim : `FastSimulation` Returns: `string`	Get names for waves that are from Output ports withComp : `bool` comp : `FastComponent` port : `OutputPortNumber` fastSim : `FastSimulation` Returns: `string`
`getOutputPortName compType port` Full Usage: `getOutputPortName compType port` Parameters: compType : `ComponentType` port : `OutputPortNumber` Returns: `string`	Get port names for waves that are from Output ports Appended to comp.Label compType : `ComponentType` port : `OutputPortNumber` Returns: `string`
`getWaves ws fs` Full Usage: `getWaves ws fs` Parameters: ws : `WaveSimModel` fs : `FastSimulation` Returns: `Map<WaveIndexT, Wave>`	Get all simulatable waves from CanvasState. Includes top-level Input and Output ports. Waves contain info which will be used later to create the SVGs for those waves actually selected. Init value of these from this function is None. ws : `WaveSimModel` fs : `FastSimulation` Returns: `Map<WaveIndexT, Wave>`
`infoButton` Full Usage: `infoButton` Returns: `ReactElement`	Returns: `ReactElement`
`makeComponentGroup showDetails ws dispatch subSheet cGroup waves` Full Usage: `makeComponentGroup showDetails ws dispatch subSheet cGroup waves` Parameters: showDetails : `bool` ws : `WaveSimModel` dispatch : `Msg -> Unit` subSheet : `string list` cGroup : `ComponentGroup` waves : `Wave list` Returns: `ReactElement`	Returns a tr react element representing a component with ports detailed beneath showDetails : `bool` ws : `WaveSimModel` dispatch : `Msg -> Unit` subSheet : `string list` cGroup : `ComponentGroup` waves : `Wave list` Returns: `ReactElement`
`makeComponentRow showDetails ws dispatch fc waves` Full Usage: `makeComponentRow showDetails ws dispatch fc waves` Parameters: showDetails : `bool` ws : `WaveSimModel` dispatch : `Msg -> Unit` fc : `FastComponent` waves : `Wave list` Returns: `ReactElement`	Returns a tr react element representing a component with ports detailed beneath showDetails : `bool` ws : `WaveSimModel` dispatch : `Msg -> Unit` fc : `FastComponent` waves : `Wave list` Returns: `ReactElement`
`makePortRow ws dispatch waves` Full Usage: `makePortRow ws dispatch waves` Parameters: ws : `WaveSimModel` dispatch : `Msg -> Unit` waves : `Wave list` Returns: `ReactElement`	implements one row (with one port) ws : `WaveSimModel` dispatch : `Msg -> Unit` waves : `Wave list` Returns: `ReactElement`
`makeSelectionGroup showDetails ws dispatch summaryItem rowItems cBox waves` Full Usage: `makeSelectionGroup showDetails ws dispatch summaryItem rowItems cBox waves` Parameters: showDetails : `bool` ws : `WaveSimModel` dispatch : `Msg -> Unit` summaryItem : `ReactElement` rowItems : `ReactElement list` cBox : `CheckBoxStyle` waves : `Wave list` Returns: `ReactElement`	returns a tr react element representing a thing with a checkbox with summary name and details beneath showDetails : `bool` ws : `WaveSimModel` dispatch : `Msg -> Unit` summaryItem : `ReactElement` rowItems : `ReactElement list` cBox : `CheckBoxStyle` waves : `Wave list` Returns: `ReactElement`
`makeSheetRow showDetails ws dispatch subSheet waves` Full Usage: `makeSheetRow showDetails ws dispatch subSheet waves` Parameters: showDetails : `bool` ws : `WaveSimModel` dispatch : `Msg -> Unit` subSheet : `string list` waves : `Wave list` Returns: `ReactElement`	showDetails : `bool` ws : `WaveSimModel` dispatch : `Msg -> Unit` subSheet : `string list` waves : `Wave list` Returns: `ReactElement`
`makeWave ws fastSim wi` Full Usage: `makeWave ws fastSim wi` Parameters: ws : `WaveSimModel` fastSim : `FastSimulation` wi : `WaveIndexT` 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: fastSim : `FastSimulation` dispName : `string` waveIndex : `WaveIndexT` Returns: `string`	fastSim : `FastSimulation` dispName : `string` waveIndex : `WaveIndexT` Returns: `string`
`searchBar wsModel dispatch` Full Usage: `searchBar wsModel dispatch` Parameters: wsModel : `WaveSimModel` dispatch : `Msg -> unit` Returns: `ReactElement`	Search bar to allow users to filter out waves by DisplayName some special cases '-', '*' collapse or expand (for selected waves) the wave select window. wsModel : `WaveSimModel` dispatch : `Msg -> unit` Returns: `ReactElement`
`selectAll wsModel dispatch` Full Usage: `selectAll wsModel dispatch` Parameters: wsModel : `WaveSimModel` dispatch : `Msg -> Unit` Returns: `ReactElement`	Row in wave selection table that selects all values in wsModel.AllWaves wsModel : `WaveSimModel` dispatch : `Msg -> Unit` Returns: `ReactElement`
`selectRamButton wsModel dispatch` Full Usage: `selectRamButton wsModel dispatch` Parameters: wsModel : `WaveSimModel` dispatch : `Msg -> unit` Returns: `ReactElement`	Button to activate RAM selection modal. wsModel : `WaveSimModel` dispatch : `Msg -> unit` Returns: `ReactElement`
`selectRamModal wsModel dispatch` Full Usage: `selectRamModal wsModel dispatch` Parameters: wsModel : `WaveSimModel` dispatch : `Msg -> unit` Returns: `ReactElement`	Modal that, when active, allows users to select RAMs to view their contents. wsModel : `WaveSimModel` dispatch : `Msg -> unit` Returns: `ReactElement`
`selectWaves ws subSheet dispatch` Full Usage: `selectWaves ws subSheet dispatch` Parameters: ws : `WaveSimModel` subSheet : `string list` dispatch : `Msg -> unit` Returns: `ReactElement`	ws : `WaveSimModel` subSheet : `string list` dispatch : `Msg -> unit` Returns: `ReactElement`
`selectWavesButton wsModel dispatch` Full Usage: `selectWavesButton wsModel dispatch` Parameters: wsModel : `WaveSimModel` dispatch : `Msg -> unit` Returns: `ReactElement`	Button to activate wave selection modal wsModel : `WaveSimModel` dispatch : `Msg -> unit` Returns: `ReactElement`
`selectWavesModal wsModel dispatch` Full Usage: `selectWavesModal wsModel dispatch` Parameters: wsModel : `WaveSimModel` dispatch : `Msg -> unit` Returns: `ReactElement`	Modal that, when active, allows users to select waves to be viewed. wsModel : `WaveSimModel` dispatch : `Msg -> unit` Returns: `ReactElement`
`toggleRamSelection (arg1, arg2) ramLabel wsModel dispatch` Full Usage: `toggleRamSelection (arg1, arg2) ramLabel wsModel dispatch` Parameters: arg0 : `ComponentId` arg1 : `ComponentId list` ramLabel : `string` wsModel : `WaveSimModel` dispatch : `Msg -> 'a` 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`
`toggleSelectAll selected wsModel dispatch` Full Usage: `toggleSelectAll selected wsModel dispatch` Parameters: selected : `bool` wsModel : `WaveSimModel` dispatch : `Msg -> unit`	Sets all waves as selected or not selected depending on value of selected selected : `bool` wsModel : `WaveSimModel` dispatch : `Msg -> unit`
`toggleSelectSubGroup wsModel dispatch selected waves` Full Usage: `toggleSelectSubGroup wsModel dispatch selected waves` Parameters: wsModel : `WaveSimModel` dispatch : `Msg -> 'a` selected : `bool` waves : `WaveIndexT list` Returns: `'a`	Toggle selection of a list of waves. wsModel : `WaveSimModel` dispatch : `Msg -> 'a` selected : `bool` waves : `WaveIndexT list` Returns: `'a`
`toggleWaveSelection index wsModel dispatch` Full Usage: `toggleWaveSelection index wsModel dispatch` Parameters: index : `WaveIndexT` wsModel : `WaveSimModel` dispatch : `Msg -> unit`	Toggle selection for a single wave. index : `WaveIndexT` wsModel : `WaveSimModel` dispatch : `Msg -> unit`
`waveCheckBoxItem wsModel waveIds dispatch` Full Usage: `waveCheckBoxItem wsModel waveIds dispatch` Parameters: wsModel : `WaveSimModel` waveIds : `WaveIndexT list` dispatch : `Msg -> unit` Returns: `ReactElement`	Implemements a checkbox, with toggle state determined by SelectedWaves. wsModel : `WaveSimModel` waveIds : `WaveIndexT list` dispatch : `Msg -> unit` Returns: `ReactElement`