generated from gemstone/gemtem
-
Notifications
You must be signed in to change notification settings - Fork 0
/
FrequencyDefinition.cs
135 lines (115 loc) · 5.43 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
//******************************************************************************************************
// 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:
// ----------------------------------------------------------------------------------------------------
// 04/19/2012 - J. Ritchie Carroll
// Generated original version of source code.
// 12/17/2012 - Starlynn Danyelle Gilliam
// Modifeid Header.
//
//******************************************************************************************************
using System;
using System.Runtime.Serialization;
using Gemstone.Numeric.EE;
// ReSharper disable VirtualMemberCallInConstructor
namespace Gemstone.PhasorProtocols.IEC61850_90_5
{
/// <summary>
/// Represents the IEC 61850-90-5 implementation of a <see cref="IFrequencyDefinition"/>.
/// </summary>
[Serializable]
public class FrequencyDefinition : FrequencyDefinitionBase
{
#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 specified parameters.
/// </summary>
/// <param name="parent">The <see cref="ConfigurationCell"/> parent of this <see cref="FrequencyDefinition"/>.</param>
/// <param name="label">The label of this <see cref="FrequencyDefinition"/>.</param>
public FrequencyDefinition(ConfigurationCell parent, string label)
: base(parent, label, 1000, 100, 0.0D)
{
}
/// <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 the length of the <see cref="BodyImage"/>.
/// </summary>
protected override int BodyLength => 2;
/// <summary>
/// Gets the binary body image of the <see cref="FrequencyDefinition"/> object.
/// </summary>
protected override byte[] BodyImage =>
BigEndian.GetBytes((ushort)(Parent.NominalFrequency == LineFrequency.Hz50 ? Bits.Bit00 : Bits.Nil));
#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 base implementation assumes that all channel definitions begin with a label as this is
/// the general case, override functionality if this is not the case.
/// </remarks>
protected override int ParseBodyImage(byte[] buffer, int startIndex, int length)
{
Parent.NominalFrequency = (BigEndian.ToUInt16(buffer, startIndex) & (ushort)Bits.Bit00) > 0 ? LineFrequency.Hz50 : LineFrequency.Hz60;
return 2;
}
#endregion
#region [ Static ]
// Static Methods
// Delegate handler to create a new IEC 61850-90-5 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
}
}