ChannelInstance Class

Represents a channel instance in a PQDIF file. See IEEE 1159.3-2019 section 5.4.3 for details. A channel instance resides in an ObservationRecord, and is defined by a ChannelDefinition inside the observation record's DataSourceRecord.

Inheritance Hierarchy

SystemObject
GSF.PQDIF.LogicalChannelInstance

Namespace: GSF.PQDIF.Logical
Assembly: GSF.PQDIF (in GSF.PQDIF.dll) Version: 2.4.218-beta

Syntax

C++

JavaScript

Copy

public class ChannelInstance : IEquatable<ChannelInstance>

Public Class ChannelInstance
	Implements IEquatable(Of ChannelInstance)

public ref class ChannelInstance : IEquatable<ChannelInstance^>

type ChannelInstance = 
    class
        interface IEquatable<ChannelInstance>
    end

GSF.PQDIF.Logical.ChannelInstance = function();

Type.createClass(
	'GSF.PQDIF.Logical.ChannelInstance',
	null,
	IEquatable`1);

View Source

The ChannelInstance type exposes the following members.

Constructors

	Name	Description
	ChannelInstance	Creates a new instance of the ChannelInstance class.

Top

Properties

	Name	Description
	ChannelDefinitionIndex	Gets the index of the ChannelDefinition which defines the channel instance.
	ChannelGroupID	Gets the identifier for the harmonic or interharmonic group represented by this channel.
	CrossTriggerDeviceName	Gets the name of the device involved in an external cross trigger scenario.
	Definition	Gets the channel definition which defines the channel instance.
	ObservationRecord	Gets the observation record in which the channel instance resides.
	PhysicalStructure	Gets the physical structure of the channel instance.
	SeriesInstances	Gets the series instances contained in this channel.
	Setting	Gets the channel setting which defines the instrument settings for the channel.
	TriggerModuleName	Gets the name of the of a device specific code or hardware module, algorithm, or rule not necessarily channel based that cause this channel to be recorded.

Top

Methods

	Name	Description
	AddNewSeriesInstance	Adds a new series instance to the collection of series instances in this channel instance.
	Equals(ChannelInstance)	Indicates whether the current object is equal to another object of the same type.
	Equals(Object)	Determines whether the specified ChannelInstance is equal to the current ChannelInstance. (Overrides ObjectEquals(Object))
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetHashCode	Serves as a hash function for a particular type. (Overrides ObjectGetHashCode)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	Remove	Removes the given series instance from the collection of series instances.
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Fields

	Name	Description
	ChannelGroupIDTag	Tag that identifies the channel group ID.
	ChannelTriggerModuleNameTag	Tag that identifies the channel trigger module name.
	CrossTriggerDeviceNameTag	Tag that identifies the cross trigger device name.
	OneSeriesInstanceTag	Tag that identifies a single series instance in the collection.
	SeriesInstancesTag	Tag that identifies the series instances collection.

Top

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)

Top

Reference

GSF.PQDIF.Logical Namespace