Class VariablePresenceRule

An IConductiveRule that will check for the presence of a specific variable.

Inheritance

object

VariablePresenceRule

Implements

IConductiveRule

IRule

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: SpiceSharp.Validation

Assembly: SpiceSharp.dll

Syntax

public class VariablePresenceRule : IConductiveRule, IRule

Constructors

VariablePresenceRule(IVariable)

Initializes a new instance of the VariablePresenceRule class.

Declaration

public VariablePresenceRule(IVariable search)

Parameters

Type	Name	Description
IVariable	search	The varibale that needs to be present.

Properties

ViolationCount

Gets the number of violations of this rule.

Declaration

public int ViolationCount { get; }

Property Value

Type	Description
int	The violation count.

Violations

Gets the rule violations.

Declaration

public IEnumerable<IRuleViolation> Violations { get; }

Property Value

Type	Description
IEnumerable<IRuleViolation>	The rule violations.

Methods

AddPath(IRuleSubject, params IVariable[])

Applies the specified variables as being connected by a conductive path.

Declaration

public void AddPath(IRuleSubject subject, params IVariable[] variables)

Parameters

Type	Name	Description
IRuleSubject	subject	The rule subject.
IVariable[]	variables	The variables.

AddPath(IRuleSubject, ConductionTypes, params IVariable[])

Specifies variables as being connected by a conductive path of the specified type.

Declaration

public void AddPath(IRuleSubject subject, ConductionTypes type, params IVariable[] variables)

Parameters

Type	Name	Description
IRuleSubject	subject	The subject that applies the conductive paths.
ConductionTypes	type	The type of path between these variables.
IVariable[]	variables	The variables that are connected.

Reset()

Resets the rule.

Declaration

public void Reset()

Implements

IConductiveRule

IRule

Extension Methods

Utility.ThrowIfNull<T>(T, string)

See Also

IConductiveRule