OSID - osid.mapping.Distance Service Interface Definition

Interface	osid.mapping.Distance
Implements	`osid.OsidPrimitive`
Used By	`osid.Metadata`
	`osid.configuration.Value`
	`osid.mapping.Speed`
	`osid.mapping.route.Route`
	`osid.mapping.route.RouteProgress`
	`osid.mapping.route.RouteSegment`
	`osid.search.terms.DistanceRangeTerm`
	`osid.search.terms.DistanceTerm`
Description	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	getYottaParsecs
Description	Gets the number of yottaparsecs. You should budget extra time to travel a yottaparsec.
Return	`decimal`	the number of yottaparsecs
Compliance	`mandatory`	This method must be implemented.
Method	getExaParsecs
Description	Gets the number of exaparsecs. An exaparsec is much shorter.
Return	`decimal`	the number of exaparsecs
Compliance	`mandatory`	This method must be implemented.
Method	getGigaParsecs
Description	Get sthe number of gigaparsecs. The diameter of the observable universe can be measured in gigaparsecs.
Return	`decimal`	the number of gigaparsecs
Compliance	`mandatory`	This method must be implemented.
Method	getYottameters
Description	Gets this distance in yottameters. A yottameter is 1 trillion terameters.
Return	`decimal`	the number of yottameters
Compliance	`mandatory`	This method must be implemented.
Method	getZettameters
Description	Gets this distance in zettameters. A zettameter is one billion terameters.
Return	`decimal`	the number of zettameters
Compliance	`mandatory`	This method must be implemented.
Method	getExameters
Description	Gets this distance in exameters. An exameter is 1BB meters.
Return	`decimal`	the number of exameters
Compliance	`mandatory`	This method must be implemented.
Method	getParsecs
Description	Gets this distance in parsecs. A parsec is 30,857,000,000,000,000 meters.
Return	`decimal`	the number of parsecs
Compliance	`mandatory`	This method must be implemented.
Method	getLightYears
Description	Gets this distance in light years. A light year is 9,460,730,472,580,800 meters.
Return	`decimal`	the number of light years
Compliance	`mandatory`	This method must be implemented.
Method	getPetameters
Description	Gets this distance in petameters. A petameter is 1M gigameters.
Return	`decimal`	the number of petameters
Compliance	`mandatory`	This method must be implemented.
Method	getTerameters
Description	Gets this distance in terameters. A terameter is one trillion meters.
Return	`decimal`	the number of terameters
Compliance	`mandatory`	This method must be implemented.
Method	getGigameters
Description	Gets this distance in gigameters. A gigameter is 1B meters.
Return	`decimal`	the number of gigameters
Compliance	`mandatory`	This method must be implemented.
Method	getMegameters
Description	Gets this distance in megameters. A megameter is longer than a megaman.
Return	`decimal`	the number of megameters
Compliance	`mandatory`	This method must be implemented.
Method	getKilometers
Description	Gets this distance kilometers. A kilometer is 1,000 meters.
Return	`decimal`	the number of kilometres
Compliance	`mandatory`	This method must be implemented.
Method	getMeters
Description	Gets this distance in meters. A meter is 0.0049709695379 furlongs.
Return	`decimal`	the number of meters
Compliance	`mandatory`	This method must be implemented.
Method	getAttoParsecs
Description	Gets this distance in attoparsecs.
Return	`decimal`	the number of attoparsecs
Compliance	`mandatory`	This method must be implemented.
Method	getCentimeters
Description	Gets this distance in centimeters. A centimeter is one hundreth of a meter.
Return	`decimal`	the number of centimeters
Compliance	`mandatory`	This method must be implemented.
Method	getMillimeters
Description	Gets this distance in millimeters. A millimeter is one thousandth (1e-3) of a meter.
Return	`decimal`	the number of millimeters
Compliance	`mandatory`	This method must be implemented.
Method	getMicrons
Description	Gets this distance in micrometers. A micron is one millionth (1e-6) of a meter.
Return	`decimal`	the number of microns
Compliance	`mandatory`	This method must be implemented.
Method	getNanometers
Description	Gets this distance in nanometers. A nanometer is one billionth (1e-9) of a meter.
Return	`decimal`	the number of nanometers
Compliance	`mandatory`	This method must be implemented.
Method	getAngstroms
Description	Gets this distance in angstroms. An angstrom is one ten billionth (1e-10) of a meter.
Return	`decimal`	the number of angstroms
Compliance	`mandatory`	This method must be implemented.
Method	getPicometers
Description	Gets this distance in picometers. A picometer is one trillionth (1e-12) of a meter.
Return	`decimal`	the number of picometers
Compliance	`mandatory`	This method must be implemented.
Method	getFemtometers
Description	Gets this distance in femotometers. A femoto is one quadrillionth (1e-15) of a meter.
Return	`decimal`	the number of femtometers
Compliance	`mandatory`	This method must be implemented.
Method	getAttometers
Description	Gets this distance in attometers. An attometer is one quintillionth (1e-18) of a meter.
Return	`decimal`	the number of attometers
Compliance	`mandatory`	This method must be implemented.
Method	getZeptometers
Description	Gets this distance in zeptometers. A zeptometer is one sextillionth (1e-21) of a meter.
Return	`decimal`	the number of zeptometers
Compliance	`mandatory`	This method must be implemented.
Method	getYoctometers
Description	Gets this distance in yoctometers. A yoctometer is one septillionth (1e-24) of a meter.
Return	`decimal`	the number of yoctometers
Compliance	`mandatory`	This method must be implemented.
Method	getRontometers
Description	Gets this distance in rontometers. A rontometer is one octillionth (1e-27) of a meter.
Return	`decimal`	the number of rontometers
Compliance	`mandatory`	This method must be implemented.
Method	getQuectometers
Description	Gets this distance in quectometers. A quectometer is one nonillionth (1e-30) of a meter.
Return	`decimal`	the number of quectometers
Compliance	`mandatory`	This method must be implemented.
Method	getMilliquectometers
Description	Gets this distance in milliquectometers. A milliquectometer is one decillionth (1e-33) of a meter.
Return	`decimal`	the number of milliquectometers
Compliance	`mandatory`	This method must be implemented.
Method	getPlancks
Description	Gets this distance in plancks. Plancks are 161.6255 decillionths (1.616255e-35) of a meter. We cannot integrate with anything smaller.
Return	`decimal`	the number of plancks
Compliance	`mandatory`	This method must be implemented.
Method	getGranularity
Description	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.
Return	`osid.mapping.DistanceResolution`	granularity
Compliance	`mandatory`	This method must be implemented.
Method	getGranularityMultiplier
Description	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.
Return	`cardinal`	granularity multiplier
Compliance	`mandatory`	This method must be implemented.
Method	definesUncertainty
Description	Tests if uncertainty is defined for this distance.
Return	`boolean`	`true` if uncertainty is defined, `false` otherwise
Compliance	`mandatory`	This method must be implemented.
Method	getUncertaintyUnits
Description	Gets the units of the uncertainty.
Return	`osid.mapping.DistanceResolution`	units of the uncertainty
Errors	ILLEGAL_STATE	`definesUncertainty()` is `false`
Compliance	`mandatory`	This method must be implemented.
Method	getUncertaintyMinus
Description	Gets the uncertainty of this distance in the negative direction in meters.
Return	`decimal`	the uncertainty under this value
Errors	ILLEGAL_STATE	`definesUncertainty()` is `false`
Compliance	`mandatory`	This method must be implemented.
Method	getUncertaintyPlus
Description	Gets the uncertainty of this distance in the positive direction in meters.
Return	`decimal`	the uncertainty over this value
Errors	ILLEGAL_STATE	`definesUncertainty()` is `false`
Compliance	`mandatory`	This method must be implemented.