Interface IParameterSetCollection

Describes a class or struct that contains multiple parameter sets. These parameter sets can then be retrieved by their type.

Inherited Members
Namespace: SpiceSharp.ParameterSets
Assembly: SpiceSharp.dll
Syntax
public interface IParameterSetCollection : IParameterSet
Remarks

A parameter set collection should generally not contain parameter sets that define parameters or properties with identical names. Depending on the implementation it may result in some parameters not being set, or some properties becoming inaccessible via the interface methods.

Properties

ParameterSets

Gets all the parameter sets of this instance.

Declaration
IEnumerable<IParameterSet> ParameterSets { get; }
Property Value
Type Description
IEnumerable<IParameterSet>

The parameter sets.

Methods

GetParameterSet<P>()

Gets the parameter set of the specified type.

Declaration
P GetParameterSet<P>() where P : IParameterSet, ICloneable<P>
Returns
Type Description
P

The parameter set.
Type Parameters
Name Description
P

The parameter set type.
Exceptions
Type Condition
TypeNotFoundException

Thrown if the parameter set could not be found.

TryGetParameterSet<P>(out P)

Tries to get the parameter set of the specified type.

Declaration
bool TryGetParameterSet<P>(out P value) where P : IParameterSet, ICloneable<P>
Parameters
Type Name Description
P value

The parameter set.
Returns
Type Description
bool

true if the parameter set was found; otherwise, false.
Type Parameters
Name Description
P

The parameter set type.

Extension Methods

See Also