generated from gemstone/gemtem
-
Notifications
You must be signed in to change notification settings - Fork 0
/
CommandFrame.cs
273 lines (237 loc) · 11.5 KB
/
CommandFrame.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
//******************************************************************************************************
// CommandFrame.cs - Gbtc
//
// Copyright © 2012, Grid Protection Alliance. All Rights Reserved.
//
// Licensed to the Grid Protection Alliance (GPA) under one or more contributor license agreements. See
// the NOTICE file distributed with this work for additional information regarding copyright ownership.
// The GPA licenses this file to you under the MIT License (MIT), the "License"; you may
// not use this file except in compliance with the License. You may obtain a copy of the License at:
//
// http://www.opensource.org/licenses/MIT
//
// Unless agreed to in writing, the subject software distributed under the License is distributed on an
// "AS-IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. Refer to the
// License for the specific language governing permissions and limitations.
//
// Code Modification History:
// ----------------------------------------------------------------------------------------------------
// 11/12/2004 - J. Ritchie Carroll
// Generated original version of source code.
// 09/15/2009 - Stephen C. Wills
// Added new header and license agreement.
// 12/17/2012 - Starlynn Danyelle Gilliam
// Modified Header.
//
//******************************************************************************************************
using System;
using System.Collections.Generic;
using System.Runtime.Serialization;
using Gemstone.IO.Checksums.ChecksumExtensions;
using Gemstone.IO.Parsing;
// ReSharper disable VirtualMemberCallInConstructor
namespace Gemstone.PhasorProtocols.IEEEC37_118
{
/// <summary>
/// Represents the IEEE C37.118 implementation of a <see cref="ICommandFrame"/> that can be sent or received.
/// </summary>
/// <remarks>
/// IEEE C37.118 command frames are designed only to be sent to a device, not received from a device. As a result
/// this frame does not implement <see cref="ISupportFrameImage{TTypeIdentifier}"/> for automated frame parsing. This class
/// exposes a constructor that accepts a binary image in order to manually parse a command frame.
/// </remarks>
[Serializable]
public class CommandFrame : CommandFrameBase
{
#region [ Members ]
// Fields
private CommonFrameHeader m_frameHeader;
#endregion
#region [ Constructors ]
/// <summary>
/// Creates a new <see cref="CommandFrame"/> from the given <paramref name="buffer"/>.
/// </summary>
/// <param name="buffer">Binary image to parse.</param>
/// <param name="startIndex">Start index into <paramref name="buffer"/> to begin parsing.</param>
/// <param name="length">Length of valid data within <paramref name="buffer"/>.</param>
/// <remarks>
/// This constructor is used by a consumer to parse a received IEEE C37.118 command frame. Typically
/// command frames are sent to a device. This constructor would used if this code was being used
/// inside of a phasor measurement device.
/// </remarks>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="length"/> is not large enough to parse frame.</exception>
public CommandFrame(byte[] buffer, int startIndex, int length)
: base(new CommandCellCollection(Common.MaximumExtendedDataLength), DeviceCommand.ReservedBits)
{
if (length < CommonFrameHeader.FixedLength)
throw new ArgumentOutOfRangeException(nameof(length));
m_frameHeader = new CommonFrameHeader(null, buffer, startIndex);
if (m_frameHeader.TypeID != IEEEC37_118.FrameType.CommandFrame)
throw new InvalidOperationException("Binary image does not represent an IEEE C37.118 command frame");
if (length < m_frameHeader.FrameLength)
throw new ArgumentOutOfRangeException(nameof(length), $"Buffer size, {length}, is not large enough to parse IEEE C37.118 command frame with a length of {m_frameHeader.FrameLength}");
// Validate check-sum
int sumLength = m_frameHeader.FrameLength - 2;
if (BigEndian.ToUInt16(buffer, startIndex + sumLength) != CalculateChecksum(buffer, startIndex, sumLength))
throw new InvalidOperationException($"Invalid binary image detected - check sum of {GetType().Name} did not match");
m_frameHeader.State = new CommandFrameParsingState(m_frameHeader.FrameLength, m_frameHeader.DataLength, true, true);
CommonHeader = m_frameHeader;
ParseBinaryImage(buffer, startIndex, length);
}
/// <summary>
/// Creates a new <see cref="CommandFrame"/> from specified parameters.
/// </summary>
/// <param name="idCode">The ID code of this <see cref="CommandFrame"/>.</param>
/// <param name="command">The <see cref="DeviceCommand"/> for this <see cref="CommandFrame"/>.</param>
/// <param name="version">IEEE C37.118 revision number.</param>
/// <remarks>
/// This constructor is used by a consumer to generate an IEEE C37.118 command frame.
/// </remarks>
public CommandFrame(ushort idCode, DeviceCommand command, byte version)
: base(new CommandCellCollection(Common.MaximumExtendedDataLength), command)
{
base.IDCode = idCode;
base.Timestamp = DateTime.UtcNow.Ticks;
Version = version;
}
/// <summary>
/// Creates a new <see cref="CommandFrame"/> from serialization parameters.
/// </summary>
/// <param name="info">The <see cref="SerializationInfo"/> with populated with data.</param>
/// <param name="context">The source <see cref="StreamingContext"/> for this deserialization.</param>
protected CommandFrame(SerializationInfo info, StreamingContext context)
: base(info, context)
{
// Deserialize command frame
m_frameHeader = (CommonFrameHeader)info.GetValue("frameHeader", typeof(CommonFrameHeader));
// Copy in associated properties from base class deserialization that are proxied for use by CommonFrameHeader
m_frameHeader.Timestamp = base.Timestamp;
m_frameHeader.IDCode = base.IDCode;
}
#endregion
#region [ Properties ]
/// <summary>
/// Gets or sets current <see cref="CommonFrameHeader"/>.
/// </summary>
public CommonFrameHeader CommonHeader
{
// Make sure frame header exists
get =>m_frameHeader ??= new CommonFrameHeader(null, IEEEC37_118.FrameType.CommandFrame, base.IDCode, base.Timestamp, DraftRevision.Std2005);
set
{
m_frameHeader = value;
if (m_frameHeader is null)
return;
State = m_frameHeader.State as ICommandFrameParsingState;
base.IDCode = m_frameHeader.IDCode;
base.Timestamp = m_frameHeader.Timestamp;
}
}
/// <summary>
/// Gets or sets exact timestamp, in ticks, of the data represented by this <see cref="DataFrame"/>.
/// </summary>
/// <remarks>
/// The value of this property represents the number of 100-nanosecond intervals that have elapsed since 12:00:00 midnight, January 1, 0001.
/// </remarks>
public override Ticks Timestamp
{
get => CommonHeader.Timestamp;
set
{
// Keep timestamp updates synchronized...
CommonHeader.Timestamp = value;
base.Timestamp = value;
}
}
/// <summary>
/// Gets or sets the ID code.
/// </summary>
public override ushort IDCode
{
get => CommonHeader.IDCode;
set
{
// Keep ID code updates synchronized...
CommonHeader.IDCode = value;
base.IDCode = value;
}
}
/// <summary>
/// Gets the IEEE C37.118 protocol version of this <see cref="CommandFrame"/>.
/// </summary>
public byte Version
{
get => CommonHeader.Version;
set => CommonHeader.Version = value;
}
/// <summary>
/// Gets the length of the <see cref="HeaderImage"/>.
/// </summary>
protected override int HeaderLength => CommonFrameHeader.FixedLength;
/// <summary>
/// Gets the binary header image of the <see cref="DataFrame"/> object.
/// </summary>
protected override byte[] HeaderImage
{
get
{
// Make sure to provide proper frame length for use in the common header image
unchecked
{
CommonHeader.FrameLength = (ushort)BinaryLength;
}
return CommonHeader.BinaryImage;
}
}
/// <summary>
/// <see cref="Dictionary{TKey,TValue}"/> of string based property names and values for the <see cref="DataFrame"/> object.
/// </summary>
public override Dictionary<string, string> Attributes
{
get
{
Dictionary<string, string> baseAttributes = base.Attributes;
CommonHeader.AppendHeaderAttributes(baseAttributes);
return baseAttributes;
}
}
#endregion
#region [ Methods ]
/// <summary>
/// Parses the binary header image.
/// </summary>
/// <param name="buffer">Binary image to parse.</param>
/// <param name="startIndex">Start index into <paramref name="buffer"/> to begin parsing.</param>
/// <param name="length">Length of valid data within <paramref name="buffer"/>.</param>
/// <returns>The length of the data that was parsed.</returns>
protected override int ParseHeaderImage(byte[] buffer, int startIndex, int length)
{
// We already parsed the frame header, so we just skip past it...
return CommonFrameHeader.FixedLength;
}
/// <summary>
/// Calculates checksum of given <paramref name="buffer"/>.
/// </summary>
/// <param name="buffer">Buffer image over which to calculate checksum.</param>
/// <param name="offset">Start index into <paramref name="buffer"/> to calculate checksum.</param>
/// <param name="length">Length of data within <paramref name="buffer"/> to calculate checksum.</param>
/// <returns>Checksum over specified portion of <paramref name="buffer"/>.</returns>
protected override ushort CalculateChecksum(byte[] buffer, int offset, int length)
{
// IEEE C37.118 uses CRC-CCITT to calculate checksum for frames
return buffer.CrcCCITTChecksum(offset, length);
}
/// <summary>
/// Populates a <see cref="SerializationInfo"/> with the data needed to serialize the target object.
/// </summary>
/// <param name="info">The <see cref="SerializationInfo"/> to populate with data.</param>
/// <param name="context">The destination <see cref="StreamingContext"/> for this serialization.</param>
public override void GetObjectData(SerializationInfo info, StreamingContext context)
{
base.GetObjectData(info, context);
// Serialize command frame
info.AddValue("frameHeader", m_frameHeader, typeof(CommonFrameHeader));
}
#endregion
}
}