generated from gemstone/gemtem
-
Notifications
You must be signed in to change notification settings - Fork 0
/
AnalogDefinition3.cs
205 lines (169 loc) · 7.96 KB
/
AnalogDefinition3.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
//******************************************************************************************************
// AnalogDefinition3.cs - Gbtc
//
// Copyright © 2021, 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://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:
// ----------------------------------------------------------------------------------------------------
// 12/27/2020 - J. Ritchie Carroll
// Generated original version of source code.
//
//******************************************************************************************************
using System;
using System.Collections.Generic;
using System.Runtime.Serialization;
// ReSharper disable VirtualMemberCallInConstructor
namespace Gemstone.PhasorProtocols.IEEEC37_118
{
/// <summary>
/// Represents the IEEE C37.118 configuration frame 3 implementation of an <see cref="IAnalogDefinition"/>.
/// </summary>
[Serializable]
public sealed class AnalogDefinition3 : ChannelDefinitionBase3, IAnalogDefinition
{
#region [ Members ]
// Constants
internal const int ConversionFactorLength = 8;
#endregion
#region [ Constructors ]
/// <summary>
/// Creates a new <see cref="AnalogDefinition3"/> from specified parameters.
/// </summary>
/// <param name="parent">The <see cref="IConfigurationCell"/> parent of this <see cref="AnalogDefinition3"/>.</param>
public AnalogDefinition3(IConfigurationCell parent)
: base(parent)
{
}
/// <summary>
/// Creates a new <see cref="AnalogDefinition3"/> from specified parameters.
/// </summary>
/// <param name="parent">The <see cref="ConfigurationCell3"/> parent of this <see cref="AnalogDefinition3"/>.</param>
/// <param name="label">The label of this <see cref="AnalogDefinition3"/>.</param>
/// <param name="scale">The integer scaling value of this <see cref="AnalogDefinition3"/>.</param>
/// <param name="offset">The offset of this <see cref="AnalogDefinition3"/>.</param>
/// <param name="type">The <see cref="AnalogType"/> of this <see cref="AnalogDefinition3"/>.</param>
public AnalogDefinition3(ConfigurationCell3 parent, string label, uint scale, double offset, AnalogType type)
: base(parent, label, scale, offset)
{
AnalogType = type;
}
/// <summary>
/// Creates a new <see cref="AnalogDefinition3"/> 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>
private AnalogDefinition3(SerializationInfo info, StreamingContext context)
: base(info, context)
{
// Deserialize analog definition
AnalogType = (AnalogType)info.GetValue("type", typeof(AnalogType));
Multiplier = info.GetSingle("multiplier");
Adder = info.GetSingle("adder");
}
#endregion
#region [ Properties ]
/// <summary>
/// Gets or sets the <see cref="ConfigurationCell3"/> parent of this <see cref="AnalogDefinition3"/>.
/// </summary>
public new ConfigurationCell3 Parent
{
get => base.Parent as ConfigurationCell3;
set => base.Parent = value;
}
/// <summary>
/// Gets the <see cref="DataFormat"/> for the <see cref="AnalogDefinitionBase"/>.
/// </summary>
public override DataFormat DataFormat => Parent.AnalogDataFormat;
/// <summary>
/// Gets or sets <see cref="AnalogType"/> of this <see cref="AnalogDefinitionBase"/>.
/// </summary>
public AnalogType AnalogType { get; set; } = AnalogType.SinglePointOnWave;
/// <summary>
/// Gets or sets any multiplier, i.e., scale, to be applied to the analog value.
/// </summary>
public float Multiplier { get; set; } = 1.0F;
/// <summary>
/// Gets or sets and adder, i.e., offset, to be applied to the analog value.
/// </summary>
public float Adder { get; set; }
/// <summary>
/// Gets a <see cref="Dictionary{TKey,TValue}"/> of string based property names and values for this <see cref="AnalogDefinitionBase"/> object.
/// </summary>
public override Dictionary<string, string> Attributes
{
get
{
Dictionary<string, string> baseAttributes = base.Attributes;
baseAttributes.Add("Analog Type", $"{(int)AnalogType}: {AnalogType}");
baseAttributes.Add("Multiplier (Scale)", $"{Multiplier}");
baseAttributes.Add("Adder (Offset)", $"{Adder}");
return baseAttributes;
}
}
/// <summary>
/// Gets conversion factor image of this <see cref="AnalogDefinition3"/>.
/// </summary>
internal byte[] ConversionFactorImage
{
get
{
byte[] buffer = new byte[ConversionFactorLength];
// First word
BigEndian.CopyBytes(Multiplier, buffer, 0);
// Second word
BigEndian.CopyBytes(Adder, buffer, 4);
return buffer;
}
}
#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);
// Serialize analog definition
info.AddValue("type", AnalogType, typeof(AnalogType));
info.AddValue("multiplier", Multiplier);
info.AddValue("adder", Adder);
}
/// <summary>
/// Parses conversion factor image from the specified <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>
internal int ParseConversionFactor(byte[] buffer, int startIndex)
{
// First word
Multiplier = BigEndian.ToSingle(buffer, startIndex);
// Second word:
Adder = BigEndian.ToSingle(buffer, startIndex + 4);
return ConversionFactorLength;
}
#endregion
#region [ Static ]
// Static Methods
// Delegate handler to create a new IEEE C37.118 analog definition
internal static IAnalogDefinition CreateNewDefinition(IConfigurationCell parent, byte[] buffer, int startIndex, out int parsedLength)
{
IAnalogDefinition analogDefinition = new AnalogDefinition3(parent);
parsedLength = analogDefinition.ParseBinaryImage(buffer, startIndex, 0);
return analogDefinition;
}
#endregion
}
}