PhasorValueBase Class

Represents the common implementation of the protocol independent representation of a phasor value.

Inheritance Hierarchy

SystemObject
  GSF.ParsingBinaryImageBase
    GSF.PhasorProtocolsChannelBase
      GSF.PhasorProtocolsChannelValueBaseIPhasorDefinition
        GSF.PhasorProtocolsPhasorValueBase
          More

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

Syntax

C++

JavaScript

Copy

[SerializableAttribute]
public abstract class PhasorValueBase : ChannelValueBase<IPhasorDefinition>, 
	IPhasorValue, IChannelValue<IPhasorDefinition>, IChannel, ISupportBinaryImage, 
	ISerializable

<SerializableAttribute>
Public MustInherit Class PhasorValueBase
	Inherits ChannelValueBase(Of IPhasorDefinition)
	Implements IPhasorValue, IChannelValue(Of IPhasorDefinition), 
	IChannel, ISupportBinaryImage, ISerializable

[SerializableAttribute]
public ref class PhasorValueBase abstract : public ChannelValueBase<IPhasorDefinition^>, 
	IPhasorValue, IChannelValue<IPhasorDefinition^>, IChannel, ISupportBinaryImage, 
	ISerializable

[<AbstractClassAttribute>]
[<SerializableAttribute>]
type PhasorValueBase = 
    class
        inherit ChannelValueBase<IPhasorDefinition>
        interface IPhasorValue
        interface IChannelValue<IPhasorDefinition>
        interface IChannel
        interface ISupportBinaryImage
        interface ISerializable
    end

GSF.PhasorProtocols.PhasorValueBase = function();

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

View Source

The PhasorValueBase type exposes the following members.

Constructors

	Name	Description
	PhasorValueBase(IDataCell, IPhasorDefinition)	Creates a new PhasorValueBase.
	PhasorValueBase(SerializationInfo, StreamingContext)	Creates a new PhasorValueBase from serialization parameters.
	PhasorValueBase(IDataCell, IPhasorDefinition, Angle, Double)	Creates a new PhasorValueBase from specified parameters.
	PhasorValueBase(IDataCell, IPhasorDefinition, Double, Double)	Creates a new PhasorValueBase from specified parameters.

Top

Properties

	Name	Description
	Angle	Gets or sets the Angle value (a.k.a., the argument) of this PhasorValueBase, in radians.
	AngleFormat	Gets the AngleFormat of this PhasorValueBase.
	Attributes	Gets a DictionaryTKey, TValue of string based property names and values for this PhasorValueBase object. (Overrides ChannelValueBaseTAttributes)
	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 PhasorValueBase object. (Overrides ChannelBaseBodyImage)
	BodyLength	Gets the length of the BodyImage. (Overrides BinaryImageBaseBodyLength)
	CompositeValueCount	Gets total number of composite values that this PhasorValueBase provides. (Overrides ChannelValueBaseTCompositeValueCount)
	CoordinateFormat	Gets the CoordinateFormat of this PhasorValueBase.
	DataFormat	Gets the DataFormat of this ChannelValueBaseT. (Inherited from ChannelValueBaseT)
	Definition	Gets or sets the IChannelDefinition associated with this ChannelValueBaseT. (Inherited from ChannelValueBaseT)
	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)
	Imaginary	Gets or sets the imaginary value of this PhasorValueBase.
	IsEmpty	Gets boolean value that determines if none of the composite values of PhasorValueBase have been assigned a value. (Overrides ChannelValueBaseTIsEmpty)
	Label	Gets text based label of this ChannelValueBaseT. (Inherited from ChannelValueBaseT)
	Magnitude	Gets or sets the magnitude value (a.k.a., the absolute value or modulus) of this PhasorValueBase.
	Measurements	Gets the composite values of this ChannelValueBaseT as an array of IMeasurement values. (Inherited from ChannelValueBaseT)
	Parent	Gets or sets the IDataCell parent of this ChannelValueBaseT. (Inherited from ChannelValueBaseT)
	Phasor	Gets Phasor value from this IPhasorValue.
	Real	Gets or sets the real value of this PhasorValueBase.
	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)
	Type	Gets the PhasorType of this PhasorValueBase.
	UnscaledImaginary	Gets or sets the unscaled integer representation of the imaginary value of this PhasorValueBase.
	UnscaledReal	Gets or sets the unscaled integer representation of the real value of this PhasorValueBase.

Top

Methods

	Name	Description
	CalculatePower	Calculates watts from imaginary and real components of a voltage and current phasor.
	CalculateVars	Calculates vars (total volt-amperes of reactive power) from imaginary and real components of a voltage and current phasor.
	CreateMeasurement	Creates a new IMeasurement value for specified composite value for this PhasorValueBase. (Overrides ChannelValueBaseTCreateMeasurement(Int32))
	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 PhasorValueBase. (Overrides ChannelValueBaseTGetCompositeValue(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 ChannelValueBaseTGetObjectData(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 BinaryImageBaseParseBodyImage(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)
	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 Namespace

Inheritance Hierarchy