generated from gemstone/gemtem
-
Notifications
You must be signed in to change notification settings - Fork 0
/
FrequencyValue.cs
214 lines (178 loc) · 8.03 KB
/
FrequencyValue.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
//******************************************************************************************************
// FrequencyValue.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.Runtime.Serialization;
namespace Gemstone.PhasorProtocols.IEEE1344
{
/// <summary>
/// Represents the IEEE 1344 implementation of a <see cref="IFrequencyValue"/>.
/// </summary>
[Serializable]
public class FrequencyValue : FrequencyValueBase
{
#region [ Constructors ]
/// <summary>
/// Creates a new <see cref="FrequencyValue"/>.
/// </summary>
/// <param name="parent">The <see cref="IDataCell"/> parent of this <see cref="FrequencyValue"/>.</param>
/// <param name="frequencyDefinition">The <see cref="IFrequencyDefinition"/> associated with this <see cref="FrequencyValue"/>.</param>
public FrequencyValue(IDataCell parent, IFrequencyDefinition frequencyDefinition)
: base(parent, frequencyDefinition)
{
}
/// <summary>
/// Creates a new <see cref="FrequencyValue"/> from specified parameters.
/// </summary>
/// <param name="parent">The <see cref="DataCell"/> parent of this <see cref="FrequencyValue"/>.</param>
/// <param name="frequencyDefinition">The <see cref="FrequencyDefinition"/> associated with this <see cref="FrequencyValue"/>.</param>
/// <param name="frequency">The floating point value that represents this <see cref="FrequencyValue"/>.</param>
/// <param name="dfdt">The floating point value that represents the change in this <see cref="FrequencyValue"/> over time.</param>
public FrequencyValue(DataCell parent, FrequencyDefinition frequencyDefinition, double frequency, double dfdt)
: base(parent, frequencyDefinition, frequency, dfdt)
{
}
/// <summary>
/// Creates a new <see cref="FrequencyValue"/> 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 FrequencyValue(SerializationInfo info, StreamingContext context)
: base(info, context)
{
}
#endregion
#region [ Properties ]
/// <summary>
/// Gets or sets the <see cref="DataCell"/> parent of this <see cref="FrequencyValue"/>.
/// </summary>
public new virtual DataCell Parent
{
get => base.Parent as DataCell;
set => base.Parent = value;
}
/// <summary>
/// Gets or sets the <see cref="FrequencyDefinition"/> associated with this <see cref="FrequencyValue"/>.
/// </summary>
public new virtual FrequencyDefinition Definition
{
get => base.Definition as FrequencyDefinition;
set => base.Definition = value;
}
/// <summary>
/// Gets the length of the <see cref="BodyImage"/>.
/// </summary>
/// <remarks>
/// The IEEE 1344 protocol provides frequency and df/dt as optional data measurements, so we override
/// the default behavior to account for this change in operation.
/// </remarks>
protected override int BodyLength
{
get
{
FrequencyDefinition definition = Definition;
if (definition is null)
return 0;
int length = 0;
if (definition.FrequencyIsAvailable)
length += 2;
if (definition.DfDtIsAvailable)
length += 2;
return length;
}
}
/// <summary>
/// Gets the binary body image of the <see cref="FrequencyValue"/> object.
/// </summary>
/// <remarks>
/// The IEEE 1344 protocol provides frequency and df/dt as optional data measurements, so we override
/// the default behavior to account for this change in operation.
/// </remarks>
protected override byte[] BodyImage
{
get
{
FrequencyDefinition definition = Definition;
byte[] buffer = new byte[BodyLength];
if (definition is null)
return buffer;
int startIndex = 0;
if (definition.FrequencyIsAvailable)
{
BigEndian.CopyBytes((short)UnscaledFrequency, buffer, startIndex);
startIndex += 2;
}
if (definition.DfDtIsAvailable)
BigEndian.CopyBytes((short)UnscaledDfDt, buffer, startIndex);
return buffer;
}
}
#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 IEEE 1344 protocol provides frequency and df/dt as optional data measurements, so we override
/// the default behavior to account for this change in operation.
/// </remarks>
protected override int ParseBodyImage(byte[] buffer, int startIndex, int length)
{
FrequencyDefinition definition = Definition;
if (definition is null)
return 0;
int parsedLength = 0;
// Note that IEEE 1344 only supports scaled integers (no need to worry about floating points)
if (definition.FrequencyIsAvailable)
{
UnscaledFrequency = BigEndian.ToInt16(buffer, startIndex);
startIndex += 2;
parsedLength += 2;
}
if (definition.DfDtIsAvailable)
{
UnscaledDfDt = BigEndian.ToInt16(buffer, startIndex);
parsedLength += 2;
}
return parsedLength;
}
#endregion
#region [ Static ]
// Static Methods
// Delegate handler to create a new IEEE 1344 frequency value
internal static IFrequencyValue CreateNewValue(IDataCell parent, IFrequencyDefinition definition, byte[] buffer, int startIndex, out int parsedLength)
{
IFrequencyValue frequency = new FrequencyValue(parent, definition);
parsedLength = frequency.ParseBinaryImage(buffer, startIndex, 0);
return frequency;
}
#endregion
}
}