Package org.onlab.util

Enum DataRateUnit

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<DataRateUnit>
    @Beta
public enum DataRateUnit
extends java.lang.Enum<DataRateUnit>
    Data rate unit.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BPS
      Bit per second.
      GBPS
      Gigabit per second.
      KBPS
      Kilobit per second.
      MBPS
      Megabit per second.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      long multiplier()
      Returns the multiplier to use, when converting value of this unit to bps.
      double toBitsPerSecond​(double v)
      Converts given value in this unit to bits per seconds.
      long toBitsPerSecond​(long v)
      Converts given value in this unit to bits per seconds.
      static DataRateUnit valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static DataRateUnit[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • KBPS

        public static final DataRateUnit KBPS
        Kilobit per second. (Decimal/SI)

      • MBPS

        public static final DataRateUnit MBPS
        Megabit per second. (Decimal/SI)

      • GBPS

        public static final DataRateUnit GBPS
        Gigabit per second. (Decimal/SI)

    • Method Detail

      • values

        public static DataRateUnit[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (DataRateUnit c : DataRateUnit.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static DataRateUnit valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • multiplier

        public long multiplier()
        Returns the multiplier to use, when converting value of this unit to bps.
        Returns:
        multiplier

      • toBitsPerSecond

        public long toBitsPerSecond​(long v)
        Converts given value in this unit to bits per seconds.
        Parameters:
        v - data rate value
        Returns:
        v in bits per seconds

      • toBitsPerSecond

        public double toBitsPerSecond​(double v)
        Converts given value in this unit to bits per seconds.
        Parameters:
        v - data rate value
        Returns:
        v in bits per seconds