generated from gemstone/gemtem
-
Notifications
You must be signed in to change notification settings - Fork 0
/
DataCell.cs
359 lines (308 loc) · 14.2 KB
/
DataCell.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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
//******************************************************************************************************
// DataCell.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:
// ----------------------------------------------------------------------------------------------------
// 02/08/2007 - J. Ritchie Carroll & Jian Ryan Zuo
// 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.ComponentModel;
using System.Runtime.Serialization;
using System.Text;
using Gemstone.Units;
// ReSharper disable RedundantOverriddenMember
// ReSharper disable VirtualMemberCallInConstructor
namespace Gemstone.PhasorProtocols.FNET
{
/// <summary>
/// Represents the F-NET implementation of a <see cref="IDataCell"/> that can be sent or received.
/// </summary>
[Serializable]
public class DataCell : DataCellBase
{
#region [ Members ]
// Fields
private double m_analogValue;
#endregion
#region [ Constructors ]
/// <summary>
/// Creates a new <see cref="DataCell"/>.
/// </summary>
/// <param name="parent">The reference to parent <see cref="IDataFrame"/> of this <see cref="DataCell"/>.</param>
/// <param name="configurationCell">The <see cref="IConfigurationCell"/> associated with this <see cref="DataCell"/>.</param>
public DataCell(IDataFrame parent, IConfigurationCell configurationCell)
: base(parent, configurationCell, 0x0000, Common.MaximumPhasorValues, Common.MaximumAnalogValues, Common.MaximumDigitalValues)
{
// Initialize single phasor value and frequency value with an empty value
PhasorValues.Add(new PhasorValue(this, configurationCell.PhasorDefinitions[0]));
// Initialize frequency and df/dt
FrequencyValue = new FrequencyValue(this, configurationCell.FrequencyDefinition);
}
/// <summary>
/// Creates a new <see cref="DataCell"/> 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 DataCell(SerializationInfo info, StreamingContext context)
: base(info, context)
{
}
#endregion
#region [ Properties ]
/// <summary>
/// Gets or sets the reference to parent <see cref="DataFrame"/> of this <see cref="DataCell"/>.
/// </summary>
public new DataFrame Parent
{
get => base.Parent as DataFrame;
set => base.Parent = value;
}
/// <summary>
/// Gets or sets the <see cref="ConfigurationCell"/> associated with this <see cref="DataCell"/>.
/// </summary>
public new ConfigurationCell ConfigurationCell
{
get => base.ConfigurationCell as ConfigurationCell;
set => base.ConfigurationCell = value;
}
/// <summary>
/// Gets or sets flag that determines if data of this <see cref="DataCell"/> is valid.
/// </summary>
public override bool DataIsValid
{
get => true;
set
{
// We just ignore updates to this value; F-NET defines no flags to determine if data is valid
}
}
/// <summary>
/// Gets or sets flag that determines if timestamp of this <see cref="DataCell"/> is valid based on GPS lock.
/// </summary>
/// <remarks>
/// F-NET defines synchronization validity as a derived value based on the number of available satellites, i.e.,
/// synchronization is valid if number of visible satellites is greater than zero.
/// </remarks>
public override bool SynchronizationIsValid
{
get => ConfigurationCell.NumberOfSatellites > 0;
set
{
// We just ignore updates to this value; F-NET defines synchronization validity as a derived value based on the number of available satellites
}
}
/// <summary>
/// Gets or sets <see cref="PhasorProtocols.DataSortingType"/> of this <see cref="DataCell"/>.
/// </summary>
public override DataSortingType DataSortingType
{
get => SynchronizationIsValid ? DataSortingType.ByTimestamp : DataSortingType.ByArrival;
set
{
// We just ignore updates to this value; data sorting type has been defined as a derived value based on synchronization validity
}
}
/// <summary>
/// Gets or sets flag that determines if source device of this <see cref="DataCell"/> is reporting an error.
/// </summary>
/// <remarks>F-NET doesn't define any flags for device errors.</remarks>
[EditorBrowsable(EditorBrowsableState.Never)]
public override bool DeviceError
{
get => false;
set
{
// We just ignore updates to this value; F-NET defines no flags for data errors
}
}
/// <summary>
/// Gets date in F-NET format.
/// </summary>
public string FNetDate => ((DateTime)Parent.Timestamp).ToString("MMddyy");
/// <summary>
/// Gets time in F-NET format.
/// </summary>
public string FNetTime => ((DateTime)Parent.Timestamp).ToString("HHmmss");
/// <summary>
/// Gets or sets analog value for F-NET data row.
/// </summary>
public double AnalogValue
{
get => m_analogValue;
set => m_analogValue = value;
}
/// <summary>
/// Gets image of this <see cref="DataCell"/> as a F-NET formatted data row.
/// </summary>
public string FNetDataRow
{
get
{
StringBuilder dataRow = new();
dataRow.Append(Common.StartByte);
dataRow.Append(IDCode);
dataRow.Append(' ');
dataRow.Append(FNetDate);
dataRow.Append(' ');
dataRow.Append(FNetTime);
dataRow.Append(' ');
dataRow.Append(Parent.SampleIndex);
dataRow.Append(' ');
dataRow.Append(m_analogValue);
dataRow.Append(' ');
dataRow.Append(FrequencyValue.Frequency);
dataRow.Append(' ');
dataRow.Append(PhasorValues[0].Magnitude);
dataRow.Append(' ');
dataRow.Append(PhasorValues[0].Angle);
dataRow.Append(Common.EndByte);
return dataRow.ToString();
}
}
/// <summary>
/// Gets the length of the <see cref="BodyImage"/>.
/// </summary>
protected override int BodyLength => FNetDataRow.Length;
/// <summary>
/// Gets the binary body image of the <see cref="DataCell"/> object.
/// </summary>
protected override byte[] BodyImage => Encoding.ASCII.GetBytes(FNetDataRow);
/// <summary>
/// <see cref="Dictionary{TKey,TValue}"/> of string based property names and values for the <see cref="DataCell"/> object.
/// </summary>
public override Dictionary<string, string> Attributes
{
get
{
Dictionary<string, string> baseAttributes = base.Attributes;
baseAttributes.Add("F-NET Date", FNetDate);
baseAttributes.Add("F-NET Time", FNetTime);
baseAttributes.Add("Analog Value", m_analogValue.ToString());
return baseAttributes;
}
}
#endregion
#region [ Methods ]
/// <summary>
/// Parses the binary body 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>
/// <remarks>
/// The longitude, latitude and number of satellites arrive at the top of minute in F-NET data as the analog
/// data in a single row, each on their own row, as sample 1, 2, and 3 respectively.
/// </remarks>
protected override int ParseBodyImage(byte[] buffer, int startIndex, int length)
{
DataFrame parent = Parent;
CommonFrameHeader commonHeader = parent.CommonHeader;
string[] data = commonHeader.DataElements;
ConfigurationCell configurationCell = ConfigurationCell;
// Attempt to parse sample index
if (uint.TryParse(data[Element.SampleIndex], out uint sampleIndex))
{
parent.SampleIndex = sampleIndex;
// Get timestamp of data record
parent.Timestamp = configurationCell.TimeOffset + ParseTimestamp(data[Element.Date], data[Element.Time], parent.SampleIndex, configurationCell.FrameRate);
// Parse out first analog value (can be long/lat at top of minute)
m_analogValue = double.Parse(data[Element.Analog]);
if (data[Element.Time].Length >= 7 && int.Parse(data[Element.Time].Substring(4, 2)) == 0)
{
switch (parent.SampleIndex)
{
case 1:
configurationCell.Latitude = m_analogValue;
break;
case 2:
configurationCell.Longitude = m_analogValue;
break;
case 3:
configurationCell.NumberOfSatellites = (int)m_analogValue;
break;
}
}
// Update (or create) frequency value
double frequency = double.Parse(data[Element.Frequency]);
if (FrequencyValue is null)
FrequencyValue = new FrequencyValue(this, configurationCell.FrequencyDefinition as FrequencyDefinition, frequency, 0.0D);
else
FrequencyValue.Frequency = frequency;
// Update (or create) phasor value
Angle angle = double.Parse(data[Element.Angle]);
double magnitude = double.Parse(data[Element.Voltage]);
PhasorValue phasor = null;
if (PhasorValues.Count > 0)
phasor = PhasorValues[0] as PhasorValue;
if (phasor is null)
{
phasor = new PhasorValue(this, configurationCell.PhasorDefinitions[0] as PhasorDefinition, angle, magnitude);
PhasorValues.Add(phasor);
}
else
{
phasor.Angle = angle;
phasor.Magnitude = magnitude;
}
}
return commonHeader.ParsedLength;
}
/// <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);
}
#endregion
#region [ Static ]
// Static Methods
// Converts F-NET date (mm/dd/yy), time (hh:mm:ss) and subsecond to time in ticks
internal static Ticks ParseTimestamp(string fnetDate, string fnetTime, uint sampleIndex, int frameRate)
{
fnetDate = fnetDate.PadLeft(6, '0');
fnetTime = fnetTime.PadLeft(6, '0');
DateTime timestamp = new(
/* year */ 2000 + int.Parse(fnetDate.Substring(4, 2)),
/* month */ int.Parse(fnetDate.Substring(0, 2).Trim()),
/* day */ int.Parse(fnetDate.Substring(2, 2)),
/* hour */ int.Parse(fnetTime.Substring(0, 2)),
/* min */ int.Parse(fnetTime.Substring(2, 2)),
/* sec */ int.Parse(fnetTime.Substring(4, 2)));
return sampleIndex == 10 ?
timestamp.AddSeconds(1.0D).Ticks :
timestamp.AddMilliseconds((int)(sampleIndex / (double)frameRate * 1000.0D) % 1000).Ticks;
}
// Delegate handler to create a new F-NET data cell
internal static IDataCell CreateNewCell(IChannelFrame parent, IChannelFrameParsingState<IDataCell> state, int index, byte[] buffer, int startIndex, out int parsedLength)
{
DataCell dataCell = new(parent as IDataFrame, (state as IDataFrameParsingState)?.ConfigurationFrame.Cells[index]);
parsedLength = dataCell.ParseBinaryImage(buffer, startIndex, 0);
return dataCell;
}
#endregion
}
}