Class Pins

Namespace

Csra

Assembly

Csra.dll

Pins class - a collection of Pin objects.

[Serializable]
public class Pins : IEnumerable<string>, IEnumerable, IEquatable<Pins>

Inheritance

object

Pins

Implements

IEnumerable<string>

IEnumerable

IEquatable<Pins>

Inherited Members

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

object.MemberwiseClone()

Constructors

Pins(string)

Construct a new Pins object. Resolves (nested) pin groups and lists.

public Pins(string pinList)

Parameters

pinList string

The pin list to create the Pins object for.

Properties

Dcvi

public IDcviPins Dcvi { get; }

Property Value

IDcviPins

Dcvs

public IDcvsPins Dcvs { get; }

Property Value

IDcvsPins

Digital

public IDigitalPins Digital { get; }

Property Value

IDigitalPins

Ppmu

public IPpmuPins Ppmu { get; }

Property Value

IPpmuPins

Utility

public IUtilityPins Utility { get; }

Property Value

IUtilityPins

Methods

Add(string)

Add pins to the Pins object. Resolves (nested) pin groups and lists.

public void Add(string pinList)

Parameters

pinList string

The pin list to add to the Pins object.

ArrangePinSite<T>(IEnumerable<PinSite<Samples<T>>>)

Combines multiple Teradyne.Igxl.Interfaces.Public.PinSite<T> objects into a single one maintaining this Pins object's pin sequence. Excessive objects are quietly ignored, a runtime exception is thrown for missing ones.

public PinSite<Samples<T>> ArrangePinSite<T>(IEnumerable<PinSite<Samples<T>>> pinSite)

Parameters

pinSite IEnumerable<PinSite<Samples<T>>>

A collection of Teradyne.Igxl.Interfaces.Public.PinSite<T> instances to be combined and arranged.

Returns

PinSite<Samples<T>>

A new Teradyne.Igxl.Interfaces.Public.PinSite<T> containing elements from all input Teradyne.Igxl.Interfaces.Public.PinSite<T> instances, arranged in the right order.

Type Parameters

T

The type of Teradyne.Igxl.Interfaces.Public.PinSite<T> elements.

ArrangePinSite<T>(IEnumerable<PinSite<T>>)

Combines multiple Teradyne.Igxl.Interfaces.Public.PinSite<T> objects into a single one maintaining this Pins object's pin sequence. Excessive objects are quietly ignored, a runtime exception is thrown for missing ones.

public PinSite<T> ArrangePinSite<T>(IEnumerable<PinSite<T>> pinSite)

Parameters

pinSite IEnumerable<PinSite<T>>

A collection of Teradyne.Igxl.Interfaces.Public.PinSite<T> instances to be combined and arranged.

Returns

PinSite<T>

A new Teradyne.Igxl.Interfaces.Public.PinSite<T> containing elements from all input Teradyne.Igxl.Interfaces.Public.PinSite<T> instances, arranged in the right order.

Type Parameters

T

The type of Teradyne.Igxl.Interfaces.Public.PinSite<T> elements.

ContainsDomain(InstrumentDomain)

Test if at least one pin has the specified domain.

public bool ContainsDomain(InstrumentDomain domain)

Parameters

domain InstrumentDomain

The instrument domain to look for.

Returns

bool

True if one or more pins have the domain.

ContainsFeature(InstrumentFeature)

Test if at least one pin has the specified feature.

public bool ContainsFeature(InstrumentFeature feature)

Parameters

feature InstrumentFeature

The instrument feature to look for.

Returns

bool

True if one or more pins have the feature.

Count()

Return the number of pins in the Pins object.

public int Count()

Returns

int

Equals(Pins)

Determines whether the specified Pins instance is equal to the current instance.

public bool Equals(Pins other)

Parameters

other Pins

The Pins instance to compare with the current instance.

Returns

bool

true if the specified Pins contains the same pins in the same order; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current Pins.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with the current instance.

Returns

bool

true if the specified object is a Pins and contains the same pins in the same order; otherwise, false.

ExtractByDomain(InstrumentDomain)

Extract pins by instrument domain.

public Pins ExtractByDomain(InstrumentDomain domain)

Parameters

domain InstrumentDomain

The instrument domain to look for.

Returns

Pins

A new Pins object only containing pins with the specified domain.

ExtractByFeature(InstrumentFeature)

Extract pins by instrument feature.

public Pins ExtractByFeature(InstrumentFeature feature)

Parameters

feature InstrumentFeature

The instrument feature to look for.

Returns

Pins

A new Pins object only containing pins with the specified feature.

GetEnumerator()

Get an enumerator for the <xref href="Csra.Pins" data-throw-if-not-resolved="false"></xref> object to support 

foreach

.

public IEnumerator<string> GetEnumerator()

Returns

IEnumerator<string>

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current Pins.

Join(Pins[])

Combines a collection of Pins objects into a single Pins object.

public static Pins Join(Pins[] pinGroups)

Parameters

pinGroups Pins[]

An array of Pins objects.

Returns

Pins

A new Pins object with all pins combined.

ToString()

Convert the Pins object to a comma-separated list of all pin names.

public override string ToString()

Returns

string

A comma-separated list of all pin names.

Operators

operator ==(Pins, Pins)

Determines whether two Pins instances are equal.

public static bool operator ==(Pins left, Pins right)

Parameters

left Pins

The first Pins to compare.

right Pins

The second Pins to compare.

Returns

bool

true if both instances are equal or both are null; otherwise, false.

operator !=(Pins, Pins)

Determines whether two Pins instances are not equal.

public static bool operator !=(Pins left, Pins right)

Parameters

left Pins

The first Pins to compare.

right Pins

The second Pins to compare.

Returns

bool

true if the instances are not equal; otherwise, false.