Obtains simulation data from Multisim.

Syntax


Sub GetOutputData ( _
       ByVal outputName As String, _
       ByRef dataArray As Variant), _
       method As SimulationInterpolation)

Parameters

outputName—The name of a Multisim probe at which the data should be collected, as returned by EnumOutputs.

dataArray—A two-dimensional array which will be filled with the output data values, where:

  • dataArray(0,n-1) contains the nth time (or frequency) value.
  • dataArray(1,n-1) contains the real part of the nth data value.
  • dataArray(2,n-1) contains the imaginary part of the nth data value (used in frequency-domain analyses).

method—Returns the interpolation method that was used, which should always match the one set by the original output request. Frequency sweeps always return SimulationInterpolationRaw.

Remarks

Data is returned from the simulator in blocks, the size of which are specified in the output request function (numSamples parameter).

Calling this function removes the data from the MultisimCircuit object, so subsequent calls to this function with a given outputName return subsequent datasets collected under that output (or an error if no data remains).

If the simulation has been stopped (either by a call to StopSimulation or by the end of the defined simulation time) before an output is complete, a partial data set is returned.

In time-domain simulations, the third set of values in dataArray (2,n-1) is not used, and is set to zero.

Example

See example for OutputReady.

See Also

EnumOutputs

Note on Outputs