FrequencyValue Class

Represents the BPA PDCstream implementation of a IFrequencyValue.

Inheritance Hierarchy

SystemObject
  GSF.ParsingBinaryImageBase
    GSF.PhasorProtocolsChannelBase
      GSF.PhasorProtocolsChannelValueBaseIFrequencyDefinition
        GSF.PhasorProtocolsFrequencyValueBase
          GSF.PhasorProtocols.BPAPDCstreamFrequencyValue

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

Syntax

C++

JavaScript

Copy

[SerializableAttribute]
public class FrequencyValue : FrequencyValueBase

<SerializableAttribute>
Public Class FrequencyValue
	Inherits FrequencyValueBase

[SerializableAttribute]
public ref class FrequencyValue : public FrequencyValueBase

[<SerializableAttribute>]
type FrequencyValue = 
    class
        inherit FrequencyValueBase
    end

GSF.PhasorProtocols.BPAPDCstream.FrequencyValue = function();

Type.createClass(
	'GSF.PhasorProtocols.BPAPDCstream.FrequencyValue',
	GSF.PhasorProtocols.FrequencyValueBase);

View Source

The FrequencyValue type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	Attributes	DictionaryTKey, TValue of string based property names and values for the FrequencyValueBase object. (Inherited from FrequencyValueBase)
	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 FrequencyValue object. (Overrides FrequencyValueBaseBodyImage)
	BodyLength	Gets the length of the BodyImage. (Overrides FrequencyValueBaseBodyLength)
	CompositeValueCount	Gets total number of composite values that this FrequencyValueBase provides. (Inherited from FrequencyValueBase)
	DataFormat	Gets the DataFormat of this ChannelValueBaseT. (Inherited from ChannelValueBaseT)
	Definition	Gets or sets the FrequencyDefinition associated with this FrequencyValue.
	DfDt	Gets or sets the floating point value that represents the change in this FrequencyValueBase over time. (Inherited from FrequencyValueBase)
	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. (Inherited from 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. (Inherited from FrequencyValueBase)
	Label	Gets text based label of this ChannelValueBaseT. (Inherited from ChannelValueBaseT)
	Measurements	Gets the composite values of this ChannelValueBaseT as an array of IMeasurement values. (Inherited from ChannelValueBaseT)
	Parent	Gets or sets the DataCell parent of this FrequencyValue.
	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. (Inherited from FrequencyValueBase)
	UnscaledFrequency	Gets or sets the unscaled integer representation of this FrequencyValueBase. (Inherited from FrequencyValueBase)

Top

Methods

	Name	Description
	CreateMeasurement	Creates a new IMeasurement value for specified composite value for this ChannelValueBaseT. (Inherited from ChannelValueBaseT)
	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. (Inherited from FrequencyValueBase)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetObjectData	Populates a SerializationInfo with the data needed to serialize the target object. (Inherited from FrequencyValueBase)
	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 FrequencyValueBaseParseBodyImage(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
	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)

Top

Reference

GSF.PhasorProtocols.BPAPDCstream Namespace