Class Noise.NoiseSimulationState

A class that represents the state of a Noise analysis.

Inheritance

object

Noise.NoiseSimulationState

Implements

INoiseSimulationState

ISimulationState

Inherited Members

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

protected class Noise.NoiseSimulationState : INoiseSimulationState, ISimulationState

Constructors

NoiseSimulationState(string)

Initializes a new instance of the Noise.NoiseSimulationState class.

Declaration

public NoiseSimulationState(string name)

Parameters

Type	Name	Description
string	name	The name.

Exceptions

Type	Condition
ArgumentNullException	Thrown if name is null.

Properties

Name

Declaration

public string Name { get; }

Property Value

Type	Description
string

OutputNoiseDensity

Gets the total output noise density of all noise sources in the circuit.

Declaration

public double OutputNoiseDensity { get; }

Property Value

Type	Description
double	The total output noise density.

Point

Gets the history of input data points. The index 0 contains the current point.

Declaration

public IHistory<NoisePoint> Point { get; }

Property Value

Type	Description
IHistory<NoisePoint>	The history of data points.

TotalInputNoise

Gets the total integrated input noise of all noise sources in the circuit.

Declaration

public double TotalInputNoise { get; }

Property Value

Type	Description
double	The total integrated input noise.

TotalOutputNoise

Gets the total integrated output noise of all noise sources in the circuit.

Declaration

public double TotalOutputNoise { get; }

Property Value

Type	Description
double	The total integrated output noise.

Methods

Add(INoiseSource)

Adds the contributions of the specified noise source.

Declaration

public void Add(INoiseSource source)

Parameters

Type	Name	Description
INoiseSource	source	The noise source.

Exceptions

Type	Condition
ArgumentNullException	Thrown if source is null.

Add(params INoiseSource[])

Adds the contributions of the specified noise sources.

Declaration

public void Add(params INoiseSource[] sources)

Parameters

Type	Name	Description
INoiseSource[]	sources	The noise sources.

Exceptions

Type	Condition
ArgumentNullException	Thrown if sources or any of the noise sources is null.

Reset(NoisePoint)

Reset the frequency, and resets all noise contributions as well as the total integrated noise.

Declaration

public void Reset(NoisePoint point)

Parameters

Type	Name	Description
NoisePoint	point	The point.

SetCurrentPoint(NoisePoint)

Sets the current noise data point.

Declaration

public void SetCurrentPoint(NoisePoint point)

Parameters

Type	Name	Description
NoisePoint	point	The noise data point.

Implements

INoiseSimulationState

ISimulationState

Extension Methods

Utility.ThrowIfNull<T>(T, string)

See Also

ISimulationState