Show / Hide Table of Contents

Class SubcircuitDefinition

A standard implementation of a ISubcircuitDefinition.

Inheritance
object
SubcircuitDefinition
Implements
ISubcircuitDefinition
ICloneable<ISubcircuitDefinition>
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: SpiceSharp.Components
Assembly: SpiceSharp.dll
Syntax
public class SubcircuitDefinition : ISubcircuitDefinition, ICloneable<ISubcircuitDefinition>

Constructors

SubcircuitDefinition(IEntityCollection, params string[])

Initializes a new instance of the SubcircuitDefinition class.

Declaration
public SubcircuitDefinition(IEntityCollection entities, params string[] pins)
Parameters
Type Name Description
IEntityCollection entities

The entities.

string[] pins

The pins.

Exceptions
Type Condition
ArgumentNullException

Thrown if entities is null.

Properties

Entities

Gets the entities defined in the subcircuit.

Declaration
[ParameterName("entities")]
[ParameterInfo("The entities in the subcircuit.")]
public IEntityCollection Entities { get; }
Property Value
Type Description
IEntityCollection

The entities inside the subcircuit.

Pins

Gets the pin names. These are the nodes that can be connected to the outside.

Declaration
[ParameterName("pins")]
[ParameterInfo("The pins that connect this subcircuit definition to the outside.")]
public IReadOnlyList<string> Pins { get; }
Property Value
Type Description
IReadOnlyList<string>

The pins.

Methods

Clone()

Clones the instance.

Declaration
public ISubcircuitDefinition Clone()
Returns
Type Description
ISubcircuitDefinition

The cloned instance.

Implements

ISubcircuitDefinition
ICloneable<T>

Extension Methods

Utility.ThrowIfNull<T>(T, string)

See Also

ParameterSet
ISubcircuitDefinition
IParameterized<P>
In this article
Back to top Generated by DocFX