Class FloatingNodeRule

An IConductiveRule that checks for the presence of a floating node.

Inheritance

object

FloatingNodeRule

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 FloatingNodeRule : IConductiveRule, IRule

Constructors

FloatingNodeRule(IVariable)

Initializes a new instance of the FloatingNodeRule class.

Declaration

public FloatingNodeRule(IVariable fixedVariable)

Parameters

Type	Name	Description
IVariable	fixedVariable	The fixed-potential variable.

Properties

FixedVariable

Gets or sets the fixed-potential node.

Declaration

public IVariable FixedVariable { get; }

Property Value

Type	Description
IVariable	The fixed-potential node.

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 violations.

Declaration

public IEnumerable<IRuleViolation> Violations { get; }

Property Value

Type	Description
IEnumerable<IRuleViolation>	The 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.

Contains(Variable)

Determines whether this rule encountered the specified variable.

Declaration

public bool Contains(Variable variable)

Parameters

Type	Name	Description
Variable	variable	The variable.

Returns

Type	Description
bool	true if the specified variable was encountered; otherwise, false.

Reset()

Resets the rule.

Declaration

public void Reset()

Implements

IConductiveRule

IRule

Extension Methods

Utility.ThrowIfNull<T>(T, string)

See Also

IConductiveRule