Header menu logo issie

FastSimulation Type

Record fields

Record Field Description

ClockTick

Full Usage: ClockTick

Field type: int
Modifiers: mutable

last step number (starting from 0) which is simulated.

Field type: int

ComponentsById

Full Usage: ComponentsById

Field type: Map<string, Map<ComponentId, Component>>

This contains all components in the sheets of the simulation indexed by ComponentId. Subsheet components are indexed only once. Contrast this with Fast Components - which have the design expanded out with one per instance: the different versions correspond to distinct access paths.

Field type: Map<string, Map<ComponentId, Component>>

ConnectionsByPort

Full Usage: ConnectionsByPort

Field type: Map<SheetPort, Connection list>

Connections on simulated sheets indexed by directly connected port. Each connection appears twice.

Field type: Map<SheetPort, Connection list>

Drivers

Full Usage: Drivers

Field type: Driver option array

Each driver represents one output with its data

Field type: Driver option array

FClockedComps

Full Usage: FClockedComps

Field type: FastComponent array

clocked components

Field type: FastComponent array

FComps

Full Usage: FComps

Field type: Map<FComponentId, FastComponent>

Fast components: this array is longer than FOrderedComps because it contains IOlabel components that are redundant in the simulation. It doe snot contain custom Components

Field type: Map<FComponentId, FastComponent>

FConstantComps

Full Usage: FConstantComps

Field type: FastComponent array

constants

Field type: FastComponent array

FCustomComps

Full Usage: FCustomComps

Field type: Map<FComponentId, FastComponent>

Custom Components.

Field type: Map<FComponentId, FastComponent>

FCustomOutputCompLookup

Full Usage: FCustomOutputCompLookup

Field type: Map<((ComponentId * ComponentId list) * OutputPortNumber), FComponentId>

look up from output port of custom component to the relevant Output component

Field type: Map<((ComponentId * ComponentId list) * OutputPortNumber), FComponentId>

FGlobalInputComps

Full Usage: FGlobalInputComps

Field type: FastComponent array

top-level inputs to the simulation

Field type: FastComponent array

FIOActive

Full Usage: FIOActive

Field type: Map<(ComponentLabel * ComponentId list), FastComponent>
Modifiers: mutable

which is the active component for each set of labels?

Field type: Map<(ComponentLabel * ComponentId list), FastComponent>

FIOLinks

Full Usage: FIOLinks

Field type: ((FastComponent * InputPortNumber) * FastComponent) list
Modifiers: mutable

list of deferred links driven from inactive IOlabls - at end of linkage the corresponding active IOLabel can be substituted as driver an dthe link made

Field type: ((FastComponent * InputPortNumber) * FastComponent) list

FOrderedComps

Full Usage: FOrderedComps

Field type: FastComponent array

Components that will be reduced in order allowing sequential reduction to implement simulation

Field type: FastComponent array

MaxArraySize

Full Usage: MaxArraySize

Field type: int

Maximum size of simulation arrays - after which they form a circular buffer

Field type: int

NumStepArrays

Full Usage: NumStepArrays

Field type: int

Total number of step arrays (= drivers)

Field type: int

SimSheetStructure

Full Usage: SimSheetStructure

Field type: Map<string, FastComponent option>

Map from SimSheetName to the parent sheet CustomComponent, or None if the sheet is top-level

Field type: Map<string, FastComponent option>

SimulatedCanvasState

Full Usage: SimulatedCanvasState

Field type: LoadedComponent list

Circuit simulated (sheet and all dependencies)

Field type: LoadedComponent list

SimulatedTopSheet

Full Usage: SimulatedTopSheet

Field type: string

The root sheet being simulated

Field type: string

StepCost

Full Usage: StepCost

Field type: StepCost

What one clock cycle of this design costs in step arrays. Worked out before the arrays were allocated, by FastCreate.stepCostOfDesign, and kept so that the waveform simulator's configuration can say what a given number of cycles would come to.

Field type: StepCost

WaveComps

Full Usage: WaveComps

Field type: Map<FComponentId, FastComponent>

Fast components: this map is longer than FComps because it contains Custom components not used by Fast simulation but needed in Waveform simulation

Field type: Map<FComponentId, FastComponent>

WaveIndex

Full Usage: WaveIndex

Field type: WaveIndexT array

Each wave index represents one component port with associated driver and data

Field type: WaveIndexT array

Instance members

Instance member Description

this.getSheetNameOfInstance simSheetName

Full Usage: this.getSheetNameOfInstance simSheetName

Parameters:
    simSheetName : string

Returns: string

The design-time name of the sheet an instance is of: what the user called it, and what they see in the Sheets menu. SimSheetName is not a sheet name. It says WHICH INSTANCE, as the path of custom component labels down to it, and is unique because it has to be - it keys SimSheetStructure and groups waves. Anything telling the user which sheet something is in wants this instead.

simSheetName : string
Returns: string

Type something to start searching.