Show / Hide Table of Contents

Class Inductor

An inductor.

Inheritance
object
ParameterSet
ParameterSetCollection
Entity
Component
Component<Parameters>
Inductor
Implements
IComponent
IEntity
IParameterSetCollection
IParameterSet
ICloneable<IEntity>
IParameterized<Parameters>
IRuleSubject
Inherited Members
Component<Parameters>.Parameters
Component<Parameters>.Clone()
Component.Nodes
Component.Model
Component.Connect(params string[])
Component.ToString()
Entity.LinkParameters
Entity.Name
Entity.SetParameter<P>(string, P)
ParameterSetCollection.GetParameterSet<P>()
ParameterSetCollection.TryGetParameterSet<P>(out P)
ParameterSetCollection.ParameterSets
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)
Namespace: SpiceSharp.Components
Assembly: SpiceSharp.dll
Syntax
[Pin(0, "L+")]
[Pin(1, "L-")]
[VoltageDriver(0, 1)]
public class Inductor : Component<Parameters>, IComponent, IEntity, IParameterSetCollection, IParameterSet, ICloneable<IEntity>, IParameterized<Parameters>, IRuleSubject

Constructors

Inductor(string)

Initializes a new instance of the Inductor class.

Declaration
public Inductor(string name)
Parameters
Type Name Description
string name

The name of the inductor.

Exceptions
Type Condition
ArgumentNullException

Thrown if name is null.

Inductor(string, string, string, double)

Initializes a new instance of the Inductor class.

Declaration
public Inductor(string name, string pos, string neg, double inductance)
Parameters
Type Name Description
string name

The name of the inductor.

string pos

The positive node.

string neg

The negative node.

double inductance

The inductance.

Exceptions
Type Condition
ArgumentNullException

Thrown if name or any node is null.

Fields

InductorPinCount

Constants

Declaration
[ParameterName("pincount")]
[ParameterInfo("Number of pins")]
public const int InductorPinCount = 2
Field Value
Type Description
int

Methods

CreateBehaviors(ISimulation)

Creates the behaviors and stores them in the specified container.

Declaration
public override void CreateBehaviors(ISimulation simulation)
Parameters
Type Name Description
ISimulation simulation

The simulation.

Overrides
Entity.CreateBehaviors(ISimulation)
Exceptions
Type Condition
ArgumentNullException

Thrown if simulation is null.

ArgumentException

Thrown if the simulation does not use an IComplexSimulationState.

TypeNotFoundException

Thrown if a required behavior or parameter set could not be found.

AmbiguousTypeException

Thrown if a behavior or parameter set could not be resolved unambiguously.

Implements

IComponent
IEntity
IParameterSetCollection
IParameterSet
ICloneable<T>
IParameterized<P>
IRuleSubject

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

Component
IParameterized<P>
Parameters
IRuleSubject
In this article
Back to top Generated by DocFX