FastRun Module
Nested modules
Modules | Description |
Functions and values
Function or value | Description |
Full Usage:
buildFastSimulation simulationArraySize diagramName graph
Parameters:
int
diagramName : string
graph : SimulationGraph
Returns: Result<FastSimulation, SimulationError>
|
|
Full Usage:
buildFastSimulationFData simulationArraySize diagramName graph
Parameters:
int
diagramName : string
graph : SimulationGraph
Returns: Result<FastSimulation, SimulationError>
|
|
Full Usage:
canBeReduced fs step fc
Parameters:
FastSimulation
step : int
fc : FastComponent
Returns: bool
Modifiers: inline |
|
Full Usage:
changeInput cid input step fastSim
Parameters:
ComponentId
input : FSInterface
step : int
fastSim : FastSimulation
|
|
Full Usage:
changeInputBatch step fastSim changes
Parameters:
int
fastSim : FastSimulation
changes : (ComponentId * FSInterface) list
|
|
Full Usage:
changeInputFData cid input step fastSim
Parameters:
ComponentId
input : FSInterface
step : int
fastSim : FastSimulation
|
|
Full Usage:
checkAndValidate fs
Parameters:
FastSimulation
Returns: Result<FastSimulation, SimulationError>
|
|
Full Usage:
checkAndValidateFData fs
Parameters:
FastSimulation
Returns: Result<FastSimulation, SimulationError>
|
|
Full Usage:
compareLoadedStates fs (arg2, arg3) p
Parameters:
FastSimulation
arg1 : Component list
arg2 : Connection list
p : Project option
Returns: bool
|
|
Full Usage:
createFastArrays fs gather
Parameters:
FastSimulation
gather : GatherData
Returns: FastSimulation
|
|
Full Usage:
extractFastSimulationIOs simIOs simulationData
Parameters:
SimulationIO list
simulationData : SimulationData
Returns: (SimulationIO * FSInterface) list
|
|
Full Usage:
extractFastSimulationIOsFData simIOs simulationData
Parameters:
SimulationIO list
simulationData : SimulationData
Returns: (SimulationIO * FSInterface) list
|
|
Full Usage:
extractFastSimulationOutput fs step (arg3, arg4) opn
Parameters:
FastSimulation
step : int
arg2 : ComponentId
arg3 : ComponentId list
opn : OutputPortNumber
Returns: FSInterface
|
|
Full Usage:
extractFastSimulationOutputFData fs step (arg3, arg4) opn
Parameters:
FastSimulation
step : int
arg2 : ComponentId
arg3 : ComponentId list
opn : OutputPortNumber
Returns: FSInterface
|
|
Full Usage:
extractFastSimulationState fs step (arg3, arg4)
Parameters:
FastSimulation
step : int
arg2 : ComponentId
arg3 : ComponentId list
Returns: SimulationComponentState
|
|
Full Usage:
extractFastSimulationWidth fs (arg2, arg3) opn
Parameters:
FastSimulation
arg1 : ComponentId
arg2 : ComponentId list
opn : OutputPortNumber
Returns: int
|
|
Full Usage:
extractStatefulComponents step fastSim
Parameters:
int
fastSim : FastSimulation
Returns: (FastComponent * SimulationComponentState)[]
|
|
Full Usage:
extractViewers simulationData
Parameters:
SimulationData
Returns: ((string * string) * int * FSInterface) list
|
|
Full Usage:
findSimulationComponent (arg1, arg2) sd
Parameters:
ComponentId
arg1 : ComponentId list
sd : SimulationData
Returns: SimulationComponent
|
|
Full Usage:
findSimulationComponentOpt (arg1, arg2) graph
Parameters:
ComponentId
arg1 : ComponentId list
graph : SimulationGraph
Returns: SimulationComponent option
|
|
Full Usage:
getFLabel fs (arg2, arg3)
Parameters:
FastSimulation
arg1 : ComponentId
arg2 : ComponentId list
Returns: string * string
|
|
|
|
Full Usage:
printComp fs step fc
Parameters:
FastSimulation
step : int
fc : FastComponent
Returns: string
|
|
Full Usage:
runFastSimulation timeOut lastStepNeeded fs
Parameters:
float option
lastStepNeeded : int
fs : FastSimulation
Returns: float option
|
Run an existing fast simulation up to the given number of steps. This function will mutate the write-once data arrays of simulation data and only simulate the new steps needed, so it may return immediately doing no work. If the simulation data arrays are not large enough they are extended up to a limit. After that, they act as a circular buffer. TimeOut if not None is the cutoff time after which the simulation terminates execution unfinished. Use fs.ClockTick to determine whether simulation has completed. returns speed, in clock cycles per ms, or None if complete
|