FrequencyValueBase Class

Represents the common implementation of the protocol independent representation of a frequency and dF/dt value.

Inheritance Hierarchy

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

Syntax

C++

JavaScript

Copy

[SerializableAttribute]
public abstract class FrequencyValueBase : ChannelValueBase<IFrequencyDefinition>, 
	IFrequencyValue, IChannelValue<IFrequencyDefinition>, IChannel, ISupportBinaryImage, 
	ISerializable

<SerializableAttribute>
Public MustInherit Class FrequencyValueBase
	Inherits ChannelValueBase(Of IFrequencyDefinition)
	Implements IFrequencyValue, IChannelValue(Of IFrequencyDefinition), 
	IChannel, ISupportBinaryImage, ISerializable

[SerializableAttribute]
public ref class FrequencyValueBase abstract : public ChannelValueBase<IFrequencyDefinition^>, 
	IFrequencyValue, IChannelValue<IFrequencyDefinition^>, IChannel, ISupportBinaryImage, 
	ISerializable

[<AbstractClassAttribute>]
[<SerializableAttribute>]
type FrequencyValueBase = 
    class
        inherit ChannelValueBase<IFrequencyDefinition>
        interface IFrequencyValue
        interface IChannelValue<IFrequencyDefinition>
        interface IChannel
        interface ISupportBinaryImage
        interface ISerializable
    end

GSF.PhasorProtocols.FrequencyValueBase = function();

Type.createClass(
	'GSF.PhasorProtocols.FrequencyValueBase',
	GSF.PhasorProtocols.ChannelValueBase`1,
	GSF.PhasorProtocols.IFrequencyValue,
	GSF.PhasorProtocols.IChannelValue`1,
	GSF.PhasorProtocols.IChannel,
	GSF.Parsing.ISupportBinaryImage,
	ISerializable);

View Source

The FrequencyValueBase type exposes the following members.

Constructors

	Name	Description
	FrequencyValueBase(IDataCell, IFrequencyDefinition)	Creates a new FrequencyValueBase.
	FrequencyValueBase(SerializationInfo, StreamingContext)	Creates a new FrequencyValueBase from serialization parameters.
	FrequencyValueBase(IDataCell, IFrequencyDefinition, Double, Double)	Creates a new FrequencyValueBase from specified parameters.

Top

Properties

	Name	Description
	Attributes	Dictionary<TKey, TValue> of string based property names and values for the FrequencyValueBase object. (Overrides ChannelValueBase<T>.Attributes)
	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 FrequencyValueBase object. (Overrides ChannelBase.BodyImage)
	BodyLength	Gets the length of the BodyImage. (Overrides BinaryImageBase.BodyLength)
	CompositeValueCount	Gets total number of composite values that this FrequencyValueBase provides. (Overrides ChannelValueBase<T>.CompositeValueCount)
	DataFormat	Gets the DataFormat of this ChannelValueBase<T>. (Inherited from ChannelValueBase<T>)
	Definition	Gets or sets the IChannelDefinition associated with this ChannelValueBase<T>. (Inherited from ChannelValueBase<T>)
	DfDt	Gets or sets the floating point value that represents the change in this FrequencyValueBase over time.
	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)
	Frequency	Gets or sets the floating point value that represents this FrequencyValueBase.
	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)
	IsEmpty	Gets boolean value that determines if none of the composite values of FrequencyValueBase have been assigned a value. (Overrides ChannelValueBase<T>.IsEmpty)
	Label	Gets text based label of this ChannelValueBase<T>. (Inherited from ChannelValueBase<T>)
	Measurements	Gets the composite values of this ChannelValueBase<T> as an array of IMeasurement values. (Inherited from ChannelValueBase<T>)
	Parent	Gets or sets the IDataCell parent of this ChannelValueBase<T>. (Inherited from ChannelValueBase<T>)
	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)
	UnscaledDfDt	Gets or sets the unscaled integer representation of the change in this FrequencyValueBase over time.
	UnscaledFrequency	Gets or sets the unscaled integer representation of this FrequencyValueBase.

Top

Methods

	Name	Description
	CreateMeasurement	Creates a new IMeasurement value for specified composite value for this ChannelValueBase<T>. (Inherited from ChannelValueBase<T>)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from 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)
	GetCompositeValue	Gets the specified composite value of this FrequencyValueBase. (Overrides ChannelValueBase<T>.GetCompositeValue(Int32))
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetObjectData	Populates a SerializationInfo with the data needed to serialize the target object. (Overrides ChannelValueBase<T>.GetObjectData(SerializationInfo, StreamingContext))
	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 BinaryImageBase.ParseBodyImage(Byte[], Int32, Int32))
	ParseFooterImage	Parses the binary footer image. (Inherited from BinaryImageBase)
	ParseHeaderImage	Parses the binary header image. (Inherited from BinaryImageBase)
	ToString	Returns a string that represents the current object. (Inherited from Object)

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)
	GetEnumValueOrDefault<T>	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 Namespace

Inheritance Hierarchy

System.Object
  GSF.Parsing.BinaryImageBase
    GSF.PhasorProtocols.ChannelBase
      GSF.PhasorProtocols.ChannelValueBase<IFrequencyDefinition>
        GSF.PhasorProtocols.FrequencyValueBase
          GSF.PhasorProtocols.BPAPDCstream.FrequencyValue
          GSF.PhasorProtocols.FNET.FrequencyValue
          GSF.PhasorProtocols.IEC61850_90_5.FrequencyValue
          GSF.PhasorProtocols.IEEE1344.FrequencyValue
          GSF.PhasorProtocols.IEEEC37_118.FrequencyValue
          GSF.PhasorProtocols.Macrodyne.FrequencyValue
          GSF.PhasorProtocols.SelFastMessage.FrequencyValue