Class/Object

squants.energy

Energy

Related Docs: object Energy | package energy

Permalink

final class Energy extends Quantity[Energy] with TimeIntegral[Power] with SecondTimeIntegral[PowerRamp]

Represents a quantity of energy

Source
Energy.scala
Since

0.1

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Energy
  2. SecondTimeIntegral
  3. TimeIntegral
  4. Quantity
  5. Ordered
  6. Comparable
  7. Serializable
  8. Serializable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def %(that: Energy): Double

    Permalink
    Definition Classes
    Quantity
  4. def %(that: Double): Energy

    Permalink
    Definition Classes
    Quantity
  5. def *(that: ParticleFlux): Irradiance

    Permalink
  6. def *(that: Frequency): Power

    Permalink

    Returns the Time Derivative of this Quantity based on the Frequency this Quantity occurs

    Returns the Time Derivative of this Quantity based on the Frequency this Quantity occurs

    that

    Frequency - the rate at which this Quantity occurs

    Definition Classes
    TimeIntegral
  7. def *(that: Price[Energy]): Money

    Permalink
    Definition Classes
    Quantity
  8. def *(that: Double): Energy

    Permalink
    Definition Classes
    Quantity
  9. def +(that: Energy): Energy

    Permalink
    Definition Classes
    Quantity
  10. def +-(that: Energy): QuantityRange[Energy]

    Permalink
    Definition Classes
    Quantity
  11. def -(that: Energy): Energy

    Permalink
    Definition Classes
    Quantity
  12. def /(that: PowerRamp): TimeSquared

    Permalink
    Definition Classes
    EnergySecondTimeIntegral
  13. def /(that: TimeSquared): PowerRamp

    Permalink
    Definition Classes
    EnergySecondTimeIntegral
  14. def /(that: Area): Nothing

    Permalink
  15. def /(that: Angle): Torque

    Permalink
  16. def /(that: mass.ChemicalAmount): MolarEnergy

    Permalink
  17. def /(that: ThermalCapacity): thermal.Temperature

    Permalink
  18. def /(that: Temperature): ThermalCapacity

    Permalink
  19. def /(that: ElectricPotential): ElectricCharge

    Permalink
  20. def /(that: ElectricCharge): ElectricPotential

    Permalink
  21. def /(that: EnergyDensity): Volume

    Permalink
  22. def /(that: Volume): EnergyDensity

    Permalink
  23. def /(that: SpecificEnergy): Mass

    Permalink
  24. def /(that: Mass): SpecificEnergy

    Permalink
  25. def /(that: Force): Length

    Permalink
  26. def /(that: Length): Force

    Permalink
  27. def /(that: Power): time.Time

    Permalink

    Returns the amount time required to achieve the given change in the Derivative

    Returns the amount time required to achieve the given change in the Derivative

    that

    Derivative

    Definition Classes
    TimeIntegral
  28. def /(that: time.Time): Power

    Permalink

    Returns the Time Derivative which represents a change of the underlying quantity equal to this quantity over the given time.

    Returns the Time Derivative which represents a change of the underlying quantity equal to this quantity over the given time.

    that

    Time

    Definition Classes
    TimeIntegral
  29. def /(that: Energy): Double

    Permalink
    Definition Classes
    Quantity
  30. def /(that: Double): Energy

    Permalink
    Definition Classes
    Quantity
  31. def /%(that: Energy): (Double, Energy)

    Permalink
    Definition Classes
    Quantity
  32. def /%(that: Double): (Energy, Energy)

    Permalink
    Definition Classes
    Quantity
  33. def <(that: Energy): Boolean

    Permalink
    Definition Classes
    Ordered
  34. def <=(that: Energy): Boolean

    Permalink
    Definition Classes
    Ordered
  35. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  36. def =~(that: Energy)(implicit tolerance: Energy): Boolean

    Permalink

    approx

    approx

    Definition Classes
    Quantity
  37. def >(that: Energy): Boolean

    Permalink
    Definition Classes
    Ordered
  38. def >=(that: Energy): Boolean

    Permalink
    Definition Classes
    Ordered
  39. def abs: Energy

    Permalink

    Returns the absolute value of this Quantity

    Returns the absolute value of this Quantity

    returns

    Quantity

    Definition Classes
    Quantity
  40. def approx(that: Energy)(implicit tolerance: Energy): Boolean

    Permalink

    Returns boolean result of approximate equality comparison

    Returns boolean result of approximate equality comparison

    that

    Quantity

    tolerance

    Quantity

    Definition Classes
    Quantity
  41. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  42. def asTorque: Torque

    Permalink

    Energy and torque have the same unit, so convert appropriately

    Energy and torque have the same unit, so convert appropriately

    returns

    numerically equivalent value in newton-meters

  43. def ceil: Energy

    Permalink

    Returns the smallest (closest to negative infinity) Quantity value that is greater than or equal to the argument and is equal to a mathematical integer.

    Returns the smallest (closest to negative infinity) Quantity value that is greater than or equal to the argument and is equal to a mathematical integer.

    returns

    Quantity

    Definition Classes
    Quantity
    See also

    java.lang.Math#ceil(double)

  44. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. def compare(that: Energy): Int

    Permalink

    Implements Ordered.compare

    Implements Ordered.compare

    that

    Quantity

    returns

    Int

    Definition Classes
    Quantity → Ordered
  46. def compareTo(that: Energy): Int

    Permalink
    Definition Classes
    Ordered → Comparable
  47. def dimension: Energy.type

    Permalink

    The Dimension this quantity represents

    The Dimension this quantity represents

    Definition Classes
    EnergyQuantity
  48. def divide(that: Energy): Double

    Permalink

    Divide this quantity by a like quantity

    Divide this quantity by a like quantity

    that

    Quantity

    returns

    Double

    Definition Classes
    Quantity
  49. def divide(that: Double): Energy

    Permalink

    Divide this quantity by some number

    Divide this quantity by some number

    that

    Double

    returns

    Quantity

    Definition Classes
    Quantity
  50. def divideAndRemainder(that: Energy): (Double, Energy)

    Permalink

    Returns a Pair that includes the result of divideToInteger and remainder

    Returns a Pair that includes the result of divideToInteger and remainder

    that

    Quantity

    returns

    (Double, Quantity)

    Definition Classes
    Quantity
  51. def divideAndRemainder(that: Double): (Energy, Energy)

    Permalink

    Returns a Pair that includes the result of divideToInteger and remainder

    Returns a Pair that includes the result of divideToInteger and remainder

    that

    Double

    returns

    (Quantity, Quantity)

    Definition Classes
    Quantity
  52. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  53. def equals(that: Any): Boolean

    Permalink

    Override of equals method

    Override of equals method

    that

    must be of matching value and unit

    Definition Classes
    Quantity → AnyRef → Any
  54. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  55. def floor: Energy

    Permalink

    Returns the largest (closest to positive infinity) Quantity value that is less than or equal to the argument and is equal to a mathematical integer

    Returns the largest (closest to positive infinity) Quantity value that is less than or equal to the argument and is equal to a mathematical integer

    returns

    Quantity

    Definition Classes
    Quantity
    See also

    java.lang.Math#floor(double)

  56. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  57. def hashCode(): Int

    Permalink

    Override of hashCode

    Override of hashCode

    Definition Classes
    Quantity → AnyRef → Any
  58. def in(uom: UnitOfMeasure[Energy]): Energy

    Permalink

    Returns an equivalent Quantity boxed with the supplied Unit

    Returns an equivalent Quantity boxed with the supplied Unit

    uom

    UnitOfMeasure[A]

    returns

    Quantity

    Definition Classes
    Quantity
  59. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  60. def map(f: (Double) ⇒ Double): Energy

    Permalink

    Applies a function to the underlying value of the Quantity, returning a new Quantity in the same unit

    Applies a function to the underlying value of the Quantity, returning a new Quantity in the same unit

    f

    Double => Double function

    Definition Classes
    Quantity
  61. def max(that: Energy): Energy

    Permalink

    Returns the max of this and that Quantity

    Returns the max of this and that Quantity

    that

    Quantity

    returns

    Quantity

    Definition Classes
    Quantity
  62. def min(that: Energy): Energy

    Permalink

    Returns the min of this and that Quantity

    Returns the min of this and that Quantity

    that

    Quantity

    returns

    Quantity

    Definition Classes
    Quantity
  63. def minus(that: Energy): Energy

    Permalink

    Subtract two like quantities

    Subtract two like quantities

    that

    Quantity

    returns

    Quantity

    Definition Classes
    Quantity
  64. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  65. def negate: Energy

    Permalink

    Returns the negative value of this Quantity

    Returns the negative value of this Quantity

    returns

    Quantity

    Definition Classes
    Quantity
  66. def notWithin(range: QuantityRange[Energy]): Boolean

    Permalink

    Returns true if this value is not within (contains) the range

    Returns true if this value is not within (contains) the range

    range

    QuantityRange

    returns

    Boolean

    Definition Classes
    Quantity
  67. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  68. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  69. def per(that: TimeSquared): PowerRamp

    Permalink
    Definition Classes
    SecondTimeIntegral
  70. def per(that: time.Time): Power

    Permalink
    Definition Classes
    TimeIntegral
  71. def plus(that: Energy): Energy

    Permalink

    Add two like quantities

    Add two like quantities

    that

    Quantity

    returns

    Quantity

    Definition Classes
    Quantity
  72. def plusOrMinus(that: Energy): QuantityRange[Energy]

    Permalink

    Returns a QuantityRange representing the range for this value +- that

    Returns a QuantityRange representing the range for this value +- that

    that

    Quantity

    returns

    QuantityRange

    Definition Classes
    Quantity
  73. def remainder(that: Energy): Double

    Permalink

    Returns the remainder of a division by a like quantity

    Returns the remainder of a division by a like quantity

    that

    Quantity

    returns

    Double

    Definition Classes
    Quantity
  74. def remainder(that: Double): Energy

    Permalink

    Returns the remainder of a division by a number

    Returns the remainder of a division by a number

    that

    Quantity

    returns

    Quantity

    Definition Classes
    Quantity
  75. def rint: Energy

    Permalink

    Returns the Quantity value that is closest in value to the argument and is equal to a mathematical integer.

    Returns the Quantity value that is closest in value to the argument and is equal to a mathematical integer.

    returns

    Quantity

    Definition Classes
    Quantity
    See also

    java.lang.Math#rint(double)

  76. def rounded(scale: Int, mode: RoundingMode = RoundingMode.HALF_EVEN): Energy

    Permalink

    Returns the Quantity with its coefficient value rounded using scale and mode.

    Returns the Quantity with its coefficient value rounded using scale and mode. The unit is maintained.

    scale

    Int - scale of the value to be returned

    mode

    RoundingMode - defaults to HALF_EVEN

    returns

    Quantity

    Definition Classes
    Quantity
  77. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  78. def time: time.Time

    Permalink
    Attributes
    protected
    Definition Classes
    EnergyTimeIntegral
  79. def timeDerived: Power

    Permalink
    Attributes
    protected
    Definition Classes
    EnergyTimeIntegral
  80. def times(that: Double): Energy

    Permalink

    Multiply this quantity by some number

    Multiply this quantity by some number

    that

    Double

    returns

    Quantity

    Definition Classes
    Quantity
  81. def to(uom: UnitOfMeasure[Energy]): Double

    Permalink

    Returns a Double representing the quantity in terms of the supplied unit

    Returns a Double representing the quantity in terms of the supplied unit

    val d = Feet(3)
    (d to Inches) should be(36)
    uom

    UnitOfMeasure[A]

    returns

    Double

    Definition Classes
    Quantity
  82. def to(that: Energy): QuantityRange[Energy]

    Permalink

    Returns a QuantityRange that goes from this to that

    Returns a QuantityRange that goes from this to that

    that

    Quantity

    returns

    QuantityRange

    Definition Classes
    Quantity
  83. def toBtus: Double

    Permalink
  84. def toEeV: Double

    Permalink
  85. def toErgs: Double

    Permalink
  86. def toGeV: Double

    Permalink
  87. def toGigajoules: Double

    Permalink
  88. def toGigawattHours: Double

    Permalink
  89. def toJoules: Double

    Permalink
  90. def toKilojoules: Double

    Permalink
  91. def toKilowattHours: Double

    Permalink
  92. def toMBtus: Double

    Permalink
  93. def toMMBtus: Double

    Permalink
  94. def toMeV: Double

    Permalink
  95. def toMegajoules: Double

    Permalink
  96. def toMegawattHours: Double

    Permalink
  97. def toMicrojoules: Double

    Permalink
  98. def toMillijoules: Double

    Permalink
  99. def toMilliwattHours: Double

    Permalink
  100. def toNanojoules: Double

    Permalink
  101. def toPeV: Double

    Permalink
  102. def toPicojoules: Double

    Permalink
  103. def toString(uom: UnitOfMeasure[Energy], format: String): String

    Permalink

    Returns a string representing the quantity's value in the given unit in the given format

    Returns a string representing the quantity's value in the given unit in the given format

    uom

    UnitOfMeasure[A] with UnitConverter

    format

    String containing the format for the value (ie "%.3f")

    returns

    String

    Definition Classes
    Quantity
  104. def toString(uom: UnitOfMeasure[Energy]): String

    Permalink

    Returns a string representing the quantity's value in the given unit

    Returns a string representing the quantity's value in the given unit

    uom

    UnitOfMeasure[A] with UnitConverter

    returns

    String

    Definition Classes
    Quantity
  105. def toString(): String

    Permalink

    Returns a string representing the quantity's value in unit

    Returns a string representing the quantity's value in unit

    returns

    String

    Definition Classes
    Quantity → AnyRef → Any
  106. def toTeV: Double

    Permalink
  107. def toTerajoules: Double

    Permalink
  108. def toTuple(uom: UnitOfMeasure[Energy]): (Double, String)

    Permalink

    Returns a pair representing the numeric value and the uom's symbol

    Returns a pair representing the numeric value and the uom's symbol

    uom

    UnitOfMeasure[A]

    Definition Classes
    Quantity
  109. def toTuple: (Double, String)

    Permalink

    Returns a tuple representing the numeric value and the unit's symbol

    Returns a tuple representing the numeric value and the unit's symbol

    Definition Classes
    Quantity
  110. def toWattHours: Double

    Permalink
  111. def toeV: Double

    Permalink
  112. def tokeV: Double

    Permalink
  113. def tomeV: Double

    Permalink
  114. def unary_-: Energy

    Permalink
    Definition Classes
    Quantity
  115. val unit: EnergyUnit

    Permalink

    The Unit of Measure the value represents

    The Unit of Measure the value represents

    returns

    UnitOfMeasure[A]

    Definition Classes
    EnergyQuantity
  116. val value: Double

    Permalink

    value in squants.energy.WattHours

    Definition Classes
    EnergyQuantity
  117. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  118. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  119. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  120. def within(range: QuantityRange[Energy]): Boolean

    Permalink

    Returns true if this value is within (contains) the range

    Returns true if this value is within (contains) the range

    range

    QuantityRange

    returns

    Boolean

    Definition Classes
    Quantity
  121. def ~=(that: Energy)(implicit tolerance: Energy): Boolean

    Permalink

    approx

    approx

    Definition Classes
    Quantity
  122. def (that: Energy)(implicit tolerance: Energy): Boolean

    Permalink

    approx

    approx

    Definition Classes
    Quantity

Inherited from SecondTimeIntegral[PowerRamp]

Inherited from TimeIntegral[Power]

Inherited from Quantity[Energy]

Inherited from Ordered[Energy]

Inherited from Comparable[Energy]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped