Interface IComponent

An interface that describes a component that can be connected in a circuit.

Inherited Members

IEntity.Name

IEntity.LinkParameters

IEntity.CreateBehaviors(ISimulation)

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)

ICloneable<IEntity>.Clone()

Namespace: SpiceSharp.Components

Assembly: SpiceSharp.dll

Syntax

public interface IComponent : IEntity, IParameterSetCollection, IParameterSet, ICloneable<IEntity>

Properties

Model

Gets or sets the name of the component model.

Declaration

string Model { get; set; }

Property Value

Type	Description
string	The name of the component model.

Nodes

Gets a list of all the nodes that the component is connected to.

Declaration

IReadOnlyList<string> Nodes { get; }

Property Value

Type	Description
IReadOnlyList<string>	The nodes.

Methods

Connect(params string[])

Connects the component in the circuit.

Declaration

IComponent Connect(params string[] nodes)

Parameters

Type	Name	Description
string[]	nodes	The node indices.

Returns

Type	Description
IComponent	The instance calling the method for chaining.

Exceptions

Type	Condition
ArgumentNullException	Thrown if nodes or any of the nodes is null.
NodeMismatchException	Thrown if the number of nodes does not match the pin count of the component.

Extension Methods

Documentation.Pins(IComponent)

Utility.ThrowIfNull<T>(T, string)

Documentation.ParameterValues<T>(IParameterSet, bool)

Documentation.Parameters(IParameterSet)

Documentation.ParameterValues<T>(IParameterSetCollection, bool)

Documentation.Parameters(IParameterSetCollection)

See Also

IEntity