generated from gemstone/gemtem
-
Notifications
You must be signed in to change notification settings - Fork 0
/
PhasorDefinition.cs
153 lines (126 loc) · 6.04 KB
/
PhasorDefinition.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
//******************************************************************************************************
// PhasorDefinition.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;
using Gemstone.Numeric;
using Gemstone.Numeric.EE;
using BigEndianU24 = Gemstone.Numeric.UInt24Extensions.BigEndian;
namespace Gemstone.PhasorProtocols.IEEE1344
{
/// <summary>
/// Represents the IEEE 1344 implementation of a <see cref="IPhasorDefinition"/>.
/// </summary>
[Serializable]
public class PhasorDefinition : PhasorDefinitionBase
{
#region [ Members ]
// Constants
internal const int ConversionFactorLength = 4;
#endregion
#region [ Constructors ]
/// <summary>
/// Creates a new <see cref="PhasorDefinition"/> from specified parameters.
/// </summary>
/// <param name="parent">The <see cref="IConfigurationCell"/> parent of this <see cref="PhasorDefinition"/>.</param>
public PhasorDefinition(IConfigurationCell parent)
: base(parent)
{
}
/// <summary>
/// Creates a new <see cref="PhasorDefinition"/> from specified parameters.
/// </summary>
/// <param name="parent">The <see cref="ConfigurationCell"/> parent of this <see cref="PhasorDefinition"/>.</param>
/// <param name="label">The label of this <see cref="PhasorDefinition"/>.</param>
/// <param name="scale">The integer scaling value of this <see cref="PhasorDefinition"/>.</param>
/// <param name="offset">The offset of this <see cref="PhasorDefinition"/>.</param>
/// <param name="type">The <see cref="PhasorType"/> of this <see cref="PhasorDefinition"/>.</param>
/// <param name="voltageReference">The associated <see cref="IPhasorDefinition"/> that represents the voltage reference (if any).</param>
public PhasorDefinition(ConfigurationCell parent, string label, uint scale, double offset, PhasorType type, PhasorDefinition voltageReference)
: base(parent, label, scale, offset, type, voltageReference)
{
}
/// <summary>
/// Creates a new <see cref="PhasorDefinition"/> 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 PhasorDefinition(SerializationInfo info, StreamingContext context)
: base(info, context)
{
}
#endregion
#region [ Properties ]
/// <summary>
/// Gets or sets the <see cref="ConfigurationCell"/> parent of this <see cref="PhasorDefinition"/>.
/// </summary>
public new virtual ConfigurationCell Parent
{
get => base.Parent as ConfigurationCell;
set => base.Parent = value;
}
/// <summary>
/// Gets conversion factor image of this <see cref="PhasorDefinition"/>.
/// </summary>
internal byte[] ConversionFactorImage
{
get
{
byte[] buffer = new byte[ConversionFactorLength];
UInt24 scalingFactor = ScalingValue > UInt24.MaxValue ? UInt24.MaxValue : (UInt24)ScalingValue;
buffer[0] = (byte)(PhasorType == PhasorType.Voltage ? 0 : 1);
BigEndian.CopyBytes(scalingFactor, buffer, 1);
return buffer;
}
}
#endregion
#region [ Methods ]
/// <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)
{
// Get phasor type from first byte
PhasorType = buffer[startIndex] == 0 ? PhasorType.Voltage : PhasorType.Current;
// Last three bytes represent scaling factor
ScalingValue = BigEndianU24.ToUInt24(buffer, startIndex + 1);
return ConversionFactorLength;
}
#endregion
#region [ Static ]
// Static Methods
// Delegate handler to create a new IEEE 1344 phasor definition
internal static IPhasorDefinition CreateNewDefinition(IConfigurationCell parent, byte[] buffer, int startIndex, out int parsedLength)
{
IPhasorDefinition phasorDefinition = new PhasorDefinition(parent);
parsedLength = phasorDefinition.ParseBinaryImage(buffer, startIndex, 0);
return phasorDefinition;
}
#endregion
}
}