Show / Hide Table of Contents

Class Rules

Necessary rules for biasing simulations.

Inheritance
object
ParameterSet
ParameterSetCollection
BaseRules
Rules
Rules
Implements
IRules
IParameterSetCollection
IParameterSet
IEnumerable<IRule>
IEnumerable
IParameterized<ComponentRuleParameters>
Inherited Members
BaseRules.ViolationCount
BaseRules.Violations
BaseRules.Reset()
BaseRules.GetRules<R>()
ParameterSetCollection.GetParameterSet<P>()
ParameterSetCollection.TryGetParameterSet<P>(out P)
ParameterSetCollection.ParameterSets
ParameterSetCollection.SetParameter<P>(string, P)
ParameterSetCollection.TrySetParameter<P>(string, P)
ParameterSetCollection.GetProperty<P>(string)
ParameterSetCollection.TryGetProperty<P>(string, out P)
ParameterSetCollection.CreateParameterSetter<P>(string)
ParameterSetCollection.CreatePropertyGetter<P>(string)
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: SpiceSharp.Simulations.Biasing
Assembly: SpiceSharp.dll
Syntax
public class Rules : BaseRules, IRules, IParameterSetCollection, IParameterSet, IEnumerable<IRule>, IEnumerable, IParameterized<ComponentRuleParameters>

Constructors

Rules(IVariableFactory<IVariable>, IEqualityComparer<string>)

Initializes a new instance of the Rules class.

Declaration
public Rules(IVariableFactory<IVariable> factory, IEqualityComparer<string> comparer)
Parameters
Type Name Description
IVariableFactory<IVariable> factory

The variable factory.

IEqualityComparer<string> comparer

The comparer for variable names.

Exceptions
Type Condition
ArgumentNullException

Thrown if factory is null.

Properties

Parameters

Gets the parameter set.

Declaration
public ComponentRuleParameters Parameters { get; }
Property Value
Type Description
ComponentRuleParameters

The parameter set.

Methods

GetEnumerator()

Returns an enumerator that iterates through the collection.

Declaration
public override IEnumerator<IRule> GetEnumerator()
Returns
Type Description
IEnumerator<IRule>

An enumerator that can be used to iterate through the collection.

Overrides
BaseRules.GetEnumerator()

Implements

IRules
IParameterSetCollection
IParameterSet
IEnumerable<T>
IEnumerable
IParameterized<P>

Extension Methods

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

See Also

BaseRules
IParameterized<P>
ComponentRuleParameters
In this article
Back to top Generated by DocFX