IChannelDefinition Interface

Represents a protocol independent interface representation of a definition of any kind of IChannel data.

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

Syntax

C++

JavaScript

Copy

public interface IChannelDefinition : IChannel, 
	ISupportBinaryImage, ISerializable, IEquatable<IChannelDefinition>, IComparable<IChannelDefinition>, 
	IComparable

Public Interface IChannelDefinition
	Inherits IChannel, ISupportBinaryImage, ISerializable, IEquatable(Of IChannelDefinition), 
	IComparable(Of IChannelDefinition), IComparable

public interface class IChannelDefinition : IChannel, 
	ISupportBinaryImage, ISerializable, IEquatable<IChannelDefinition^>, IComparable<IChannelDefinition^>, 
	IComparable

type IChannelDefinition = 
    interface
        interface IChannel
        interface ISupportBinaryImage
        interface ISerializable
        interface IEquatable<IChannelDefinition>
        interface IComparable<IChannelDefinition>
        interface IComparable
    end

GSF.PhasorProtocols.IChannelDefinition = function();
GSF.PhasorProtocols.IChannelDefinition.createInterface('GSF.PhasorProtocols.IChannelDefinition');

View Source

The IChannelDefinition type exposes the following members.

Properties

	Name	Description
	Attributes	Gets a DictionaryTKey, TValue of string based property names and values for this IChannel object. (Inherited from IChannel)
	BinaryLength	Gets the length of the binary image. (Inherited from ISupportBinaryImage)
	ConversionFactor	Gets or sets the conversion factor of this IChannelDefinition.
	DataFormat	Gets the DataFormat of this IChannelDefinition.
	Index	Gets or sets the index of this IChannelDefinition.
	Label	Gets or sets the label of this IChannelDefinition.
	LabelImage	Gets the binary image of the Label of this IChannelDefinition.
	MaximumLabelLength	Gets the maximum length of the Label of this IChannelDefinition.
	MaximumScalingValue	Gets the maximum value for the ScalingValue of this IChannelDefinition.
	Offset	Gets or sets the offset of this IChannelDefinition.
	Parent	Gets the IConfigurationCell parent of this IChannelDefinition.
	ScalePerBit	Gets the scale/bit value of this IChannelDefinition.
	ScalingValue	Gets or sets the integer scaling value of this IChannelDefinition.
	State	Gets or sets the parsing state for this IChannel object. (Inherited from IChannel)
	Tag	Gets or sets a user definable reference to an object associated with this IChannel object. (Inherited from IChannel)

Top

Methods

	Name	Description
	CompareTo(T)	Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. (Inherited from IComparableIChannelDefinition)
	CompareTo(Object)	Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. (Inherited from IComparable)
	Equals	Indicates whether the current object is equal to another object of the same type. (Inherited from IEquatableIChannelDefinition)
	GenerateBinaryImage	Generates binary image of the object and copies it into the given buffer, for BinaryLength bytes. (Inherited from ISupportBinaryImage)
	GetObjectData	Populates a SerializationInfo with the data needed to serialize the target object. (Inherited from ISerializable)
	ParseBinaryImage	Initializes object by parsing the specified buffer containing a binary image. (Inherited from ISupportBinaryImage)

Top

Extension Methods

	Name	Description
	BinaryImage	Returns a binary image of an object that implements ISupportBinaryImage. (Defined by ISupportBinaryImageExtensions)
	CopyBinaryImageToStream	Copies binary image of object that implements ISupportBinaryImage to a Stream. (Defined by ISupportBinaryImageExtensions)
	CopyImage	This is a common optimized block copy function for any kind of data. (Defined by Common)
	ParseBinaryImageFromStream	Parses binary image of object that implements ISupportBinaryImage from a Stream. (Defined by ISupportBinaryImageExtensions)

Top

Remarks

Each instance of IChannelDefinition will have a more specific derived implementation (e.g., IAnalogDefinition and IFrequencyDefinition), these specific implementations of IChannelDefinition will be referenced children of a IConfigurationCell.
The IChannelDefinition defines the properties of an associated IChannelValueT.

Reference

GSF.PhasorProtocols Namespace