OSID Logo
OSID Specifications
mapping package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.Distance
Implementsosid.OsidPrimitive
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.

MethodgetYottaParsecs
Description

Gets the number of yottaparsecs. You should budget extra time to travel a yottaparsec.

Returndecimalthe number of yottaparsecs
CompliancemandatoryThis method must be implemented.
MethodgetExaParsecs
Description

Gets the number of exaparsecs. An exaparsec is much shorter.

Returndecimalthe number of exaparsecs
CompliancemandatoryThis method must be implemented.
MethodgetGigaParsecs
Description

Get sthe number of gigaparsecs. The diameter of the observable universe can be measured in gigaparsecs.

Returndecimalthe number of gigaparsecs
CompliancemandatoryThis method must be implemented.
MethodgetYottameters
Description

Gets this distance in yottameters. A yottameter is 1 trillion terameters.

Returndecimalthe number of yottameters
CompliancemandatoryThis method must be implemented.
MethodgetZettameters
Description

Gets this distance in zettameters. A zettameter is one billion terameters.

Returndecimalthe number of zettameters
CompliancemandatoryThis method must be implemented.
MethodgetExameters
Description

Gets this distance in exameters. A exameter is 1BB meters.

Returndecimalthe number of exameters
CompliancemandatoryThis method must be implemented.
MethodgetParsecs
Description

Gets this distance in parsecs. A parsec is 30,857,000,000,000,000 meters.

Returndecimalthe number of parsecs
CompliancemandatoryThis method must be implemented.
MethodgetLightYears
Description

Gets this distance in light years. A light year is 9,460,730,472,580,800 meters.

Returndecimalthe number of light years
CompliancemandatoryThis method must be implemented.
MethodgetPetameters
Description

Gets this distance in petameters. A petameter is 1M gigameters.

Returndecimalthe number of petameters
CompliancemandatoryThis method must be implemented.
MethodgetTerameters
Description

Gets this distance in terameters. A terameter is one trillion meters.

Returndecimalthe number of terameters
CompliancemandatoryThis method must be implemented.
MethodgetGigameters
Description

Gets this distance in gigameters. A gigameter is 1B meters.

Returndecimalthe number of gigameters
CompliancemandatoryThis method must be implemented.
MethodgetMegameters
Description

Gets this distance in megameters. A megameter is longer than a megaman.

Returndecimalthe number of megameters
CompliancemandatoryThis method must be implemented.
MethodgetKilometers
Description

Gets this distance kilometers. A kilometer is 1,000 meters.

Returndecimalthe number of kilometres
CompliancemandatoryThis method must be implemented.
MethodgetMeters
Description

Gets this distance in meters. A meter is 0.0049709695379 furlongs.

Returndecimalthe number of meters
CompliancemandatoryThis method must be implemented.
MethodgetAttoParsecs
Description

Gets this distance in attoparsecs.

Returndecimalthe number of attoparsecs
CompliancemandatoryThis method must be implemented.
MethodgetCentimeters
Description

Gets this distance in centimeters. A centimeter is one hundreth of a meter.

Returndecimalthe number of centimeters
CompliancemandatoryThis method must be implemented.
MethodgetMillimeters
Description

Gets this distance in millimeters. A millimeter is one thousandth of a meter.

Returndecimalthe number of millimeters
CompliancemandatoryThis method must be implemented.
MethodgetMicrons
Description

Gets this distance in micrometers. A micron is one millionth of a meter.

Returndecimalthe number of microns
CompliancemandatoryThis method must be implemented.
MethodgetNanometers
Description

Gets this distance in nanometers. A nanometer is one billionth of a meter.

Returndecimalthe number of nanometers
CompliancemandatoryThis method must be implemented.
MethodgetAngstroms
Description

Gets this distance in angstroms. An angstrom is one ten billionth of a meter.

Returndecimalthe number of angstroms
CompliancemandatoryThis method must be implemented.
MethodgetPicometers
Description

Gets this distance in picometers. A picometer is one trillionth of a meter.

Returndecimalthe number of picometers
CompliancemandatoryThis method must be implemented.
MethodgetFemtometers
Description

Gets this distance in femotometers. A femoto is one quadrillionth of a meter.

Returndecimalthe number of femtometers
CompliancemandatoryThis method must be implemented.
MethodgetAttometers
Description

Gets this distance in attometers. An attometer is one quintillionth of a meter.

Returndecimalthe number of attometers
CompliancemandatoryThis method must be implemented.
MethodgetZeptometers
Description

Gets this distance in zeptometers. A zeptometer is one sextillionth of a meter.

Returndecimalthe number of zeptometers
CompliancemandatoryThis method must be implemented.
MethodgetYoctometers
Description

Gets this distance in yoctometers. A yoctometer is one septillionth of a meter.

Returndecimalthe number of yoctometers
CompliancemandatoryThis method must be implemented.
MethodgetXoxxometers
Description

Gets this distance in xoxxometers. A xoxxometer is one octillionth of a meter.

Returndecimalthe number of xoxxometers
CompliancemandatoryThis method must be implemented.
MethodgetWeebleometers
Description

Gets this distance in weeblemeters. A weeblemeter is one nonillionth of a meter.

Returndecimalthe number of weeblemeters
CompliancemandatoryThis method must be implemented.
MethodgetVatometers
Description

Gets this distance in vatometers. A vatometer is one decillionth of a meter.

Returndecimalthe number of vatometers
CompliancemandatoryThis method must be implemented.
MethodgetPlancks
Description

Gets this distance in plancks. Plancks are really small.

Returndecimalthe number of plancks
CompliancemandatoryThis method must be implemented.
MethodgetGranularity
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.

Returnosid.mapping.DistanceResolutiongranularity
CompliancemandatoryThis method must be implemented.
MethodgetGranularityMultiplier
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.

Returncardinalgranularity multiplier
CompliancemandatoryThis method must be implemented.
MethoddefinesUncertainty
Description

Tests if uncertainty is defined for this distance.

Returnboolean true if uncertainty is defined, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetUncertaintyUnits
Description

Gets the units of the uncertainty.

Returnosid.mapping.DistanceResolutionunits of the uncertainty
ErrorsILLEGAL_STATE definesUncertainty() is false
CompliancemandatoryThis method must be implemented.
MethodgetUncertaintyMinus
Description

Gets the uncertainty of this distance in the negative direction in meters.

Returndecimalthe uncertainty under this value
ErrorsILLEGAL_STATE definesUncertainty() is false
CompliancemandatoryThis method must be implemented.
MethodgetUncertaintyPlus
Description

Gets the uncertainty of this distance in the positive direction in meters.

Returndecimalthe uncertainty over this value
ErrorsILLEGAL_STATE definesUncertainty() is false
CompliancemandatoryThis method must be implemented.