Gemstone PhasorProtocols Library
Command
Represents the IEEE 1344 implementation of a ICommandFrame that can be sent or received.
Definition
Namespace: Gemstone.PhasorProtocols.IEEE1344
Assembly: Gemstone.PhasorProtocols (in Gemstone.PhasorProtocols.dll) Version: 1.0.110 -- Release Build+b26f50da8951964ebeac94cceca49a2cc8bc2c4d
Assembly: Gemstone.PhasorProtocols (in Gemstone.PhasorProtocols.dll) Version: 1.0.110 -- Release Build+b26f50da8951964ebeac94cceca49a2cc8bc2c4d
C#
[SerializableAttribute]
public class CommandFrame : CommandFrameBaseVB
<SerializableAttribute>
Public Class CommandFrame
Inherits CommandFrameBaseC++
[SerializableAttribute]
public ref class CommandFrame : public CommandFrameBaseJavaScript
Gemstone.PhasorProtocols.IEEE1344.CommandFrame = function();
Type.createClass(
'Gemstone.PhasorProtocols.IEEE1344.CommandFrame',
Gemstone.PhasorProtocols.CommandFrameBase);- Inheritance
- Object BinaryImageBase ChannelBase ChannelFrameBaseICommandCell CommandFrameBase CommandFrame
Remarks
IEEE 1344 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 for automated frame parsing. This class
exposes a constructor that accepts a binary image in order to manually parse a command frame.
Constructors
| CommandFrame(SerializationInfo, StreamingContext) | Creates a new CommandFrame from serialization parameters. |
| CommandFrame(UInt64, DeviceCommand) | Creates a new CommandFrame from specified parameters. |
| CommandFrame(Byte, Int32, Int32) | Creates a new CommandFrame from the given buffer. |
Properties
| AllowQueuedPublication |
Gets flag that determines if frame image can be queued for publication or should be processed immediately.
(Inherited from ChannelFrameBaseT) |
| Attributes | DictionaryTKey, TValue of string based property names and values for the CommandFrame object.
(Overrides CommandFrameBaseAttributes) |
| 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 CommandFrameBase.
(Inherited from CommandFrameBase) |
| BodyLength |
Gets the length of the BodyImage.
(Inherited from CommandFrameBase) |
| Cells |
Gets reference to the CommandCellCollection for this CommandFrame.
(Overrides CommandFrameBaseCells) |
| Checksum |
Gets calculated checksum for this ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT) |
| Command |
Gets or sets the DeviceCommand for this CommandFrameBase.
(Inherited from CommandFrameBase) |
| CreatedTimestamp |
Gets timestamp, in ticks, of when this ChannelFrameBaseT was created.
(Inherited from ChannelFrameBaseT) |
| ExtendedData |
Gets or sets extended binary image data for this CommandFrame.
(Overrides CommandFrameBaseExtendedData) |
| 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 CommandFrame object.
(Overrides ChannelBaseHeaderImage) |
| HeaderLength |
Gets the length of the HeaderImage.
(Overrides HeaderLength) |
| IDCode | Gets or sets the ID code of this CommandFrame. |
| 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) |
| 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 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 ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT) |
| TimeTag | Gets NTP based time representation of the ticks of this CommandFrame. |
| 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
| AppendChecksum |
Appends checksum onto buffer starting at startIndex.
(Inherited from ChannelFrameBaseT) |
| 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) |
| 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(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 ChannelFrameBaseT) |
| GetObjectData |
Populates a SerializationInfo with the data needed to serialize the target object.
(Overrides CommandFrameBaseGetObjectData(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.
(Inherited from ChannelFrameBaseT) |
| ParseBodyImage |
Parses the binary body image.
(Inherited from CommandFrameBase) |
| ParseFooterImage(Byte[], Int32, Int32) |
Parses the binary footer image.
(Inherited from BinaryImageBase) |
| ParseHeaderImage |
Parses the binary header image.
(Overrides ParseHeaderImage(Byte[], Int32, Int32)) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Fields
| FrameLength | Total frame length of a IEEE 1344 CommandFrame. |