ChannelDefinition Class

Represents a channel definition in a PQDIF file. The channel definition resides within a DataSourceRecord and defines a ChannelInstance.

Inheritance Hierarchy

SystemObject
GSF.PQDIF.LogicalChannelDefinition

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

Syntax

public class ChannelDefinition : IEquatable<ChannelDefinition>

Public Class ChannelDefinition
	Implements IEquatable(Of ChannelDefinition)

public ref class ChannelDefinition : IEquatable<ChannelDefinition^>

type ChannelDefinition = 
    class
        interface IEquatable<ChannelDefinition>
    end

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

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

The ChannelDefinition type exposes the following members.

Constructors

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

Properties

	Name	Description
	ChannelName	Gets a string identifier for the channel definition.
	DataSource	Gets the data source record in which the channel definition resides.
	Phase	Gets the phase measured by the device.
	PhysicalStructure	Gets the physical structure of the channel definition.
	QuantityMeasured	Gets the physical quantity under measurement (Voltage, Current Power, etc).
	QuantityName	Gets the name of the quantity.
	QuantityTypeID	Gets the quantity type ID, which specifies how the data inside instances of this definition should be interpreted.
	SeriesDefinitions	Gets the series definitions defined in this channel definition.

Methods

	Name	Description
	AddNewSeriesDefinition	Adds a new series definition to the collection of series definitions in this channel definition.
	CreateChannelDefinition	Creates a new channel definition belonging to the given data source record.
	Equals(ChannelDefinition)	Indicates whether the current object is equal to another object of the same type.
	Equals(Object)	Determines whether the specified Object is equal to the current ChannelDefinition. (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 definition from the collection of series definitions.
	ToString	Returns a string that represents the current object. (Inherited from Object)

Fields

	Name	Description
	ChannelDefinitionIndexTag	Tag that identifies the channel definition index.
	ChannelNameTag	Tag that identifies the channel name.
	OneSeriesDefinitionTag	Tag that identifies a single series definition within the collection.
	PhaseIDTag	Tag that identifies the phase ID.
	QuantityMeasuredIDTag	Tag that identifies the quantity measured ID.
	QuantityNameTag	Tag that identifies the quantity name.
	QuantityTypeIDTag	Tag that identifies the quantity type.
	SeriesDefinitionsTag	Tag that identifies the series definitions collection.

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)