Show / Hide Table of Contents

Class VoltageSource

An independent voltage source.

Inheritance
object
ParameterSet
ParameterSetCollection
Entity
Component
Component<IndependentSourceParameters>
VoltageSource
Implements
IComponent
IEntity
IParameterSetCollection
IParameterSet
ICloneable<IEntity>
IParameterized<IndependentSourceParameters>
IRuleSubject
Inherited Members
Component<IndependentSourceParameters>.Parameters
Component<IndependentSourceParameters>.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, "V+")]
[Pin(1, "V-")]
[VoltageDriver(0, 1)]
public class VoltageSource : Component<IndependentSourceParameters>, IComponent, IEntity, IParameterSetCollection, IParameterSet, ICloneable<IEntity>, IParameterized<IndependentSourceParameters>, IRuleSubject

Constructors

VoltageSource(string)

Initializes a new instance of the VoltageSource class.

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

The name

Exceptions
Type Condition
ArgumentNullException

Thrown if name is null.

VoltageSource(string, string, string, IWaveformDescription)

Initializes a new instance of the VoltageSource class.

Declaration
public VoltageSource(string name, string pos, string neg, IWaveformDescription waveform)
Parameters
Type Name Description
string name

The name of the voltage source

string pos

The positive node

string neg

The negative node

IWaveformDescription waveform

The waveform

Exceptions
Type Condition
ArgumentNullException

Thrown if name is null.

VoltageSource(string, string, string, double)

Initializes a new instance of the VoltageSource class.

Declaration
public VoltageSource(string name, string pos, string neg, double dc)
Parameters
Type Name Description
string name

The name of the voltage source

string pos

The positive node

string neg

The negative node

double dc

The DC value

Exceptions
Type Condition
ArgumentNullException

Thrown if name is null.

Fields

PinCount

The pin count for a voltage source.

Declaration
[ParameterName("pincount")]
[ParameterInfo("Number of pins")]
public const int PinCount = 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>
IRuleSubject
IndependentSourceParameters
In this article
Back to top Generated by DocFX