NI-SCOPE .NET Class Library Help

ScopeChannelCollection Class

  • Updated2023-09-06
  • 3 minute(s) read
ScopeChannelCollection Class

ScopeChannelCollection Class

Represents a strongly-typed collection of ScopeChannelCollection objects.

Inheritance Hierarchy

SystemObject
  NationalInstruments.ModularInstruments.NIScopeScopeSubObject
    NationalInstruments.ModularInstruments.NIScopeScopeChannelCollection

Namespace:  NationalInstruments.ModularInstruments.NIScope
Assembly:  NationalInstruments.ModularInstruments.NIScope.Fx45 (in NationalInstruments.ModularInstruments.NIScope.Fx45.dll) Version: 2023

Syntax

public sealed class ScopeChannelCollection : ScopeSubObject, 
	IIviScopeChannelCollection, IIviRepeatedCapabilityCollection<IIviScopeChannel>, IEnumerable<IIviScopeChannel>, 
	IEnumerable, IIviRepeatedCapabilityCollection<ScopeChannel>, IEnumerable<ScopeChannel>
Public NotInheritable Class ScopeChannelCollection
	Inherits ScopeSubObject
	Implements IIviScopeChannelCollection, IIviRepeatedCapabilityCollection(Of IIviScopeChannel), 
	IEnumerable(Of IIviScopeChannel), IEnumerable, IIviRepeatedCapabilityCollection(Of ScopeChannel), 
	IEnumerable(Of ScopeChannel)

The ScopeChannelCollection type exposes the following members.

Properties

  NameDescription
Public propertyCount
Gets the number of cached ScopeChannel objects in the collection, which is equal to the number of channels configured using a single-channel string (e.g., "0" or "1").
Public propertyItem
Gets a ScopeChannel object from the collection with the specified name. In Visual C#, this property is the indexer.
  • If the channel name is a string specifying a list or range of channels (e.g., "0,1,2" or "0-6"), a new ScopeChannel is created and returned. The ScopeChannel created is not added to the collection.
  • If the channel name corresponds to only one channel (e.g., "0" or "1") and if the channel has previously been accessed and cached in the collection, the corresponding ScopeChannel is returned; otherwise if the specified channel name exists on the instrument, a new ScopeChannel object is created, added to the collection, and returned.
Top

Methods

  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetEnumerator
Returns an enumerator that iterates through the collection of single-channel ScopeChannel instances.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top

Remarks

For more information, refer to the Attributes section in the NI-SCOPE Function Reference Help.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Log in to get a better experience