generated from gemstone/gemtem
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ConfigurationCell.cs
479 lines (419 loc) · 19.4 KB
/
ConfigurationCell.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
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
//******************************************************************************************************
// ConfigurationCell.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.
// 05/19/2011 - J. Ritchie Carroll
// Added DST file support.
// 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.Numeric.EE;
// ReSharper disable VirtualMemberCallInConstructor
namespace Gemstone.PhasorProtocols.BPAPDCstream
{
/// <summary>
/// Represents the BPA PDCstream implementation of a <see cref="IConfigurationCell"/> that can be sent or received.
/// </summary>
[Serializable]
public class ConfigurationCell : ConfigurationCellBase
{
#region [ Members ]
// Constants
private const int FixedBodyLength = 8;
// Fields
private ConfigurationCell m_configurationFileCell;
private string m_sectionEntry;
private FormatFlags m_formatFlags;
private ushort m_offset;
private ushort m_reserved;
#endregion
#region [ Constructors ]
/// <summary>
/// Creates a new <see cref="ConfigurationCell"/>.
/// </summary>
/// <param name="parent">The reference to parent <see cref="IConfigurationFrame"/> of this <see cref="ConfigurationCell"/>.</param>
public ConfigurationCell(IConfigurationFrame parent)
: base(parent, 0, Common.MaximumPhasorValues, Common.MaximumAnalogValues, Common.MaximumDigitalValues)
{
// Define new parsing state which defines constructors for key configuration values
State = new ConfigurationCellParsingState(
PhasorDefinition.CreateNewDefinition,
BPAPDCstream.FrequencyDefinition.CreateNewDefinition,
AnalogDefinition.CreateNewDefinition,
DigitalDefinition.CreateNewDefinition);
}
/// <summary>
/// Creates a new <see cref="ConfigurationCell"/> from specified parameters.
/// </summary>
/// <param name="parent">The reference to parent <see cref="ConfigurationFrame"/> of this <see cref="ConfigurationCell"/>.</param>
/// <param name="idCode">The numeric ID code for this <see cref="ConfigurationCell"/>.</param>
/// <param name="nominalFrequency">The nominal <see cref="LineFrequency"/> of the <see cref="FrequencyDefinition"/> of this <see cref="ConfigurationCell"/>.</param>
public ConfigurationCell(ConfigurationFrame parent, ushort idCode, LineFrequency nominalFrequency = LineFrequency.Hz60)
: this(parent)
{
IDCode = idCode;
NominalFrequency = nominalFrequency;
}
/// <summary>
/// Creates a new <see cref="ConfigurationCell"/> 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 ConfigurationCell(SerializationInfo info, StreamingContext context)
: base(info, context)
{
// Deserialize configuration cell
m_sectionEntry = info.GetString("sectionEntry");
m_formatFlags = (FormatFlags)info.GetValue("formatFlags", typeof(FormatFlags));
m_offset = info.GetUInt16("offset");
m_reserved = info.GetUInt16("reserved");
}
#endregion
#region [ Properties ]
/// <summary>
/// Gets a reference to the parent <see cref="ConfigurationFrame"/> for this <see cref="ConfigurationCell"/>.
/// </summary>
public new ConfigurationFrame Parent
{
get => base.Parent as ConfigurationFrame;
set => base.Parent = value;
}
/// <summary>
/// Gets or sets reference to the <see cref="ConfigurationCell"/> loaded from the configuration file associated this <see cref="ConfigurationCell"/>.
/// </summary>
public ConfigurationCell ConfigurationFileCell
{
get => m_configurationFileCell;
set => m_configurationFileCell = value;
}
/// <summary>
/// Gets a reference to the <see cref="PhasorDefinitionCollection"/> of this <see cref="ConfigurationCell"/>.
/// </summary>
public override PhasorDefinitionCollection PhasorDefinitions =>
m_configurationFileCell is null ? base.PhasorDefinitions : m_configurationFileCell.PhasorDefinitions;
/// <summary>
/// Gets or sets the station name of this <see cref="ConfigurationCell"/>.
/// </summary>
public override string StationName
{
get => m_configurationFileCell is null ? base.StationName : m_configurationFileCell.StationName;
set
{
if (m_configurationFileCell is null)
base.StationName = value;
else
m_configurationFileCell.StationName = value;
}
}
/// <summary>
/// Gets the length of the <see cref="ConfigurationCellBase.IDLabel"/> of this <see cref="ConfigurationCell"/>.
/// </summary>
public override int IDLabelLength => 4; // BPA PDCstream ID label length is 4 characters - max!
/// <summary>
/// Gets flag that determines if source data is in the Phasor Data File Format (i.e., a DST file).
/// </summary>
public bool UsePhasorDataFileFormat => Parent.UsePhasorDataFileFormat;
/// <summary>
/// Gets or sets section entry in INI based configuration file for this <see cref="ConfigurationCell"/>.
/// </summary>
public string SectionEntry
{
get => m_configurationFileCell is null ? m_sectionEntry : m_configurationFileCell.SectionEntry;
set
{
m_sectionEntry = value.Trim();
// Get ID label as substring of section entry
if (!string.IsNullOrEmpty(m_sectionEntry))
IDLabel = m_sectionEntry.Length > IDLabelLength ? m_sectionEntry.Substring(0, IDLabelLength) : m_sectionEntry;
}
}
/// <summary>
/// Gets flag that determines if current <see cref="SectionEntry"/> defines a PDC block section.
/// </summary>
public bool IsPdcBlockSection
{
get
{
if (m_configurationFileCell is null)
{
if (string.IsNullOrEmpty(m_sectionEntry))
return false;
return m_sectionEntry.Length > IDLabelLength;
}
return m_configurationFileCell.IsPdcBlockSection;
}
}
/// <summary>
/// Gets or sets the numeric ID code for this <see cref="ConfigurationCell"/>.
/// </summary>
public override ushort IDCode
{
get => m_configurationFileCell?.IDCode ?? base.IDCode;
set
{
if (m_configurationFileCell is null)
base.IDCode = value;
else
m_configurationFileCell.IDCode = value;
}
}
/// <summary>
/// Gets or sets the <see cref="IFrequencyDefinition"/> of this <see cref="ConfigurationCell"/>.
/// </summary>
public override IFrequencyDefinition FrequencyDefinition
{
get => m_configurationFileCell is null ? base.FrequencyDefinition : m_configurationFileCell.FrequencyDefinition;
set
{
if (m_configurationFileCell is null)
base.FrequencyDefinition = value;
else
m_configurationFileCell.FrequencyDefinition = value;
}
}
/// <summary>
/// Gets or sets the nominal <see cref="LineFrequency"/> of the <see cref="FrequencyDefinition"/> of this <see cref="ConfigurationCell"/>.
/// </summary>
public override LineFrequency NominalFrequency
{
get => m_configurationFileCell?.NominalFrequency ?? base.NominalFrequency;
set
{
if (m_configurationFileCell is null)
base.NominalFrequency = value;
else
m_configurationFileCell.NominalFrequency = value;
}
}
/// <summary>
/// Gets the maximum length of the <see cref="StationName"/> of this <see cref="ConfigurationCell"/>.
/// </summary>
public override int MaximumStationNameLength => int.MaxValue; // The station name in the PDCstream is read from an INI file, so there is no set limit
/// <summary>
/// Gets or sets BPA PDCstream descriptor offset of this <see cref="ConfigurationCell"/> in its data packet.
/// </summary>
public ushort Offset
{
get => m_offset;
set => m_offset = value;
}
/// <summary>
/// Gets or sets reserved word of this <see cref="ConfigurationCell"/>.
/// </summary>
public ushort Reserved
{
get => m_reserved;
set => m_reserved = value;
}
/// <summary>
/// Gets or sets format flags of this <see cref="ConfigurationCell"/>.
/// </summary>
/// <remarks>
/// These are bit flags, use properties to change basic values.
/// </remarks>
[EditorBrowsable(EditorBrowsableState.Advanced)]
public FormatFlags FormatFlags
{
get => m_formatFlags;
set => m_formatFlags = value;
}
/// <summary>
/// Gets or sets the <see cref="DataFormat"/> for the <see cref="IPhasorDefinition"/> objects in the <see cref="ConfigurationCellBase.PhasorDefinitions"/> of this <see cref="ConfigurationCell"/>.
/// </summary>
public override DataFormat PhasorDataFormat
{
get => (m_formatFlags & FormatFlags.Phasors) > 0 ? DataFormat.FloatingPoint : DataFormat.FixedInteger;
set
{
if (value == DataFormat.FloatingPoint)
m_formatFlags |= FormatFlags.Phasors;
else
m_formatFlags &= ~FormatFlags.Phasors;
}
}
/// <summary>
/// Gets or sets the <see cref="CoordinateFormat"/> for the <see cref="IPhasorDefinition"/> objects in the <see cref="ConfigurationCellBase.PhasorDefinitions"/> of this <see cref="ConfigurationCell"/>.
/// </summary>
public override CoordinateFormat PhasorCoordinateFormat
{
get => (m_formatFlags & FormatFlags.Coordinates) > 0 ? CoordinateFormat.Polar : CoordinateFormat.Rectangular;
set
{
if (value == CoordinateFormat.Polar)
m_formatFlags |= FormatFlags.Coordinates;
else
m_formatFlags &= ~FormatFlags.Coordinates;
}
}
/// <summary>
/// Gets or sets the <see cref="DataFormat"/> of the <see cref="FrequencyDefinition"/> of this <see cref="ConfigurationCell"/>.
/// </summary>
public override DataFormat FrequencyDataFormat
{
get => (m_formatFlags & FormatFlags.Frequency) > 0 ? DataFormat.FloatingPoint : DataFormat.FixedInteger;
set
{
if (value == DataFormat.FloatingPoint)
m_formatFlags |= FormatFlags.Frequency;
else
m_formatFlags &= ~FormatFlags.Frequency;
}
}
/// <summary>
/// Gets or sets the <see cref="DataFormat"/> for the <see cref="IAnalogDefinition"/> objects in the <see cref="ConfigurationCellBase.AnalogDefinitions"/> of this <see cref="ConfigurationCell"/>.
/// </summary>
public override DataFormat AnalogDataFormat
{
get => (m_formatFlags & FormatFlags.Analog) > 0 ? DataFormat.FloatingPoint : DataFormat.FixedInteger;
set
{
if (value == DataFormat.FloatingPoint)
m_formatFlags |= FormatFlags.Analog;
else
m_formatFlags &= ~FormatFlags.Analog;
}
}
// The descriptor cell broadcasted by PDCstream only includes PMUID and offset, all
// other metadata is defined in an external INI based configuration file - so we
// override the base class image implementations which attempt to generate and
// parse data based on a common nature of IEEE configuration frames
/// <summary>
/// Gets the length of the <see cref="HeaderImage"/>.
/// </summary>
protected override int HeaderLength => 0;
/// <summary>
/// Gets the binary header image of the <see cref="ConfigurationCell"/> object.
/// </summary>
protected override byte[] HeaderImage => null;
/// <summary>
/// Gets the length of the <see cref="BodyImage"/>.
/// </summary>
protected override int BodyLength => FixedBodyLength;
/// <summary>
/// Gets the binary body image of the <see cref="ConfigurationCell"/> object.
/// </summary>
protected override byte[] BodyImage
{
get
{
byte[] buffer = new byte[FixedBodyLength];
int index = 0;
IDLabelImage.CopyImage(buffer, ref index, IDLabelLength); // PMUID
BigEndian.CopyBytes(Reserved, buffer, index); // Reserved
BigEndian.CopyBytes(Offset, buffer, index + 2); // Offset
return buffer;
}
}
/// <summary>
/// Gets the length of the <see cref="FooterImage"/>.
/// </summary>
protected override int FooterLength => 0;
/// <summary>
/// Gets the binary footer image of the <see cref="ConfigurationCell"/> object.
/// </summary>
protected override byte[] FooterImage => null;
/// <summary>
/// <see cref="Dictionary{TKey,TValue}"/> of string based property names and values for the <see cref="ConfigurationCell"/> object.
/// </summary>
public override Dictionary<string, string> Attributes
{
get
{
Dictionary<string, string> baseAttributes = base.Attributes;
baseAttributes.Add("INI File Section Entry", SectionEntry);
baseAttributes.Add("Offset", Offset.ToString());
baseAttributes.Add("Reserved", Reserved.ToString());
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)
{
// BPA PDC stream doesn't use standard configuration cell header like IEEE protocols do - so we override this function to do nothing
return 0;
}
/// <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>
protected override int ParseBodyImage(byte[] buffer, int startIndex, int length)
{
IDLabel = Encoding.ASCII.GetString(buffer, startIndex, 4);
Reserved = BigEndian.ToUInt16(buffer, startIndex + 4);
Offset = BigEndian.ToUInt16(buffer, startIndex + 6);
return FixedBodyLength;
}
/// <summary>
/// Parses the binary footer 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 ParseFooterImage(byte[] buffer, int startIndex, int length)
{
// BPA PDC stream doesn't use standard configuration cell footer like IEEE protocols do - so we override this function to do nothing
return 0;
}
/// <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 configuration cell
info.AddValue("sectionEntry", SectionEntry);
info.AddValue("formatFlags", m_formatFlags, typeof(FormatFlags));
info.AddValue("offset", m_offset);
info.AddValue("reserved", m_reserved);
}
#endregion
#region [ Static ]
// Static Methods
// Delegate handler to create a new BPA PDCstream configuration cell
internal static IConfigurationCell CreateNewCell(IChannelFrame parent, IChannelFrameParsingState<IConfigurationCell> state, int index, byte[] buffer, int startIndex, out int parsedLength)
{
ConfigurationCell configCell = new(parent as IConfigurationFrame);
parsedLength = configCell.ParseBinaryImage(buffer, startIndex, 0);
return configCell;
}
#endregion
}
}