Represents the IEEE 1344 implementation of a ICommandFrame that can be sent or received.
Declaration Syntax
C# | Visual Basic | Visual C++ |
[SerializableAttribute] public class CommandFrame : CommandFrameBase
<SerializableAttribute> _ Public Class CommandFrame _ Inherits CommandFrameBase
[SerializableAttribute] public ref class CommandFrame : public CommandFrameBase
Members
All Members | Constructors | Methods | Properties | Fields | |
Icon | Member | Description |
---|---|---|
CommandFrame(array<Byte>[]()[][], Int32, Int32) |
Creates a new CommandFrame from the given binaryImage.
| |
CommandFrame(UInt64, DeviceCommand) |
Creates a new CommandFrame from specified parameters.
| |
CommandFrame(SerializationInfo, StreamingContext) |
Creates a new CommandFrame from serialization parameters.
| |
AppendChecksum(array<Byte>[]()[][], Int32) |
Appends checksum onto buffer starting at startIndex.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) | |
Attributes | Dictionary<(Of <(<'TKey, TValue>)>)> of string based property names and values for the CommandFrame object.
(Overrides CommandFrameBase.Attributes.) | |
BinaryImage |
Gets the binary image of this ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) | |
BinaryLength |
Gets the length of the BinaryImage.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) | |
BodyImage |
Gets the binary body image of this CommandFrameBase.
(Inherited from CommandFrameBase.) | |
BodyLength |
Gets the length of the BodyImage.
(Inherited from CommandFrameBase.) | |
CalculateChecksum(array<Byte>[]()[][], Int32, Int32) |
Calculates checksum of given buffer.
(Overrides ChannelFrameBase<(Of <(<'ICommandCell>)>)>.CalculateChecksum(array<Byte>[]()[][], Int32, Int32).) | |
Cells |
Gets reference to the CommandCellCollection for this CommandFrame.
(Overrides CommandFrameBase.Cells.) | |
ChecksumIsValid(array<Byte>[]()[][], Int32) |
Determines if checksum in the buffer is valid.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) | |
Command |
Gets or sets the DeviceCommand for this CommandFrameBase.
(Inherited from CommandFrameBase.) | |
CompareTo(IFrame) |
Compares the ChannelFrameBase<(Of <(<'T>)>)> with an IFrame.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) | |
CompareTo(Object) |
Compares the ChannelFrameBase<(Of <(<'T>)>)> with the specified Object.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) | |
Equals(IFrame) |
Determines whether the specified IFrame is equal to the current ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) | |
Equals(Object) |
Determines whether the specified Object is equal to the current ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) | |
ExtendedData |
Gets or sets extended binary image data for this CommandFrame.
(Overrides CommandFrameBase.ExtendedData.) | |
Finalize()()()() |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) | |
FooterImage()()()() | (Inherited from BinaryImageBase.) | |
FooterLength()()()() | (Inherited from BinaryImageBase.) | |
FrameLength |
Total frame length of a IEEE 1344 CommandFrame.
| |
FrameType |
Gets the FundamentalFrameType for this CommandFrameBase.
(Inherited from CommandFrameBase.) | |
GetHashCode()()()() |
Returns the hash code for this instance.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) | |
GetObjectData(SerializationInfo, StreamingContext) |
Populates a SerializationInfo with the data needed to serialize the target object.
(Overrides CommandFrameBase.GetObjectData(SerializationInfo, StreamingContext).) | |
GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) | |
HeaderImage |
Gets the binary header image of the CommandFrame object.
(Overrides BinaryImageBase.HeaderImage()()()().) | |
HeaderLength |
Gets the length of the HeaderImage.
(Overrides BinaryImageBase.HeaderLength()()()().) | |
IDCode |
Gets or sets the ID code of this CommandFrame.
| |
Initialize(array<Byte>[]()[][], Int32, Int32) |
Parses the binary image.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) | |
LastSortedMeasurement |
Gets ot sets reference to last IMeasurement that was sorted into this ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) | |
Measurements |
Keyed measurements in this ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) | |
MemberwiseClone()()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
ParseBodyImage(array<Byte>[]()[][], Int32, Int32) |
Parses the binary body image.
(Inherited from CommandFrameBase.) | |
ParsedBinaryLength |
Gets the parsed binary length derived from the parsing state, if any.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) | |
ParseFooterImage(array<Byte>[]()[][], Int32, Int32) | (Inherited from BinaryImageBase.) | |
ParseHeaderImage(array<Byte>[]()[][], Int32, Int32) |
Parses the binary header image.
(Overrides BinaryImageBase.ParseHeaderImage(array<Byte>[]()[][], Int32, Int32).) | |
Published |
Gets or sets published state of this ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) | |
PublishedTimestamp |
Gets or sets exact timestamp, in ticks, of when this ChannelFrameBase<(Of <(<'T>)>)> was published (post-processing).
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) | |
ReceivedTimestamp |
Gets or sets exact timestamp, in ticks, of when this ChannelFrameBase<(Of <(<'T>)>)> was received (i.e., created).
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) | |
SortedMeasurements |
Gets or sets total number of measurements that have been sorted into this ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'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<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) | |
TimeTag |
Gets NTP based time representation of the ticks of this CommandFrame.
| |
ToString()()()() | (Inherited from Object.) |
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.
Inheritance Hierarchy
Object | |||||
BinaryImageBase | |||||
ChannelBase | |||||
ChannelFrameBase<(Of <(<'ICommandCell>)>)> | |||||
CommandFrameBase | |||||
CommandFrame |