aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/onos/utils/misc/src/main/java/org/onlab/util/DataRateUnit.java
blob: d49ed7b566d137a307e2af4d7d8706ac2bc0fe40 (plain)
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
package org.onlab.util;

import com.google.common.annotations.Beta;

/**
 * Data rate unit.
 */
@Beta
public enum DataRateUnit {
    /**
     * Bit per second.
     */
    BPS(1L),
    /**
     * Kilobit per second.
     * (Decimal/SI)
     */
    KBPS(1_000L),
    /**
     * Megabit per second.
     * (Decimal/SI)
     */
    MBPS(1_000_000L),
    /**
     * Gigabit per second.
     * (Decimal/SI)
     */
    GBPS(1_000_000_000L);

    private final long multiplier;

    DataRateUnit(long multiplier) {
        this.multiplier = multiplier;
    }

    /**
     * Returns the multiplier to use, when converting value of this unit to bps.
     *
     * @return multiplier
     */
    public long multiplier() {
        return multiplier;
    }

    /**
     * Converts given value in this unit to bits per seconds.
     *
     * @param v data rate value
     * @return {@code v} in bits per seconds
     */
    public long toBitsPerSecond(long v) {
        return v * multiplier;
    }

    /**
     * Converts given value in this unit to bits per seconds.
     *
     * @param v data rate value
     * @return {@code v} in bits per seconds
     */
    public double toBitsPerSecond(double v) {
        return v * multiplier;
    }
}