AnalogDefinition3 Class

Represents the IEEE C37.118 configuration frame 3 implementation of an IAnalogDefinition.

Inheritance Hierarchy

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

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

Syntax

C++

JavaScript

Copy

[SerializableAttribute]
public sealed class AnalogDefinition3 : ChannelDefinitionBase3, 
	IAnalogDefinition, IChannelDefinition, IChannel, ISupportBinaryImage, ISerializable, 
	IEquatable<IChannelDefinition>, IComparable<IChannelDefinition>, IComparable

<SerializableAttribute>
Public NotInheritable Class AnalogDefinition3
	Inherits ChannelDefinitionBase3
	Implements IAnalogDefinition, IChannelDefinition, IChannel, ISupportBinaryImage, 
	ISerializable, IEquatable(Of IChannelDefinition), IComparable(Of IChannelDefinition), 
	IComparable

[SerializableAttribute]
public ref class AnalogDefinition3 sealed : public ChannelDefinitionBase3, 
	IAnalogDefinition, IChannelDefinition, IChannel, ISupportBinaryImage, ISerializable, 
	IEquatable<IChannelDefinition^>, IComparable<IChannelDefinition^>, IComparable

[<SealedAttribute>]
[<SerializableAttribute>]
type AnalogDefinition3 = 
    class
        inherit ChannelDefinitionBase3
        interface IAnalogDefinition
        interface IChannelDefinition
        interface IChannel
        interface ISupportBinaryImage
        interface ISerializable
        interface IEquatable<IChannelDefinition>
        interface IComparable<IChannelDefinition>
        interface IComparable
    end

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

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

View Source

The AnalogDefinition3 type exposes the following members.

Constructors

	Name	Description
	AnalogDefinition3(IConfigurationCell)	Creates a new AnalogDefinition3 from specified parameters.
	AnalogDefinition3(ConfigurationCell3, String, UInt32, Double, AnalogType)	Creates a new AnalogDefinition3 from specified parameters.

Top

Properties

	Name	Description
	Adder	Gets or sets and adder, i.e., offset, to be applied to the analog value.
	AnalogType	Gets or sets AnalogType of this AnalogDefinitionBase.
	Attributes	Gets a DictionaryTKey, TValue of string based property names and values for this AnalogDefinitionBase object. (Overrides ChannelDefinitionBase3Attributes)
	BinaryImage	Gets the binary image of the ChannelBase object. (Inherited from ChannelBase)
	BinaryLength	Gets the length of the BinaryImageBase object. (Inherited from BinaryImageBase)
	ConversionFactor	Gets or sets the conversion factor of this ChannelDefinitionBase3. (Inherited from ChannelDefinitionBase3)
	DataFormat	Gets the DataFormat for the AnalogDefinitionBase. (Overrides ChannelDefinitionBase3DataFormat)
	Index	Gets or sets the index of this ChannelDefinitionBase3. (Inherited from ChannelDefinitionBase3)
	Label	Gets or sets the label of this ChannelDefinitionBase3. (Inherited from ChannelDefinitionBase3)
	LabelImage	Gets the binary image of the Label of this ChannelDefinitionBase3. (Inherited from ChannelDefinitionBase3)
	MaximumLabelLength	Gets the maximum length of the Label of this ChannelDefinitionBase3. (Inherited from ChannelDefinitionBase3)
	MaximumScalingValue	Gets the maximum value for the ScalingValue of this ChannelDefinitionBase3. (Inherited from ChannelDefinitionBase3)
	Multiplier	Gets or sets any multiplier, i.e., scale, to be applied to the analog value.
	Offset	Gets or sets the offset of this ChannelDefinitionBase3. (Inherited from ChannelDefinitionBase3)
	Parent	Gets or sets the ConfigurationCell3 parent of this AnalogDefinition3.
	ScalePerBit	Gets the scale/bit for the ScalingValue of this ChannelDefinitionBase3. (Inherited from ChannelDefinitionBase3)
	ScalingValue	Gets or sets the integer scaling value of this ChannelDefinitionBase3. (Inherited from 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. (Inherited from ChannelDefinitionBase3)
	CompareTo(Object)	Compares this instance to a specified object and returns an indication of their relative values. (Inherited from ChannelDefinitionBase3)
	Equals(IChannelDefinition)	Returns a value indicating whether this instance is equal to specified IChannelDefinition value. (Inherited from ChannelDefinitionBase3)
	Equals(Object)	Returns a value indicating whether this instance is equal to a specified object. (Inherited from ChannelDefinitionBase3)
	GenerateBinaryImage	Generates binary image of the object and copies it into the given buffer, for BinaryLength bytes. (Inherited from ChannelBase)
	GetHashCode	Returns the hash code for this instance. (Inherited from ChannelDefinitionBase3)
	GetObjectData	Populates a SerializationInfo with the data needed to serialize the target object. (Overrides ChannelDefinitionBase3GetObjectData(SerializationInfo, StreamingContext))
	GetType	Gets the Type of the current instance. (Inherited from Object)
	ParseBinaryImage	Initializes object by parsing the specified buffer containing a binary image. (Inherited from BinaryImageBase)
	ToString	Gets the string representation of this ChannelDefinitionBase3. (Inherited from ChannelDefinitionBase3)

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