Show / Hide Table of Contents

Class Parameters

The parameters for a Sampler.

Inheritance
object
ParameterSet
ParameterSet<Parameters>
Parameters
Implements
ICloneable<Parameters>
IImportParameterSet<IEnumerable<double>>
IExportPropertySet<IEnumerable<double>>
IImportParameterSet<double>
IExportPropertySet<double>
IParameterSet
Inherited Members
ParameterSet<Parameters>.Clone()
ParameterSet.SetParameter<P>(string, P)
ParameterSet.TrySetParameter<P>(string, P)
ParameterSet.GetProperty<P>(string)
ParameterSet.TryGetProperty<P>(string, out P)
ParameterSet.CreateParameterSetter<P>(string)
ParameterSet.CreatePropertyGetter<P>(string)
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: SpiceSharp.Components.SamplerBehaviors
Assembly: SpiceSharp.dll
Syntax
public class Parameters : ParameterSet<Parameters>, ICloneable<Parameters>, IImportParameterSet<IEnumerable<double>>, IExportPropertySet<IEnumerable<double>>, IImportParameterSet<double>, IExportPropertySet<double>, IParameterSet

Properties

MinDelta

Gets or sets the minimum timestep that needs to be respected by the sampler.

Declaration
[ParameterName("deltamin")]
[ParameterInfo("The minimum timestep that needs to be respected by the sampler")]
[GreaterThan(0)]
public double MinDelta { get; set; }
Property Value
Type Description
double

The minimum timestep.

Points

Gets or sets the time-points that need to be hit.

Declaration
[ParameterName("points")]
[ParameterInfo("The points that need to be hit")]
public IEnumerable<double> Points { get; set; }
Property Value
Type Description
IEnumerable<double>

The time-points to be hit.

Methods

Export(object, EventArgs)

Calls the ExportSimulationData event.

Declaration
public void Export(object sender, EventArgs args)
Parameters
Type Name Description
object sender

The sender.

EventArgs args

The argument.

Events

ExportSimulationData

Occurs when data can be exported.

Declaration
public event EventHandler<EventArgs> ExportSimulationData
Event Type
Type Description
EventHandler<EventArgs>

Implements

ICloneable<T>
IImportParameterSet<P>
IExportPropertySet<P>
IImportParameterSet<P>
IExportPropertySet<P>
IParameterSet

Extension Methods

Utility.ThrowIfNull<T>(T, string)
Documentation.ParameterValues<T>(IParameterSet, bool)
Documentation.Parameters(IParameterSet)

See Also

ParameterSet
In this article
Back to top Generated by DocFX