Show / Hide Table of Contents

Class CurrentSwitch

A current-controlled switch

Inheritance
object
ParameterSet
ParameterSetCollection
Entity
Component
Component<Parameters>
CurrentSwitch
Implements
IRuleSubject
IParameterized<Parameters>
ICurrentControllingComponent
IComponent
IEntity
IParameterSetCollection
IParameterSet
ICloneable<IEntity>
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, "W+")]
[Pin(1, "W-")]
[Connected(0, 1)]
public class CurrentSwitch : Component<Parameters>, IRuleSubject, IParameterized<Parameters>, ICurrentControllingComponent, IComponent, IEntity, IParameterSetCollection, IParameterSet, ICloneable<IEntity>

Constructors

CurrentSwitch(string)

Initializes a new instance of the CurrentSwitch class.

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

The name of the current-controlled switch.

Exceptions
Type Condition
ArgumentNullException

Thrown if name is null.

CurrentSwitch(string, string, string, string)

Initializes a new instance of the CurrentSwitch class.

Declaration
public CurrentSwitch(string name, string pos, string neg, string controllingSource)
Parameters
Type Name Description
string name

The name of the current-controlled switch.

string pos

The positive node.

string neg

The negative node.

string controllingSource

The controlling voltage source.

Exceptions
Type Condition
ArgumentNullException

Thrown if name is null.

Fields

CurrentSwitchPinCount

Constants

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

Properties

ControllingSource

Controlling source name

Declaration
[ParameterName("control")]
[ParameterInfo("Name of the controlling source")]
public string ControllingSource { get; set; }
Property Value
Type Description
string

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

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

Extension Methods

Utility.ThrowIfNull<T>(T, string)
Documentation.Pins(IComponent)
Documentation.ParameterValues<T>(IParameterSet, bool)
Documentation.Parameters(IParameterSet)
Documentation.ParameterValues<T>(IParameterSetCollection, bool)
Documentation.Parameters(IParameterSetCollection)

See Also

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