|
Configuration
|
Represents a protocol independent implementation of a IConfigurationFrame that can be sent or received.
Inheritance Hierarchy
SystemObject
GSF.ParsingBinaryImageBase
GSF.PhasorProtocolsChannelBase
GSF.PhasorProtocolsChannelFrameBaseIConfigurationCell
GSF.PhasorProtocolsConfigurationFrameBase
GSF.PhasorProtocols.AnonymousConfigurationFrame
GSF.ParsingBinaryImageBase
GSF.PhasorProtocolsChannelBase
GSF.PhasorProtocolsChannelFrameBaseIConfigurationCell
GSF.PhasorProtocolsConfigurationFrameBase
GSF.PhasorProtocols.AnonymousConfigurationFrame
Namespace: GSF.PhasorProtocols.Anonymous
Assembly: GSF.PhasorProtocols (in GSF.PhasorProtocols.dll) Version: 2.4.218-beta
Syntax[SerializableAttribute] public class ConfigurationFrame : ConfigurationFrameBase
The ConfigurationFrame type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ConfigurationFrame(SerializationInfo, StreamingContext) | Creates a new ConfigurationFrame from serialization parameters. |
 | ConfigurationFrame(UInt16, Ticks, UInt16) | Creates a new ConfigurationFrame from specified parameters. |
Properties| Name | Description | |
|---|---|---|
 | AllowQueuedPublication |
Gets flag that determines if frame image can be queued for publication or should be processed immediately.
(Inherited from ConfigurationFrameBase) |
| Attributes | DictionaryTKey, TValue of string based property names and values for the ConfigurationFrameBase object.
(Inherited from ConfigurationFrameBase) |
| BinaryImage |
Gets the binary image of this ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT) |
| BinaryLength |
Gets the length of the BinaryImage.
(Inherited from ChannelFrameBaseT) |
 | BodyImage |
Gets the binary body image of this ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT) |
| BodyLength |
Gets the length of the BodyImage.
(Inherited from ChannelFrameBaseT) |
| Cells | Gets reference to the ConfigurationCellCollection for this ConfigurationFrame. |
| Checksum |
Gets calculated checksum for this ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT) |
 | ConfigurationBackups | Gets total number of configuration backups to keep when storing serialized phasor protocol configurations. |
| ConfigurationCachePath | Gets the path for storing serialized phasor protocol configurations. |
| CreatedTimestamp |
Gets timestamp, in ticks, of when this ChannelFrameBaseT was created.
(Inherited from ChannelFrameBaseT) |
| 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 ChannelBase object.
(Inherited from ChannelBase) |
| HeaderLength |
Gets the length of the header portion of the BinaryImageBase object.
(Inherited from BinaryImageBase) |
| IDCode |
Gets or sets the ID code of this ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT) |
| LastSortedMeasurement |
Gets or sets reference to last IMeasurement that was sorted into this ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT) |
| Lifespan |
Gets the life-span of this ChannelFrameBaseT since its creation.
(Inherited from ChannelFrameBaseT) |
| Measurements |
Keyed measurements in this ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT) |
| Name | Gets or sets name of this configuration frame as assigned or useful in an end-use context. |
| ParsedBinaryLength |
Gets the parsed binary length derived from the parsing state, if any.
(Inherited from ChannelFrameBaseT) |
| Published |
Gets or sets published state of this ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT) |
| SortedMeasurements |
Gets or sets total number of measurements that have been sorted into this ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT) |
| Source |
Gets or sets the data source identifier for this ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT) |
| State |
Gets or sets the parsing state for the this ConfigurationFrameBase.
(Inherited from ConfigurationFrameBase) |
| 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 ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT) |
| TimeTag |
Gets UNIX based time representation of the ticks of this ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT) |
| TrustHeaderLength |
Gets or sets flag that determines if header lengths should be trusted over parsed byte count.
(Inherited from ChannelFrameBaseT) |
| ValidateCheckSum |
Gets or sets flag that determines if frame's check-sum should be validated - this should normally be left as true.
(Inherited from ChannelFrameBaseT) |
Methods| Name | Description | |
|---|---|---|
| AppendChecksum |
Appends checksum onto buffer starting at startIndex.
(Inherited from ChannelFrameBaseT) |
| Cache | Serializes configuration frame to cache folder on an independent thread for later use (if needed). |
| CalculateChecksum |
Calculates checksum of given buffer.
(Overrides ChannelFrameBaseTCalculateChecksum(Byte, Int32, Int32)) |
| ChecksumIsValid |
Determines if checksum in the buffer is valid.
(Inherited from ChannelFrameBaseT) |
| CompareTo(IFrame) |
Compares the ChannelFrameBaseT with an IFrame.
(Inherited from ChannelFrameBaseT) |
| CompareTo(Object) |
Compares the ChannelFrameBaseT with the specified Object.
(Inherited from ChannelFrameBaseT) |
| DeleteCachedConfiguration | Deletes the cached configuration, if defined. |
| Equals(IFrame) |
Determines whether the specified IFrame is equal to the current ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT) |
| Equals(Object) |
Determines whether the specified Object is equal to the current ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT) |
| 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) |
| GetCachedConfiguration | Deserializes cached configuration, if available. |
| GetConfigurationCacheFileName | Gets the file name with path of the specified configurationName. |
| GetHashCode |
Returns the hash code for this instance.
(Inherited from ChannelFrameBaseT) |
| GetObjectData |
Populates a SerializationInfo with the data needed to serialize the target object.
(Inherited from ConfigurationFrameBase) |
| 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.
(Inherited from ChannelFrameBaseT) |
| ParseBodyImage |
Parses the binary body image.
(Inherited from ChannelFrameBaseT) |
| ParseFooterImage |
Parses the binary footer image.
(Inherited from BinaryImageBase) |
| ParseHeaderImage |
Parses the binary header image.
(Inherited from BinaryImageBase) |
| 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) |
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) |
See Also