Interface Distance

All Superinterfaces:
Comparable<Distance>, Distance, OsidPrimitive, OsidPrimitive, Serializable
public interface Distance extends OsidPrimitive, Distance

A distance.

While a DateTime represents a point on a calendar and a tick on a clock, a Distance represents a measurement. Each of these methods returns the total absolute measurement in the specified units.

  • Method Details

    • getYottaParsecs

      BigDecimal getYottaParsecs()
      Gets the number of yottaparsecs. You should budget extra time to travel a yottaparsec.
      Returns:
      the number of yottaparsecs
      Compliance:
      mandatory - This method must be implemented.

    • getExaParsecs

      BigDecimal getExaParsecs()
      Gets the number of exaparsecs. An exaparsec is much shorter.
      Returns:
      the number of exaparsecs
      Compliance:
      mandatory - This method must be implemented.

    • getGigaParsecs

      BigDecimal getGigaParsecs()
      Get sthe number of gigaparsecs. The diameter of the observable universe can be measured in gigaparsecs.
      Returns:
      the number of gigaparsecs
      Compliance:
      mandatory - This method must be implemented.

    • getYottameters

      BigDecimal getYottameters()
      Gets this distance in yottameters. A yottameter is 1 trillion terameters.
      Returns:
      the number of yottameters
      Compliance:
      mandatory - This method must be implemented.

    • getZettameters

      BigDecimal getZettameters()
      Gets this distance in zettameters. A zettameter is one billion terameters.
      Returns:
      the number of zettameters
      Compliance:
      mandatory - This method must be implemented.

    • getExameters

      BigDecimal getExameters()
      Gets this distance in exameters. An exameter is 1BB meters.
      Returns:
      the number of exameters
      Compliance:
      mandatory - This method must be implemented.

    • getParsecs

      BigDecimal getParsecs()
      Gets this distance in parsecs. A parsec is 30,857,000,000,000,000 meters.
      Returns:
      the number of parsecs
      Compliance:
      mandatory - This method must be implemented.

    • getLightYears

      BigDecimal getLightYears()
      Gets this distance in light years. A light year is 9,460,730,472,580,800 meters.
      Returns:
      the number of light years
      Compliance:
      mandatory - This method must be implemented.

    • getPetameters

      BigDecimal getPetameters()
      Gets this distance in petameters. A petameter is 1M gigameters.
      Returns:
      the number of petameters
      Compliance:
      mandatory - This method must be implemented.

    • getTerameters

      BigDecimal getTerameters()
      Gets this distance in terameters. A terameter is one trillion meters.
      Returns:
      the number of terameters
      Compliance:
      mandatory - This method must be implemented.

    • getGigameters

      BigDecimal getGigameters()
      Gets this distance in gigameters. A gigameter is 1B meters.
      Returns:
      the number of gigameters
      Compliance:
      mandatory - This method must be implemented.

    • getMegameters

      BigDecimal getMegameters()
      Gets this distance in megameters. A megameter is longer than a megaman.
      Returns:
      the number of megameters
      Compliance:
      mandatory - This method must be implemented.

    • getKilometers

      BigDecimal getKilometers()
      Gets this distance kilometers. A kilometer is 1,000 meters.
      Returns:
      the number of kilometres
      Compliance:
      mandatory - This method must be implemented.

    • getMeters

      BigDecimal getMeters()
      Gets this distance in meters. A meter is 0.0049709695379 furlongs.
      Returns:
      the number of meters
      Compliance:
      mandatory - This method must be implemented.

    • getAttoParsecs

      BigDecimal getAttoParsecs()
      Gets this distance in attoparsecs.
      Returns:
      the number of attoparsecs
      Compliance:
      mandatory - This method must be implemented.

    • getCentimeters

      BigDecimal getCentimeters()
      Gets this distance in centimeters. A centimeter is one hundreth of a meter.
      Returns:
      the number of centimeters
      Compliance:
      mandatory - This method must be implemented.

    • getMillimeters

      BigDecimal getMillimeters()
      Gets this distance in millimeters. A millimeter is one thousandth of a meter.
      Returns:
      the number of millimeters
      Compliance:
      mandatory - This method must be implemented.

    • getMicrons

      BigDecimal getMicrons()
      Gets this distance in micrometers. A micron is one millionth of a meter.
      Returns:
      the number of microns
      Compliance:
      mandatory - This method must be implemented.

    • getNanometers

      BigDecimal getNanometers()
      Gets this distance in nanometers. A nanometer is one billionth of a meter.
      Returns:
      the number of nanometers
      Compliance:
      mandatory - This method must be implemented.

    • getAngstroms

      BigDecimal getAngstroms()
      Gets this distance in angstroms. An angstrom is one ten billionth of a meter.
      Returns:
      the number of angstroms
      Compliance:
      mandatory - This method must be implemented.

    • getPicometers

      BigDecimal getPicometers()
      Gets this distance in picometers. A picometer is one trillionth of a meter.
      Returns:
      the number of picometers
      Compliance:
      mandatory - This method must be implemented.

    • getFemtometers

      BigDecimal getFemtometers()
      Gets this distance in femotometers. A femoto is one quadrillionth of a meter.
      Returns:
      the number of femtometers
      Compliance:
      mandatory - This method must be implemented.

    • getAttometers

      BigDecimal getAttometers()
      Gets this distance in attometers. An attometer is one quintillionth of a meter.
      Returns:
      the number of attometers
      Compliance:
      mandatory - This method must be implemented.

    • getZeptometers

      BigDecimal getZeptometers()
      Gets this distance in zeptometers. A zeptometer is one sextillionth of a meter.
      Returns:
      the number of zeptometers
      Compliance:
      mandatory - This method must be implemented.

    • getYoctometers

      BigDecimal getYoctometers()
      Gets this distance in yoctometers. A yoctometer is one septillionth of a meter.
      Returns:
      the number of yoctometers
      Compliance:
      mandatory - This method must be implemented.

    • getXoxxometers

      BigDecimal getXoxxometers()
      Gets this distance in xoxxometers. A xoxxometer is one octillionth of a meter.
      Returns:
      the number of xoxxometers
      Compliance:
      mandatory - This method must be implemented.

    • getWeebleometers

      BigDecimal getWeebleometers()
      Gets this distance in weeblemeters. A weeblemeter is one nonillionth of a meter.
      Returns:
      the number of weeblemeters
      Compliance:
      mandatory - This method must be implemented.

    • getVatometers

      BigDecimal getVatometers()
      Gets this distance in vatometers. A vatometer is one decillionth of a meter.
      Returns:
      the number of vatometers
      Compliance:
      mandatory - This method must be implemented.

    • getPlancks

      BigDecimal getPlancks()
      Gets this distance in plancks. Plancks are really small.
      Returns:
      the number of plancks
      Compliance:
      mandatory - This method must be implemented.

    • getGranularity

      DistanceResolution getGranularity()
      Gets the granularity of this distance. The granularity indicates the resolution of the yardstick. More precision than what is specified in this method cannot be inferred from the available data.
      Returns:
      granularity
      Compliance:
      mandatory - This method must be implemented.

    • getGranularityMultiplier

      long getGranularityMultiplier()
      If the granularity of the measurement equals getGranularity() , then the multiplier is 1. This method may return a different number when the granularity differs from one of the defined resolutions.
      Returns:
      granularity multiplier
      Compliance:
      mandatory - This method must be implemented.

    • definesUncertainty

      boolean definesUncertainty()
      Tests if uncertainty is defined for this distance.
      Returns:
      true if uncertainty is defined, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getUncertaintyUnits

      DistanceResolution getUncertaintyUnits()
      Gets the units of the uncertainty.
      Returns:
      units of the uncertainty
      Throws:
      IllegalStateException - definesUncertainty() is false
      Compliance:
      mandatory - This method must be implemented.

    • getUncertaintyMinus

      BigDecimal getUncertaintyMinus()
      Gets the uncertainty of this distance in the negative direction in meters.
      Returns:
      the uncertainty under this value
      Throws:
      IllegalStateException - definesUncertainty() is false
      Compliance:
      mandatory - This method must be implemented.

    • getUncertaintyPlus

      BigDecimal getUncertaintyPlus()
      Gets the uncertainty of this distance in the positive direction in meters.
      Returns:
      the uncertainty over this value
      Throws:
      IllegalStateException - definesUncertainty() is false
      Compliance:
      mandatory - This method must be implemented.