Show / Hide Table of Contents

Interface IRules

Describes a rule provider.

Inherited Members
IParameterSetCollection.GetParameterSet<P>()
IParameterSetCollection.TryGetParameterSet<P>(out P)
IParameterSetCollection.ParameterSets
IParameterSet.SetParameter<P>(string, P)
IParameterSet.TrySetParameter<P>(string, P)
IParameterSet.GetProperty<P>(string)
IParameterSet.TryGetProperty<P>(string, out P)
IParameterSet.CreateParameterSetter<P>(string)
IParameterSet.CreatePropertyGetter<P>(string)
IEnumerable<IRule>.GetEnumerator()
Namespace: SpiceSharp.Validation
Assembly: SpiceSharp.dll
Syntax
public interface IRules : IParameterSetCollection, IParameterSet, IEnumerable<IRule>, IEnumerable

Properties

ViolationCount

Gets the number of rule violations.

Declaration
int ViolationCount { get; }
Property Value
Type Description
int

The number of rule violations.

Violations

Gets the violated rules.

Declaration
IEnumerable<IRuleViolation> Violations { get; }
Property Value
Type Description
IEnumerable<IRuleViolation>

The violated rules.

Methods

GetRules<R>()

Gets all rules of the specified type.

Declaration
IEnumerable<R> GetRules<R>() where R : IRule
Returns
Type Description
IEnumerable<R>

The rules of the specified type.

Type Parameters
Name Description
R

The rule type.

Reset()

Resets all the rules.

Declaration
void Reset()

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

IParameterSetCollection
IEnumerable<T>
In this article
Back to top Generated by DocFX