Show / Hide Table of Contents

Class ComplexVoltageExport

A class that exports complex voltages.

Inheritance
object
Export<Complex>
ComplexVoltageExport
Implements
IExport<Complex>
Inherited Members
Export<Complex>.Simulation
Export<Complex>.Value
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
Namespace: SpiceSharp.Simulations
Assembly: SpiceSharp.dll
Syntax
public class ComplexVoltageExport : Export<Complex>, IExport<Complex>

Constructors

ComplexVoltageExport(IFrequencySimulation, Reference, Reference)

Initializes a new instance of the ComplexVoltageExport class.

Declaration
public ComplexVoltageExport(IFrequencySimulation simulation, Reference posNode, Reference refNode = default)
Parameters
Type Name Description
IFrequencySimulation simulation

The simulation.

Reference posNode

The positive node (can be a string or a string array for a path).

Reference refNode

The reference/negative node (can be a string or a string array for a path).

Exceptions
Type Condition
ArgumentNullException

Thrown if simulation is null.

ArgumentException

Thrown if posNode and refNode are both empty.

Properties

Decibels

Gets the amplitude in decibels (dB).

Declaration
public Complex Decibels { get; }
Property Value
Type Description
Complex

Phase

Gets the phase in radians.

Declaration
public Complex Phase { get; }
Property Value
Type Description
Complex

Positive

Gets the positive node.

Declaration
public Reference Positive { get; }
Property Value
Type Description
Reference

Reference

Gets the reference node.

Declaration
public Reference Reference { get; }
Property Value
Type Description
Reference

Methods

BuildExtractor(ISimulation)

Builds the extractor for the given simulation.

Declaration
protected override Func<Complex> BuildExtractor(ISimulation simulation)
Parameters
Type Name Description
ISimulation simulation

The simulation.

Returns
Type Description
Func<Complex>

The extractor.

Overrides
Export<Complex>.BuildExtractor(ISimulation)

ToString()

Converts the export to a string.

Declaration
public override string ToString()
Returns
Type Description
string

The string.

Overrides
object.ToString()

Implements

IExport<T>

Extension Methods

Utility.ThrowIfNull<T>(T, string)

See Also

Export<T>
In this article
Back to top Generated by DocFX