Class BehavioralComponent
A base implementation for behavioral components.
Implements
SpiceSharp.Components.IComponent
SpiceSharp.Entities.IEntity
SpiceSharp.ICloneable
SpiceSharp.ParameterSets.IParameterSetCollection
SpiceSharp.ParameterSets.IParameterSet
SpiceSharp.ParameterSets.IParameterized<Parameters>
Namespace: SpiceSharp.Components.BehavioralComponents
Assembly: SpiceSharpBehavioral.dll
Syntax
public abstract class BehavioralComponent : Entity<BehavioralBindingContext>, IComponent, IEntity, ICloneable, IParameterSetCollection, IParameterSet, IParameterized<Parameters>Constructors
BehavioralComponent(String, Int32)
Initializes a new instance of the BehavioralComponent class.
Declaration
protected BehavioralComponent(string name, int basePinCount)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The name. |
| System.Int32 | basePinCount | The base pin count. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentNullException | Thrown if |
Properties
Model
Gets or sets the model of the component.
Declaration
public string Model { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The model of the component. |
Nodes
Gets the nodes.
Declaration
public IReadOnlyList<string> Nodes { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IReadOnlyList<System.String> | The nodes. |
Parameters
Gets the parameter set.
Declaration
public Parameters Parameters { get; }Property Value
| Type | Description |
|---|---|
| Parameters | The parameter set. |
Methods
Connect(String[])
Connects the component in the circuit.
Declaration
public IComponent Connect(params string[] nodes)Parameters
| Type | Name | Description |
|---|---|---|
| System.String[] | nodes | The node indices. |
Returns
| Type | Description |
|---|---|
| SpiceSharp.Components.IComponent | The instance calling the method for chaining. |
CreateBehaviors(ISimulation)
Declaration
public override void CreateBehaviors(ISimulation simulation)Parameters
| Type | Name | Description |
|---|---|---|
| SpiceSharp.Simulations.ISimulation | simulation |
Implements
SpiceSharp.Components.IComponent
SpiceSharp.Entities.IEntity
SpiceSharp.ICloneable
SpiceSharp.ParameterSets.IParameterSetCollection
SpiceSharp.ParameterSets.IParameterSet
SpiceSharp.ParameterSets.IParameterized<>
See Also
SpiceSharp.Entities.Entity
SpiceSharp.Components.IComponent