Issie logo Issie

WaveNames Module

The name a waveform is called, worked out from the component and port it is a wave of. Below the UI because both simulators produce it. A name carries the port's BIT WIDTH, and a width is a fact about the elaborated instance rather than about the sheet it instantiates - parameters see to that - so nothing above can work one out from a design. The alternative is the sidecar reimplementing which port of a Mux is called SEL and how an adder's carry in is written, and two answers that agree until they do not. Moved out of `WaveSimHelpers`, which is where it was and which now opens it. What stayed there is everything that needs a WaveSimModel: `makeWave` builds a Wave, and a Wave is a thing the selector holds.

Functions and values

Function or value Description

bitLimsString (a, b)

Full Usage: bitLimsString (a, b)

Parameters:
    a : int
    b : int

Returns: string

get string in the [x:x] format given the bit limits output representation of bus width

a : int
b : int
Returns: string

camelCaseDottedWords text

Full Usage: camelCaseDottedWords text

Parameters:
    text : string

Returns: string

convert a string to CamelCase:

text : string
Returns: string

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

getInputNameW withComp compType label insWidths outsWidths port

Full Usage: getInputNameW withComp compType label insWidths outsWidths port

Parameters:
Returns: string

The name of one input port, from design facts plus the instance's port widths.

withComp : bool
compType : ComponentType
label : string
insWidths : int array
outsWidths : int array
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

getInputPortNumber ipn

Full Usage: getInputPortNumber ipn

Parameters:
Returns: int

get integer from OutputPortNumber

ipn : InputPortNumber
Returns: int

getOutputNameW withComp compType label insWidths outsWidths port

Full Usage: getOutputNameW withComp compType label insWidths outsWidths port

Parameters:
Returns: string

The name of one output port, from design facts plus the instance's port widths. The IOLabel case is the one the fc-based version needed a whole simulation for - which member of the group drives the net - and needs nothing here: the slice width of an IOLabel's output IS the elected driver's, because the group shares its array.

withComp : bool
compType : ComponentType
label : string
insWidths : int array
outsWidths : int array
port : OutputPortNumber
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

getOutputPortNumber opn

Full Usage: getOutputPortNumber opn

Parameters:
Returns: int

get integer from OutputPortNumber

opn : OutputPortNumber
Returns: int

Type something to start searching.