FastExtract (issie)

FastExtract Module

Namespace: global
Assembly: Renderer.dll

Functions and values

Function or value	Description
`changeInput cid input step fastSim` Full Usage: `changeInput cid input step fastSim` Parameters: cid : `ComponentId` input : `FSInterface` step : `int` fastSim : `FastSimulation`	Change an input and make simulation correct. N.B. step must be the latest time-step since future steps are not rerun (TODO: perhaps they should be!) cid : `ComponentId` input : `FSInterface` step : `int` fastSim : `FastSimulation`
`changeInputBatch step fastSim changes` Full Usage: `changeInputBatch step fastSim changes` Parameters: step : `int` fastSim : `FastSimulation` changes : `(ComponentId * FSInterface) list`	Change multiple inputs in one batch before re-running the simulation NOTE - Only used in TruthTable step : `int` fastSim : `FastSimulation` changes : `(ComponentId * FSInterface) list`
`changeInputFData cid input step fastSim` Full Usage: `changeInputFData cid input step fastSim` Parameters: cid : `ComponentId` input : `FSInterface` step : `int` fastSim : `FastSimulation`	cid : `ComponentId` input : `FSInterface` step : `int` fastSim : `FastSimulation`
`compareLoadedStates fs (arg2, arg3) p` Full Usage: `compareLoadedStates fs (arg2, arg3) p` Parameters: fs : `FastSimulation` arg1 : `Component list` arg2 : `Connection list` p : `Project option` Returns: `bool`	Check if the components and connections of a fast simulation and a canvas are the same. fs : `FastSimulation` arg1 : `Component list` arg2 : `Connection list` p : `Project option` Returns: `bool`
`extractFastSimulationIOs simIOs simulationData` Full Usage: `extractFastSimulationIOs simIOs simulationData` Parameters: simIOs : `SimulationIO list` simulationData : `SimulationData` Returns: `(SimulationIO * FSInterface) list`	Extract top-level inputs or outputs with names and wire widths. Used by legacy code. simIOs : `SimulationIO list` simulationData : `SimulationData` Returns: `(SimulationIO * FSInterface) list`
`extractFastSimulationIOsFData simIOs simulationData` Full Usage: `extractFastSimulationIOsFData simIOs simulationData` Parameters: simIOs : `SimulationIO list` simulationData : `SimulationData` Returns: `(SimulationIO * FSInterface) list`	As extractFastSimulationIOs but for FData - used by truth table logic. simIOs : `SimulationIO list` simulationData : `SimulationData` Returns: `(SimulationIO * FSInterface) list`
`extractFastSimulationOutput fs step (arg3, arg4) opn` Full Usage: `extractFastSimulationOutput fs step (arg3, arg4) opn` Parameters: fs : `FastSimulation` step : `int` arg2 : `ComponentId` arg3 : `ComponentId list` opn : `OutputPortNumber` Returns: `FSInterface`	return output port data from simulation as a Bit list Each element in list is one bit fs : `FastSimulation` step : `int` arg2 : `ComponentId` arg3 : `ComponentId list` opn : `OutputPortNumber` Returns: `FSInterface`
`extractFastSimulationOutputFData fs step (arg3, arg4) opn` Full Usage: `extractFastSimulationOutputFData fs step (arg3, arg4) opn` Parameters: fs : `FastSimulation` step : `int` arg2 : `ComponentId` arg3 : `ComponentId list` opn : `OutputPortNumber` Returns: `FSInterface`	fs : `FastSimulation` step : `int` arg2 : `ComponentId` arg3 : `ComponentId list` opn : `OutputPortNumber` Returns: `FSInterface`
`extractFastSimulationState fs step (arg3, arg4)` Full Usage: `extractFastSimulationState fs step (arg3, arg4)` Parameters: fs : `FastSimulation` step : `int` arg2 : `ComponentId` arg3 : `ComponentId list` Returns: `SimulationComponentState`	return state data from simulation fs : `FastSimulation` step : `int` arg2 : `ComponentId` arg3 : `ComponentId list` Returns: `SimulationComponentState`
`extractFastSimulationWidth fs (arg2, arg3) opn` Full Usage: `extractFastSimulationWidth fs (arg2, arg3) opn` Parameters: fs : `FastSimulation` arg1 : `ComponentId` arg2 : `ComponentId list` opn : `OutputPortNumber` Returns: `int`	Extract the width of a component's output port. fs : `FastSimulation` arg1 : `ComponentId` arg2 : `ComponentId list` opn : `OutputPortNumber` Returns: `int`
`extractStatefulComponents step fastSim` Full Usage: `extractStatefulComponents step fastSim` Parameters: step : `int` fastSim : `FastSimulation` Returns: `(FastComponent * SimulationComponentState)[]`	step : `int` fastSim : `FastSimulation` Returns: `(FastComponent * SimulationComponentState)[]`
`extractViewers simulationData` Full Usage: `extractViewers simulationData` Parameters: simulationData : `SimulationData` Returns: `((string * string) * int * FSInterface) list`	Extract all Viewer components with names and wire widths. simulationData : `SimulationData` Returns: `((string * string) * int * FSInterface) list`
`getArrayOfOutputs fc outputNum ticks` Full Usage: `getArrayOfOutputs fc outputNum ticks` Parameters: fc : `FastComponent` outputNum : `int` ticks : `int` Returns: `bigint array`	Return array of simulation output values for a given output port. Values are returned from steos 0 to (tick - 1). Used by testParsser. Only works if tick < maxArraySize. fc : `FastComponent` outputNum : `int` ticks : `int` Returns: `bigint array`
`getFLabel fs (arg2, arg3)` Full Usage: `getFLabel fs (arg2, arg3)` Parameters: fs : `FastSimulation` arg1 : `ComponentId` arg2 : `ComponentId list` Returns: `string * string`	Extract a component's label and its full name which includes all of its path to root of simulation. fs : `FastSimulation` arg1 : `ComponentId` arg2 : `ComponentId list` Returns: `string * string`
`getFastComponentInput fc inputNum step` Full Usage: `getFastComponentInput fc inputNum step` Parameters: fc : `FastComponent` inputNum : `int` step : `int` Returns: `bigint` Modifiers: inline	Get the input value of a fast component as a bigint. fc: the fast component to get the input from. inputNum: which input as numbered in the inputs array. step: which time step to get the value from. used by waveSimSVGs, maybe this function could be moved there and optimised as code there at cost of modularity. fc : `FastComponent` inputNum : `int` step : `int` Returns: `bigint`
`getFastComponentOutput fc outputNum step` Full Usage: `getFastComponentOutput fc outputNum step` Parameters: fc : `FastComponent` outputNum : `int` step : `int` Returns: `bigint` Modifiers: inline	Get the output value of a fast component as a bigint. fc: the fast component to get the output from. outputNum: which output as numbered in the outputs array. step: which time step to get the value from. used by waveSimSVGs, maybe this function could be moved there and optimised as code there at cost of modularity. fc : `FastComponent` outputNum : `int` step : `int` Returns: `bigint`
`outputsAreTheSameAsDefault fs fc tick currdefault` Full Usage: `outputsAreTheSameAsDefault fs fc tick currdefault` Parameters: fs : `FastSimulation` fc : `FastComponent` tick : `int` currdefault : `bigint` Returns: `bool`	Check if a fastComponent output is the same as the default value for all time steps. Used by simulationView. The current implementation seems not quite right when tick > MaxArraySize. ToDo - make this work for all time steps fs : `FastSimulation` fc : `FastComponent` tick : `int` currdefault : `bigint` Returns: `bool`