Header menu logo issie

EvilHoverCache Module

Functions and values

Function or value Description

addGapToStore store gap

Full Usage: addGapToStore store gap

Parameters:

Add a gap to the store, merging it with the previous gap if it is adjacent.

store : GapStore
gap : Gap

changeToolTip tipName tipText xPos yPos ttXMaxEdge isVisible

Full Usage: changeToolTip tipName tipText xPos yPos ttXMaxEdge isVisible

Parameters:
    tipName : string
    tipText : string - Text to display in the tooltip.
    xPos : float - X-coordinate of the tooltip.
    yPos : float - Y-coordinate of the tooltip.
    ttXMaxEdge : float - Maximum X-coordinate of the tooltip right edge.
    isVisible : bool - True if the tooltip is visible, false if it is hidden.

Change the tooltip text and position.

tipName : string
tipText : string

Text to display in the tooltip.

xPos : float

X-coordinate of the tooltip.

yPos : float

Y-coordinate of the tooltip.

ttXMaxEdge : float

Maximum X-coordinate of the tooltip right edge.

isVisible : bool

True if the tooltip is visible, false if it is hidden.

checkIfHatched store cycle

Full Usage: checkIfHatched store cycle

Parameters:
Returns: bool

Check if a wave is hatched at a given cycle. This is done by checking if the cycle is within any of the gaps in a mutable store, which is updated as gaps are added.

store : GapStore
cycle : int
Returns: bool

evilSvgToolTip tipName ws tipText textProps

Full Usage: evilSvgToolTip tipName ws tipText textProps

Parameters:
Returns: ReactElement

SVG group element for tooltip. The props of the tooltip, as well as its text, are set in the function changeToolTip. Initila props make it invisible.

tipName : string
ws : WaveSimModel
tipText : string
textProps : IProp list
Returns: ReactElement

finaliseStore store

Full Usage: finaliseStore store

Parameters:

Finalise the store by adding the last gap to the store.

store : GapStore

getRomCommentAtStep fs step wave

Full Usage: getRomCommentAtStep fs step wave

Parameters:
Returns: string

The comment written in a .ram file against the location a ROM is reading at a given simulation step, if the ROM has any comments and this wave is its data output. The location read is the address input one step earlier for a synchronous ROM and at the same step for an asynchronous one, which is the distinction WaveSimRams.addReadWrite also makes.

fs : FastSimulation
step : int
wave : Wave
Returns: string

getWaveToolTip cycle wave ws

Full Usage: getWaveToolTip cycle wave ws

Parameters:
Returns: string

Text for the tooltip shown when hovering a waveform at a given cycle, or "" for no tooltip. A value is given when the wave is too narrow there to have its number printed on it - the cached "gap" data says when that is - and a ROM's data output also gives the comment written against the location being read, so that both appear when the number is hidden as well. The wave is passed in rather than counted off SelectedWaves by row number. The rows drawn are the selected waves that AllWaves still HOLDS - see WaveSimStyle.selectedWaves, which the three columns are all built from - so counting rows off SelectedWaves itself answered for a different row wherever the two differ, and indexed AllWaves with a key it might not have.

cycle : int
wave : Wave
ws : WaveSimModel
Returns: string

initGapStore maxGaps

Full Usage: initGapStore maxGaps

Parameters:
    maxGaps : int

Returns: GapStore

A gap in the wave simulator, represented by a start cycle and a length. the only gaps that are stored are relevant are those that correspond to hatched parts of the waveform in which the wave value is not printed.

maxGaps : int
Returns: GapStore

Type something to start searching.