generated from gemstone/gemtem
-
Notifications
You must be signed in to change notification settings - Fork 0
/
FrequencyDefinition.cs
211 lines (176 loc) · 8.47 KB
/
FrequencyDefinition.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
//******************************************************************************************************
// FrequencyDefinition.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/20/2011 - Ritchie
// Added DST file support.
// 12/17/2012 - Starlynn Danyelle Gilliam
// Modified Header.
//
//******************************************************************************************************
using System;
using System.Runtime.Serialization;
using Gemstone.Numeric.EE;
// ReSharper disable VirtualMemberCallInConstructor
// ReSharper disable RedundantOverriddenMember
namespace Gemstone.PhasorProtocols.BPAPDCstream
{
/// <summary>
/// Represents the BPA PDCstream implementation of a <see cref="IFrequencyDefinition"/>.
/// </summary>
[Serializable]
public class FrequencyDefinition : FrequencyDefinitionBase
{
#region [ Members ]
// Fields
private readonly uint m_dummy;
private double m_frequencyOffset;
#endregion
#region [ Constructors ]
/// <summary>
/// Creates a new <see cref="FrequencyDefinition"/>.
/// </summary>
/// <param name="parent">The <see cref="IConfigurationCell"/> parent of this <see cref="FrequencyDefinition"/>.</param>
public FrequencyDefinition(IConfigurationCell parent)
: base(parent)
{
ScalingValue = 1000;
DfDtScalingValue = 100;
}
/// <summary>
/// Creates a new <see cref="FrequencyDefinition"/> from the specified parameters.
/// </summary>
/// <param name="parent">The <see cref="ConfigurationCell"/> parent of this <see cref="FrequencyDefinition"/>.</param>
/// <param name="entryValue">The entry value from the INI based configuration file.</param>
public FrequencyDefinition(ConfigurationCell parent, string entryValue)
: base(parent)
{
string[] entry = entryValue.Split(',');
int index = 0;
FrequencyDefinition defaultFrequency = parent is null ? new FrequencyDefinition(null) : parent.Parent.DefaultFrequency;
// If initial entry is an F - we just ignore this
if (string.Equals(entry[index].Trim(), "F", StringComparison.OrdinalIgnoreCase))
index++;
if (entry.Length > index && uint.TryParse(entry[index++].Trim(), out uint iValue))
ScalingValue = iValue;
else
ScalingValue = defaultFrequency.ScalingValue;
if (entry.Length > index && double.TryParse(entry[index++].Trim(), out double dValue))
Offset = dValue;
else
Offset = defaultFrequency.Offset;
if (entry.Length > index && uint.TryParse(entry[index++].Trim(), out iValue))
DfDtScalingValue = iValue;
else
DfDtScalingValue = defaultFrequency.DfDtScalingValue;
if (entry.Length > index && double.TryParse(entry[index++].Trim(), out dValue))
DfDtOffset = dValue;
else
DfDtOffset = defaultFrequency.DfDtOffset;
if (entry.Length > index && uint.TryParse(entry[index++].Trim(), out iValue))
m_dummy = iValue;
else
m_dummy = defaultFrequency.m_dummy;
Label = entry.Length > index ? entry[index].Trim() : defaultFrequency.Label;
}
/// <summary>
/// Creates a new <see cref="FrequencyDefinition"/> 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 FrequencyDefinition(SerializationInfo info, StreamingContext context)
: base(info, context)
{
}
#endregion
#region [ Properties ]
/// <summary>
/// Gets or sets the <see cref="ConfigurationCell"/> parent of this <see cref="FrequencyDefinition"/>.
/// </summary>
public new virtual ConfigurationCell Parent
{
get => base.Parent as ConfigurationCell;
set => base.Parent = value;
}
/// <summary>
/// Gets or sets the offset of this <see cref="FrequencyDefinition"/>.
/// </summary>
public override double Offset
{
get => Parent is null ? m_frequencyOffset : base.Offset;
set
{
if (Parent is null)
// Store local value for default frequency definition
m_frequencyOffset = value;
else
// Frequency offset is stored as nominal frequency of parent cell
Parent.NominalFrequency = value >= 60.0F ? LineFrequency.Hz60 : LineFrequency.Hz50;
}
}
/// <summary>
/// Gets the maximum length of the <see cref="ChannelDefinitionBase.Label"/> of this <see cref="FrequencyDefinition"/>.
/// </summary>
public override int MaximumLabelLength => 256;
/// <summary>
/// Gets the length of the <see cref="BodyImage"/>.
/// </summary>
protected override int BodyLength => 0;
/// <summary>
/// Gets the binary body image of the <see cref="FrequencyDefinition"/> object.
/// </summary>
/// <remarks>
/// BPA PDCstream does not include frequency definition in descriptor packet.
/// </remarks>
protected override byte[] BodyImage => null;
#endregion
#region [ Methods ]
/// <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
// Creates frequency information for an INI based BPA PDCstream configuration file
internal static string ConfigFileFormat(IFrequencyDefinition definition)
{
// type, scale, offset, dF/dt scale, dF/dt offset, dummy, label
// F, 1000, 60, 1000, 0, 0, Frequency
if (definition is FrequencyDefinition frequency)
return $"F,{frequency.ScalingValue},{frequency.Offset},{frequency.DfDtScalingValue},{frequency.DfDtOffset},{frequency.m_dummy},{frequency.Label}";
return definition is null ? "" : $"F,{definition.ScalingValue},{definition.Offset},{definition.DfDtScalingValue},{definition.DfDtOffset},0,{definition.Label}";
}
// Delegate handler to create a new BPA PDCstream frequency definition
internal static IFrequencyDefinition CreateNewDefinition(IConfigurationCell parent, byte[] buffer, int startIndex, out int parsedLength)
{
IFrequencyDefinition frequencyDefinition = new FrequencyDefinition(parent);
parsedLength = frequencyDefinition.ParseBinaryImage(buffer, startIndex, 0);
return frequencyDefinition;
}
#endregion
}
}