generated from gemstone/gemtem
-
Notifications
You must be signed in to change notification settings - Fork 0
/
PhasorValue.cs
151 lines (131 loc) · 6.55 KB
/
PhasorValue.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
//******************************************************************************************************
// PhasorValue.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.Units;
namespace Gemstone.PhasorProtocols.BPAPDCstream
{
/// <summary>
/// Represents the BPA PDCstream implementation of a <see cref="IPhasorValue"/>.
/// </summary>
[Serializable]
public class PhasorValue : PhasorValueBase
{
#region [ Constructors ]
/// <summary>
/// Creates a new <see cref="PhasorValue"/>.
/// </summary>
/// <param name="parent">The <see cref="IDataCell"/> parent of this <see cref="PhasorValue"/>.</param>
/// <param name="phasorDefinition">The <see cref="IPhasorDefinition"/> associated with this <see cref="PhasorValue"/>.</param>
public PhasorValue(IDataCell parent, IPhasorDefinition phasorDefinition)
: base(parent, phasorDefinition)
{
}
/// <summary>
/// Creates a new <see cref="PhasorValue"/> from specified parameters.
/// </summary>
/// <param name="parent">The <see cref="DataCell"/> parent of this <see cref="PhasorValue"/>.</param>
/// <param name="phasorDefinition">The <see cref="PhasorDefinition"/> associated with this <see cref="PhasorValue"/>.</param>
/// <param name="real">The real value of this <see cref="PhasorValue"/>.</param>
/// <param name="imaginary">The imaginary value of this <see cref="PhasorValue"/>.</param>
public PhasorValue(DataCell parent, PhasorDefinition phasorDefinition, double real, double imaginary)
: base(parent, phasorDefinition, real, imaginary)
{
}
/// <summary>
/// Creates a new <see cref="PhasorValue"/> from specified parameters.
/// </summary>
/// <param name="parent">The <see cref="DataCell"/> parent of this <see cref="PhasorValue"/>.</param>
/// <param name="phasorDefinition">The <see cref="PhasorDefinition"/> associated with this <see cref="PhasorValue"/>.</param>
/// <param name="angle">The <see cref="Units.Angle"/> value (a.k.a., the argument) of this <see cref="PhasorValue"/>, in radians.</param>
/// <param name="magnitude">The magnitude value (a.k.a., the absolute value or modulus) of this <see cref="PhasorValue"/>.</param>
public PhasorValue(DataCell parent, PhasorDefinition phasorDefinition, Angle angle, double magnitude)
: base(parent, phasorDefinition, angle, magnitude)
{
}
/// <summary>
/// Creates a new <see cref="PhasorValue"/> 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 PhasorValue(SerializationInfo info, StreamingContext context)
: base(info, context)
{
}
#endregion
#region [ Properties ]
/// <summary>
/// Gets or sets the <see cref="DataCell"/> parent of this <see cref="PhasorValue"/>.
/// </summary>
public new virtual DataCell Parent
{
get => base.Parent as DataCell;
set => base.Parent = value;
}
/// <summary>
/// Gets or sets the <see cref="PhasorDefinition"/> associated with this <see cref="PhasorValue"/>.
/// </summary>
public new virtual PhasorDefinition Definition
{
get => base.Definition as PhasorDefinition;
set => base.Definition = value;
}
/// <summary>
/// Gets or sets the <see cref="Units.Angle"/> value (a.k.a., the argument) of this <see cref="PhasorValue"/>, in radians.
/// </summary>
public override Angle Angle
{
get => Angle.FromDegrees(base.Angle.ToDegrees() + Definition.Offset);
set => base.Angle = Angle.FromDegrees(value.ToDegrees() - Definition.Offset);
}
/// <summary>
/// Gets or sets the magnitude value (a.k.a., the absolute value or modulus) of this <see cref="PhasorValue"/>.
/// </summary>
public override double Magnitude
{
get => base.Magnitude * PhasorDefinition.CustomConversionFactor(Definition);
set => base.Magnitude = value / PhasorDefinition.CustomConversionFactor(Definition);
}
#endregion
#region [ Static ]
// Static Methods
// Calculates binary length of a phasor value based on its definition
internal static uint CalculateBinaryLength(IPhasorDefinition definition)
{
// The phasor definition will determine the binary length based on data format
return (uint)new PhasorValue(null, definition).BinaryLength;
}
// Delegate handler to create a new BPA PDCstream phasor value
internal static IPhasorValue CreateNewValue(IDataCell parent, IPhasorDefinition definition, byte[] buffer, int startIndex, out int parsedLength)
{
IPhasorValue phasor = new PhasorValue(parent, definition);
parsedLength = phasor.ParseBinaryImage(buffer, startIndex, 0);
return phasor;
}
#endregion
}
}