-
Notifications
You must be signed in to change notification settings - Fork 4
/
IPrefixMultiple.cs
42 lines (38 loc) · 1.49 KB
/
IPrefixMultiple.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
namespace Cuemon
{
/// <summary>
/// Defines a unit prefix that can can be expressed as a either a multiple or a submultiple of the unit of measurement.
/// </summary>
/// <seealso cref="BinaryPrefix"/>
/// <seealso cref="DecimalPrefix"/>
public interface IPrefixMultiple
{
/// <summary>
/// Gets the name of the unit prefix.
/// </summary>
/// <value>The name of the unit prefix.</value>
string Name { get; }
/// <summary>
/// Gets the symbol of the unit prefix.
/// </summary>
/// <value>The symbol of the unit prefix.</value>
string Symbol { get; }
/// <summary>
/// Gets the unit prefix multiplier.
/// </summary>
/// <value>The unit prefix multiplier.</value>
double Multiplier { get;}
/// <summary>
/// Converts the unit base <paramref name="value"/> to a unit prefix value.
/// </summary>
/// <param name="value">The value of the base unit.</param>
/// <returns>A <see cref="double"/> that represents a unit prefix value.</returns>
double ToPrefixValue(double value);
/// <summary>
/// Converts the <paramref name="prefixValue"/> back to a unit base value.
/// </summary>
/// <param name="prefixValue">The value of the unit prefix.</param>
/// <returns>A <see cref="double"/> that represents a unit base value.</returns>
double ToBaseValue(double prefixValue);
}
}