ChannelDefinitionBase3 Class

Represents a base implementation for the IEEE C37.118 configuration 3 frame channel definition used by PhasorDefinition3, AnalogDefinition3 and DigitalDefinition3 for the purpose of parsing length-prefixed variable length channel names.

Inheritance Hierarchy

SystemObject
  GSF.ParsingBinaryImageBase
    GSF.PhasorProtocolsChannelBase
      GSF.PhasorProtocols.IEEEC37_118ChannelDefinitionBase3
        GSF.PhasorProtocols.IEEEC37_118AnalogDefinition3
        GSF.PhasorProtocols.IEEEC37_118DigitalDefinition3
        GSF.PhasorProtocols.IEEEC37_118PhasorDefinition3

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

Syntax

C++

JavaScript

Copy

[SerializableAttribute]
public abstract class ChannelDefinitionBase3 : ChannelBase, 
	IChannelDefinition, IChannel, ISupportBinaryImage, ISerializable, IEquatable<IChannelDefinition>, 
	IComparable<IChannelDefinition>, IComparable

<SerializableAttribute>
Public MustInherit Class ChannelDefinitionBase3
	Inherits ChannelBase
	Implements IChannelDefinition, IChannel, ISupportBinaryImage, ISerializable, 
	IEquatable(Of IChannelDefinition), IComparable(Of IChannelDefinition), IComparable

[SerializableAttribute]
public ref class ChannelDefinitionBase3 abstract : public ChannelBase, 
	IChannelDefinition, IChannel, ISupportBinaryImage, ISerializable, IEquatable<IChannelDefinition^>, 
	IComparable<IChannelDefinition^>, IComparable

[<AbstractClassAttribute>]
[<SerializableAttribute>]
type ChannelDefinitionBase3 = 
    class
        inherit ChannelBase
        interface IChannelDefinition
        interface IChannel
        interface ISupportBinaryImage
        interface ISerializable
        interface IEquatable<IChannelDefinition>
        interface IComparable<IChannelDefinition>
        interface IComparable
    end

GSF.PhasorProtocols.IEEEC37_118.ChannelDefinitionBase3 = function();

Type.createClass(
	'GSF.PhasorProtocols.IEEEC37_118.ChannelDefinitionBase3',
	GSF.PhasorProtocols.ChannelBase,
	GSF.PhasorProtocols.IChannelDefinition,
	GSF.PhasorProtocols.IChannel,
	GSF.Parsing.ISupportBinaryImage,
	ISerializable,
	IEquatable`1,
	IComparable`1,
	IComparable);

View Source

The ChannelDefinitionBase3 type exposes the following members.

Constructors

	Name	Description
	ChannelDefinitionBase3(IConfigurationCell)	Creates a new ChannelDefinitionBase3.
	ChannelDefinitionBase3(SerializationInfo, StreamingContext)	Creates a new ChannelDefinitionBase3 from serialization parameters.
	ChannelDefinitionBase3(IConfigurationCell, String, UInt32, Double, Int32)	Creates a new ChannelDefinitionBase3 from specified parameters.

Top

Properties

	Name	Description
	Attributes	Gets a DictionaryTKey, TValue of string based property names and values for this ChannelDefinitionBase3 object. (Overrides ChannelBaseAttributes)
	BinaryImage	Gets the binary image of the ChannelBase object. (Inherited from ChannelBase)
	BinaryLength	Gets the length of the BinaryImageBase object. (Inherited from BinaryImageBase)
	BodyImage	Gets the binary body image of the ChannelDefinitionBase3 object. (Overrides ChannelBaseBodyImage)
	BodyLength	Gets the length of the BodyImage. (Overrides BinaryImageBaseBodyLength)
	ConversionFactor	Gets or sets the conversion factor of this ChannelDefinitionBase3.
	DataFormat	Gets the DataFormat of this ChannelDefinitionBase3.
	FooterImage	Gets the binary footer image of the BinaryImageBase object. (Inherited from ChannelBase)
	FooterLength	Gets the length of the footer portion of the BinaryImageBase object. (Inherited from BinaryImageBase)
	HeaderImage	Gets the binary header image of the ChannelBase object. (Inherited from ChannelBase)
	HeaderLength	Gets the length of the header portion of the BinaryImageBase object. (Inherited from BinaryImageBase)
	Index	Gets or sets the index of this ChannelDefinitionBase3.
	Label	Gets or sets the label of this ChannelDefinitionBase3.
	LabelImage	Gets the binary image of the Label of this ChannelDefinitionBase3.
	MaximumLabelLength	Gets the maximum length of the Label of this ChannelDefinitionBase3.
	MaximumScalingValue	Gets the maximum value for the ScalingValue of this ChannelDefinitionBase3.
	Offset	Gets or sets the offset of this ChannelDefinitionBase3.
	Parent	Gets or sets the IConfigurationCell parent of this ChannelDefinitionBase3.
	ScalePerBit	Gets the scale/bit for the ScalingValue of this ChannelDefinitionBase3.
	ScalingValue	Gets or sets the integer scaling value of this ChannelDefinitionBase3.
	State	Gets or sets the parsing state for this ChannelBase object. (Inherited from ChannelBase)
	Tag	Gets or sets a user definable reference to an object associated with this ChannelBase object. (Inherited from ChannelBase)

Top

Methods

	Name	Description
	CompareTo(IChannelDefinition)	Compares this instance to a specified IChannelDefinition object and returns an indication of their relative values.
	CompareTo(Object)	Compares this instance to a specified object and returns an indication of their relative values.
	Equals(IChannelDefinition)	Returns a value indicating whether this instance is equal to specified IChannelDefinition value.
	Equals(Object)	Returns a value indicating whether this instance is equal to a specified object. (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)
	GenerateBinaryImage	Generates binary image of the object and copies it into the given buffer, for BinaryLength bytes. (Inherited from ChannelBase)
	GenerateBodyImage	Generates the binary body image and copies it into the given buffer, for BodyLength bytes. (Inherited from BinaryImageBase)
	GenerateFooterImage	Generates the binary footer image and copies it into the given buffer, for FooterLength bytes. (Inherited from BinaryImageBase)
	GenerateHeaderImage	Generates the binary header image and copies it into the given buffer, for HeaderLength bytes. (Inherited from BinaryImageBase)
	GetHashCode	Returns the hash code for this instance. (Overrides ObjectGetHashCode)
	GetObjectData	Populates a SerializationInfo with the data needed to serialize the target object.
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	ParseBinaryImage	Initializes object by parsing the specified buffer containing a binary image. (Inherited from BinaryImageBase)
	ParseBodyImage	Parses the binary body image. (Overrides BinaryImageBaseParseBodyImage(Byte, Int32, Int32))
	ParseFooterImage	Parses the binary footer image. (Inherited from BinaryImageBase)
	ParseHeaderImage	Parses the binary header image. (Inherited from BinaryImageBase)
	ToString	Gets the string representation of this ChannelDefinitionBase3. (Overrides ObjectToString)

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)
	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)
	ParseBinaryImageFromStream	Parses binary image of object that implements ISupportBinaryImage from a Stream. (Defined by ISupportBinaryImageExtensions)

Top

Reference

GSF.PhasorProtocols.IEEEC37_118 Namespace