org.xspace.mx.physics.immutable
Class Mile

java.lang.Object
  extended byorg.xspace.mx.physics.immutable.BaseUnit
      extended byorg.xspace.mx.physics.immutable.Length
          extended byorg.xspace.mx.physics.immutable.Mile
All Implemented Interfaces:
Length, Measurement, java.io.Serializable

public class Mile
extends Length

A Measurement representing a mile.

Since:
0.5
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.xspace.mx.physics.immutable.BaseUnit
DIM_ANGLE, DIM_LENGTH, DIM_MASS, DIM_TIME, dims, systemValue, TOL
 
Constructor Summary
Mile()
          Creates a Measurement equal to one mile
Mile(double value)
          Creates a Measurement as a multiple of Miles
Mile(Measurement mx)
          Creates a Measurement that is equivalent to the input
 
Method Summary
 java.lang.String getAbbr()
          An abbreviated description of the units of a Mile
 java.lang.String getDescription()
          A description of the units of a Mile
 
Methods inherited from class org.xspace.mx.physics.immutable.BaseUnit
copy, copyBaseUnit, div, div, divInternal, divInternal, getSystem, getSystemDimensions, getSystemValue, getValue, isSameMeasurementType, minus, minusInternal, mult, mult, multInternal, multInternal, plus, plusInternal, pow, powInternal, root, rootInternal, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.xspace.mx.Measurement
copy, div, div, getSystem, getSystemDimensions, getSystemValue, getValue, minus, mult, mult, plus, pow, root
 

Constructor Detail

Mile

public Mile()
Creates a Measurement equal to one mile


Mile

public Mile(double value)
Creates a Measurement as a multiple of Miles

Parameters:
value - The number of Miles

Mile

public Mile(Measurement mx)
Creates a Measurement that is equivalent to the input

Method Detail

getAbbr

public java.lang.String getAbbr()
An abbreviated description of the units of a Mile

Specified by:
getAbbr in interface Measurement
Overrides:
getAbbr in class BaseUnit
Returns:
The string "mi"

getDescription

public java.lang.String getDescription()
A description of the units of a Mile

Specified by:
getDescription in interface Measurement
Overrides:
getDescription in class BaseUnit
Returns:
The string "miles"