|
Command
|
Represents the Macrodyne implementation of a ICommandFrame that can be sent or received.
Inheritance Hierarchy
System.Object
GSF.Parsing.BinaryImageBase
GSF.PhasorProtocols.ChannelBase
GSF.PhasorProtocols.ChannelFrameBase<ICommandCell>
GSF.PhasorProtocols.CommandFrameBase
GSF.PhasorProtocols.Macrodyne.CommandFrame
GSF.Parsing.BinaryImageBase
GSF.PhasorProtocols.ChannelBase
GSF.PhasorProtocols.ChannelFrameBase<ICommandCell>
GSF.PhasorProtocols.CommandFrameBase
GSF.PhasorProtocols.Macrodyne.CommandFrame
Namespace: GSF.PhasorProtocols.Macrodyne
Assembly: GSF.PhasorProtocols (in GSF.PhasorProtocols.dll) Version: 2.4.239-beta
Syntax[SerializableAttribute] public class CommandFrame : CommandFrameBase
The CommandFrame type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CommandFrame(DeviceCommand) | Creates a new CommandFrame from specified parameters. |
 | CommandFrame(SerializationInfo, StreamingContext) | Creates a new CommandFrame from serialization parameters. |
Properties| Name | Description | |
|---|---|---|
 | AllowQueuedPublication |
Gets flag that determines if frame image can be queued for publication or should be processed immediately.
(Inherited from ChannelFrameBase<T>) |
| Attributes | Dictionary<TKey, TValue> of string based property names and values for the CommandFrameBase object.
(Inherited from CommandFrameBase) |
| BinaryImage |
Gets the binary body image of this CommandFrame.
(Overrides ChannelFrameBase<T>.BinaryImage) |
| BinaryLength |
Gets the length of the BinaryImage.
(Overrides ChannelFrameBase<T>.BinaryLength) |
 | BodyImage |
Gets the binary body image of this CommandFrameBase.
(Inherited from CommandFrameBase) |
| BodyLength |
Gets the length of the BodyImage.
(Inherited from CommandFrameBase) |
| Cells |
Gets reference to the CommandCellCollection for this CommandFrameBase.
(Inherited from CommandFrameBase) |
| Checksum |
Gets calculated checksum for this ChannelFrameBase<T>.
(Inherited from ChannelFrameBase<T>) |
| Command | Gets or sets the DeviceCommand for this CommandFrame. |
| CreatedTimestamp |
Gets timestamp, in ticks, of when this ChannelFrameBase<T> was created.
(Inherited from ChannelFrameBase<T>) |
| ExtendedData |
Gets or sets extended binary image data for this CommandFrameBase.
(Inherited from CommandFrameBase) |
| 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) |
| FrameType |
Gets the FundamentalFrameType for this CommandFrameBase.
(Inherited from CommandFrameBase) |
| 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 ChannelFrameBase<T>.
(Inherited from ChannelFrameBase<T>) |
| 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>) |
| ParsedBinaryLength |
Gets the parsed binary length derived from the parsing state, if any.
(Inherited from ChannelFrameBase<T>) |
| Published |
Gets or sets published state of this ChannelFrameBase<T>.
(Inherited from ChannelFrameBase<T>) |
| 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 CommandFrameBase.
(Inherited from CommandFrameBase) |
| Tag |
Gets or sets a user definable reference to an object associated with this ChannelBase object.
(Inherited from ChannelBase) |
| Timestamp |
Gets or sets exact timestamp, in ticks, of the data represented by this ChannelFrameBase<T>.
(Inherited from ChannelFrameBase<T>) |
| 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>) |
| 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| Name | Description | |
|---|---|---|
| AppendChecksum |
Appends checksum onto buffer starting at startIndex.
(Inherited from ChannelFrameBase<T>) |
| CalculateChecksum |
Calculates checksum of given buffer.
(Overrides ChannelFrameBase<T>.CalculateChecksum(Byte[], Int32, Int32)) |
| ChecksumIsValid |
Determines if checksum in the buffer is valid.
(Inherited from ChannelFrameBase<T>) |
| 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 |
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) |
| GetHashCode |
Returns the hash code for this instance.
(Inherited from ChannelFrameBase<T>) |
| GetObjectData |
Populates a SerializationInfo with the data needed to serialize the target object.
(Inherited from CommandFrameBase) |
| 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 ChannelFrameBase<T>) |
| ParseBodyImage |
Parses the binary body image.
(Inherited from CommandFrameBase) |
| 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) |
Extension Methods| Name | Description | |
|---|---|---|
 | 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) |
Remarks
Macrodyne command frames are designed only to be sent to a device, not received from a device. As a result
this frame does not implement ISupportFrameImage<TTypeIdentifier> for automated frame parsing.
See Also