Gemstone PhasorProtocols Library
ConfigurationFrame Class
Represents the Macrodyne implementation of a IConfigurationFrame that can be sent or received.
Definition
Namespace: Gemstone.PhasorProtocols.Macrodyne
Assembly: Gemstone.PhasorProtocols (in Gemstone.PhasorProtocols.dll) Version: 1.0.128 -- Release Build+dd7f32701ba80de4d5b0557e84e0ddc18a34573f
Assembly: Gemstone.PhasorProtocols (in Gemstone.PhasorProtocols.dll) Version: 1.0.128 -- Release Build+dd7f32701ba80de4d5b0557e84e0ddc18a34573f
C#
[SerializableAttribute]
public class ConfigurationFrame : ConfigurationFrameBase,
ISupportSourceIdentifiableFrameImage<SourceChannel, FrameType>, ISupportFrameImage<FrameType>,
ISupportBinaryImageVB
<SerializableAttribute>
Public Class ConfigurationFrame
Inherits ConfigurationFrameBase
Implements ISupportSourceIdentifiableFrameImage(Of SourceChannel, FrameType),
ISupportFrameImage(Of FrameType), ISupportBinaryImageC++
[SerializableAttribute]
public ref class ConfigurationFrame : public ConfigurationFrameBase,
ISupportSourceIdentifiableFrameImage<SourceChannel, FrameType>, ISupportFrameImage<FrameType>,
ISupportBinaryImageJavaScript
Gemstone.PhasorProtocols.Macrodyne.ConfigurationFrame = function();
Type.createClass(
'Gemstone.PhasorProtocols.Macrodyne.ConfigurationFrame',
Gemstone.PhasorProtocols.ConfigurationFrameBase,
ISupportSourceIdentifiableFrameImage,
ISupportFrameImage,
ISupportBinaryImage);- Inheritance
- Object BinaryImageBase ChannelBase ChannelFrameBase<IConfigurationCell> ConfigurationFrameBase ConfigurationFrame
Constructors
| ConfigurationFrame() | Creates a new ConfigurationFrame. |
| ConfigurationFrame(SerializationInfo, StreamingContext) | Creates a new ConfigurationFrame from serialization parameters. |
| ConfigurationFrame(OnlineDataFormatFlags, String, String, String) | Creates a new ConfigurationFrame. |
Properties
| AllowQueuedPublication |
Gets flag that determines if frame image can be queued for publication or should be processed immediately.
(Inherited from ConfigurationFrameBase) |
| Attributes | Dictionary<TKey, TValue> of string based property names and values for the ConfigurationFrame object.
(Overrides ConfigurationFrameBase.Attributes) |
| BinaryImage |
Gets the binary image of this ChannelFrameBase<T>.
(Inherited from ChannelFrameBase<T>) |
| BinaryLength |
Gets the length of the ConfigurationFrame.
(Overrides ChannelFrameBase<T>.BinaryLength) |
| BodyImage |
Gets the binary body image of this ChannelFrameBase<T>.
(Inherited from ChannelFrameBase<T>) |
| BodyLength |
Gets the length of the BodyImage.
(Inherited from ChannelFrameBase<T>) |
| Cells | Gets reference to the ConfigurationCellCollection for this ConfigurationFrame. |
| Checksum |
Gets calculated checksum for this ChannelFrameBase<T>.
(Inherited from ChannelFrameBase<T>) |
| CommonHeader | Gets or sets current CommonFrameHeader. |
| ConfigurationFileName | Gets the INI based configuration file name of this ConfigurationFrame. |
| CreatedTimestamp |
Gets timestamp, in ticks, of when this ChannelFrameBase<T> was created.
(Inherited from ChannelFrameBase<T>) |
| DataFrameLength | Gets length of data frame based on enabled streaming data. |
| DefaultFrequency | Gets the default frequency definition. |
| DefaultPhasorI | Gets the default current phasor definition. |
| DefaultPhasorV | Gets the default voltage phasor definition. |
| Digital1Included | Gets flag that determines if Digital 1 is included in ON-LINE data. |
| Digital2Included | Gets flag that determines if Digital 2 is included in ON-LINE data. |
| 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) |
| FrameRate |
Gets or sets defined frame rate of this ConfigurationFrameBase.
(Inherited from ConfigurationFrameBase) |
| FrameType |
Gets the FundamentalFrameType for this ConfigurationFrameBase.
(Inherited from ConfigurationFrameBase) |
| HeaderImage |
Gets the binary header image of the DataFrame object.
(Overrides ChannelBase.HeaderImage) |
| HeaderLength |
Gets the length of the HeaderImage.
(Overrides HeaderLength) |
| IDCode |
Gets or sets the numeric ID code for this ConfigurationCell.
(Overrides ChannelFrameBase<T>.IDCode) |
| LastSortedMeasurement |
Gets or sets reference to last IMeasurement that was sorted into this ChannelFrameBase<T>.
(Inherited from ChannelFrameBase<T>) |
| Lifespan |
Gets the life-span of this ChannelFrameBase<T> since its creation.
(Inherited from ChannelFrameBase<T>) |
| Measurements |
Keyed measurements in this ChannelFrameBase<T>.
(Inherited from ChannelFrameBase<T>) |
| OnlineDataFormatFlags | Gets or sets the Macrodyne OnlineDataFormatFlags of this ConfigurationFrame. |
| ParsedBinaryLength |
Gets the parsed binary length derived from the parsing state, if any.
(Inherited from ChannelFrameBase<T>) |
| PhasorCount | Gets phasor count derived from OnlineDataFormatFlags of this ConfigurationFrame. |
| Published |
Gets or sets published state of this ChannelFrameBase<T>.
(Inherited from ChannelFrameBase<T>) |
| ReferenceIncluded | Gets flag that determines if reference phasor is included in ON-LINE data. |
| SortedMeasurements |
Gets or sets total number of measurements that have been sorted into this ChannelFrameBase<T>.
(Inherited from ChannelFrameBase<T>) |
| Source |
Gets or sets the data source identifier for this ChannelFrameBase<T>.
(Inherited from ChannelFrameBase<T>) |
| State |
Gets or sets the parsing state for the this ConfigurationFrameBase.
(Inherited from ConfigurationFrameBase) |
| StationName | Gets station name retrieved from header frame. |
| Status2Included | Gets flag that determines if status 2 flags are included in ON-LINE data. |
| Tag |
Gets or sets a user definable reference to an object associated with this ChannelBase object.
(Inherited from ChannelBase) |
| TicksPerFrame |
Gets the defined Ticks per frame of this ConfigurationFrameBase.
(Inherited from ConfigurationFrameBase) |
| Timestamp |
Gets or sets exact timestamp, in ticks, of the data represented by this ChannelFrameBase<T>.
(Inherited from ChannelFrameBase<T>) |
| TimestampIncluded | Gets flag that determines if timestamp is included in ON-LINE data. |
| TimeTag |
Gets UNIX based time representation of the ticks of this ChannelFrameBase<T>.
(Inherited from ChannelFrameBase<T>) |
| TrustHeaderLength |
Gets or sets flag that determines if header lengths should be trusted over parsed byte count.
(Inherited from ChannelFrameBase<T>) |
| TypeID | Gets the identifier that is used to identify the Macrodyne frame. |
| ValidateCheckSum |
Gets or sets flag that determines if frame's check-sum should be validated - this should normally be left as true.
(Inherited from ChannelFrameBase<T>) |
Methods
| AppendChecksum |
Appends checksum onto buffer starting at startIndex.
(Overrides ChannelFrameBase<T>.AppendChecksum(Byte[], Int32)) |
| CalculateChecksum |
Calculates checksum of given buffer.
(Overrides ChannelFrameBase<T>.CalculateChecksum(Byte[], Int32, Int32)) |
| ChecksumIsValid |
Determines if checksum in the buffer is valid.
(Overrides ChannelFrameBase<T>.ChecksumIsValid(Byte[], Int32)) |
| CompareTo(IFrame) |
Compares the ChannelFrameBase<T> with an IFrame.
(Inherited from ChannelFrameBase<T>) |
| CompareTo(Object) |
Compares the ChannelFrameBase<T> with the specified Object.
(Inherited from ChannelFrameBase<T>) |
| Equals(IFrame) |
Determines whether the specified IFrame is equal to the current ChannelFrameBase<T>.
(Inherited from ChannelFrameBase<T>) |
| Equals(Object) |
Determines whether the specified Object is equal to the current ChannelFrameBase<T>.
(Inherited from ChannelFrameBase<T>) |
| 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(Byte[], Int32) |
Generates the binary body image and copies it into the given buffer, for BodyLength bytes.
(Inherited from BinaryImageBase) |
| GenerateFooterImage(Byte[], Int32) |
Generates the binary footer image and copies it into the given buffer, for FooterLength bytes.
(Inherited from BinaryImageBase) |
| GenerateHeaderImage(Byte[], Int32) |
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.
(Inherited from ChannelFrameBase<T>) |
| GetIniFileImage | Gets a generated INI configuration file image. |
| GetObjectData |
Populates a SerializationInfo with the data needed to serialize the target object.
(Overrides ConfigurationFrameBase.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 |
Parses the binary image.
(Overrides ChannelFrameBase<T>.ParseBinaryImage(Byte[], Int32, Int32)) |
| ParseBodyImage |
Parses the binary body image.
(Inherited from ChannelFrameBase<T>) |
| ParseFooterImage(Byte[], Int32, Int32) |
Parses the binary footer image.
(Inherited from BinaryImageBase) |
| ParseHeaderImage |
Parses the binary header image.
(Overrides ParseHeaderImage(Byte[], Int32, Int32)) |
| Refresh | Reload Macrodyne INI based configuration file. |
| SetNominalFrequency |
Sets a new nominal LineFrequency for all IFrequencyDefinition elements of each IConfigurationCell in the Cells collection.
(Inherited from ConfigurationFrameBase) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Events
| ConfigurationFileReloaded | Occurs when the Macrodyne INI based configuration file has been reloaded. |
Fields
| DefaultCurrentPhasorEntry | Default current phasor INI based configuration entry. |
| DefaultFrequencyEntry | Default frequency INI based configuration entry. |
| DefaultVoltagePhasorEntry | Default voltage phasor INI based configuration entry. |