Class AM

This class implements an amplitude-modulated waveform.

Inheritance
object
ParameterSet
ParameterSet<IWaveformDescription>
AM
Implements
Inherited Members
Namespace: SpiceSharp.Components
Assembly: SpiceSharp.dll
Syntax
public class AM : ParameterSet<IWaveformDescription>, IWaveformDescription, ICloneable<IWaveformDescription>, IImportParameterSet<double>, IExportPropertySet<double>, IImportParameterSet<double[]>, IImportParameterSet<GivenParameter<double>>, IExportPropertySet<GivenParameter<double>>, IParameterSet

Constructors

AM()

Initializes a new instance of the SFFM class.

Declaration
public AM()

AM(double, double, double, double, double, double, double)

Initializes a new instance of the SFFM class.

Declaration
public AM(double amplitude, double offset, double modulationFrequency, double carrierFrequency, double signalDelay, double carrierPhase, double signalPhase)
Parameters
Type Name Description
double amplitude

The amplitude value.
double offset

The offset value.
double modulationFrequency

The modulation frequency.
double carrierFrequency

The carrier frequency.
double signalDelay

The signal delay.
double carrierPhase

The carrier phase.
double signalPhase

The signal phase.

Properties

Amplitude

Gets or sets the amplitude value.

Declaration
[ParameterName("va")]
[ParameterInfo("Amplitude")]
public double Amplitude { get; set; }
Property Value
Type Description
double

CarrierFrequency

Gets or sets the signal frequency.

Declaration
[ParameterName("fc")]
[ParameterInfo("Carrier frequency", Units = "Hz")]
[GreaterThanOrEquals(0)]
public GivenParameter<double> CarrierFrequency { get; set; }
Property Value
Type Description
GivenParameter<double>

CarrierPhase

Gets or sets the carrier phase.

Declaration
[ParameterName("phasec")]
[ParameterInfo("Carrier phsae", Units = "°")]
public double CarrierPhase { get; set; }
Property Value
Type Description
double

ModulationFrequency

Gets or sets the carrier frequency.

Declaration
[ParameterName("mf")]
[ParameterInfo("Modulation frequency", Units = "Hz")]
[GreaterThanOrEquals(0)]
public GivenParameter<double> ModulationFrequency { get; set; }
Property Value
Type Description
GivenParameter<double>

Offset

Gets or sets the offset value.

Declaration
[ParameterName("vo")]
[ParameterInfo("DC offset")]
public double Offset { get; set; }
Property Value
Type Description
double

SignalDelay

Gets or sets the signal delay.

Declaration
[ParameterName("td")]
[ParameterInfo("Signal delay", Units = "s")]
public double SignalDelay { get; set; }
Property Value
Type Description
double

SignalPhase

Gets or sets the signal phase.

Declaration
[ParameterName("phases")]
[ParameterInfo("Signal phase", Units = "°")]
public double SignalPhase { get; set; }
Property Value
Type Description
double

Methods

Create(IBindingContext)

Creates a waveform instance for the specified simulation and entity.

Declaration
public IWaveform Create(IBindingContext context)
Parameters
Type Name Description
IBindingContext context

The binding context.
Returns
Type Description
IWaveform

The waveform instance.

SetSffm(double[])

Sets all SFFM parameters.

Declaration
[ParameterName("sffm")]
[ParameterInfo("Specify the waveform as a vector")]
public void SetSffm(double[] sffm)
Parameters
Type Name Description
double[] sffm

The SFFM parameters.
Exceptions
Type Condition
ArgumentException

Thrown if sffm does not have 1 - 5 parameters.

ToString()

Returns a string that represents the current single-frequency FM waveform.

Declaration
public override string ToString()
Returns
Type Description
string

A string that represents the current SFFM.
Overrides

Implements

Extension Methods