Header menu logo issie

WaveSimModel Type

Contains all information required by waveform simulator. One WaveSimModel per sheet.

Record fields

Record Field Description

AllWaves

Full Usage: AllWaves

Field type: Map<WaveIndexT, Wave>

Map of all simulatable waves

Field type: Map<WaveIndexT, Wave>

ClkCycleBoxIsEmpty

Full Usage: ClkCycleBoxIsEmpty

Field type: bool

If the user is typing a clock cycle in but erases the contents of the box.

Field type: bool

CurrClkCycle

Full Usage: CurrClkCycle

Field type: int

Current highlighted clock cycle.

Field type: int

DraggedIndex

Full Usage: DraggedIndex

Field type: WaveIndexT option

The index of the wave which the user is dragging.

Field type: WaveIndexT option

FastSim

Full Usage: FastSim

Field type: FastSimulation

FastSimulation used in the wave simulator.

Field type: FastSimulation

HoveredLabel

Full Usage: HoveredLabel

Field type: WaveIndexT option

The label which a user is hovering over.

Field type: WaveIndexT option

PrevSelectedWaves

Full Usage: PrevSelectedWaves

Field type: WaveIndexT list option

The value of SelectedWaves when the user started dragging a label. Used to restore SelectedWaves if the user drops a label in an illegal location.

Field type: WaveIndexT list option

Radix

Full Usage: Radix

Field type: NumberBase

Radix in which values are being displayed in the wave simulator.

Field type: NumberBase

RamComps

Full Usage: RamComps

Field type: FastComponent list

List of RAM components on the sheet.

Field type: FastComponent list

RamModalActive

Full Usage: RamModalActive

Field type: bool

If the ram selection modal is visible.

Field type: bool

SearchString

Full Usage: SearchString

Field type: string

String which the user is searching the list of waves by.

Field type: string

SelectedRams

Full Usage: SelectedRams

Field type: Map<FComponentId, string>

Map of which RAM components have been selected.

Field type: Map<FComponentId, string>

SelectedWaves

Full Usage: SelectedWaves

Field type: WaveIndexT list

List of which waves are currently visible in the waveform viewer.

Field type: WaveIndexT list

Sheets

Full Usage: Sheets

Field type: Map<string, CanvasState>

Copy of all sheets used with reduced canvasState as simulated

Field type: Map<string, CanvasState>

ShowComponentDetail

Full Usage: ShowComponentDetail

Field type: Set<FComponentId>

What is shown in wave sim component detail elements

Field type: Set<FComponentId>

ShowGroupDetail

Full Usage: ShowGroupDetail

Field type: Set<ComponentGroup * string list>

What is shown in wave sim group detail elements

Field type: Set<ComponentGroup * string list>

ShowSheetDetail

Full Usage: ShowSheetDetail

Field type: Set<string list>

What is shown in wave sim sheet detail elements

Field type: Set<string list>

ShownCycles

Full Usage: ShownCycles

Field type: int

Total number of visible clock cycles.

Field type: int

StartCycle

Full Usage: StartCycle

Field type: int

Left-most visible clock cycle.

Field type: int

State

Full Usage: State

Field type: WaveSimState

Current state of WaveSimModel.

Field type: WaveSimState

TopSheet

Full Usage: TopSheet

Field type: string

Top-level sheet for current waveform simulation: copy of model.WaveSimSheet when simulation is running

Field type: string

WaveModalActive

Full Usage: WaveModalActive

Field type: bool

TODO: Should this be refactored into an ActiveModal type option? If the wave selection modal is visible.

Field type: bool

WaveformColumnWidth

Full Usage: WaveformColumnWidth

Field type: float

Width of the waveform column.

Field type: float

Type something to start searching.