Class ExportDataEventArgs

A class that describes exported simulation data. Can be used by simulations to pass exported simulation data as an event argument. This class contains some helper methods for extracting data from the simulation.

Inheritance

object

EventArgs

ExportDataEventArgs

Inherited Members

EventArgs.Empty

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: SpiceSharp.Simulations

Assembly: SpiceSharp.dll

Syntax

public class ExportDataEventArgs : EventArgs

Constructors

ExportDataEventArgs(ISimulation)

Initializes a new instance of the ExportDataEventArgs class.

Declaration

public ExportDataEventArgs(ISimulation simulation)

Parameters

Type	Name	Description
ISimulation	simulation	The simulation.

Properties

Frequency

Gets the frequency if the simulation supports it.

Declaration

public double Frequency { get; }

Property Value

Type	Description
double

Laplace

Gets the laplace variable if the simulation supports it.

Declaration

public Complex Laplace { get; }

Property Value

Type	Description
Complex

Time

Gets the time if the simulation supports it.

Declaration

public double Time { get; }

Property Value

Type	Description
double

Methods

GetComplexVoltage(string)

Gets the complex voltage at a specific node.

Declaration

public Complex GetComplexVoltage(string node)

Parameters

Type	Name	Description
string	node	The node name.

Returns

Type	Description
Complex	The extracted voltage.

Remarks

For better performance, consider using ComplexVoltageExport

See Also

ComplexVoltageExport

GetComplexVoltage(string, string)

Gets the differential complex voltage between two specified nodes.

Declaration

public Complex GetComplexVoltage(string positive, string negative)

Parameters

Type	Name	Description
string	positive	The name of the node at the positive probe.
string	negative	The name of the node at the negative probe.

Returns

Type	Description
Complex	The extracted voltage.

GetSweepValues()

Gets the current sweep value if the simulation is a DC analysis.

Declaration

public double[] GetSweepValues()

Returns

Type	Description
double[]	The sweep values.

GetVoltage(string)

Gets the voltage at a specified node.

Declaration

public double GetVoltage(string node)

Parameters

Type	Name	Description
string	node	The node name.

Returns

Type	Description
double	The extracted voltage.

Remarks

For better performance, consider using RealVoltageExport.

See Also

RealVoltageExport

GetVoltage(string, string)

Gets the differential voltage between two specified nodes.

Declaration

public double GetVoltage(string positive, string negative)

Parameters

Type	Name	Description
string	positive	The name of the node at the positive probe.
string	negative	The name of the node at the negative probe.

Returns

Type	Description
double	The extracted voltage.

Extension Methods

Utility.ThrowIfNull<T>(T, string)

See Also

EventArgs