Package ch.ivyteam.ivy.location

Class Distance

java.lang.Object

ch.ivyteam.ivy.location.Distance

public class Distance
extends Object

Distance between two positions

API:

This is a public API.

Method Summary

Modifier and Type	Method	Description
String	formatEnglishUnits()	Returns a string representation with english units miles (mi) or feets (ft).
double	inFeets()
static Distance	inFeets(double feets)	Creates a new distance in feets
double	inKilometers()
static Distance	inKilometers(double kilometers)	Creates a new distance in kilometers
double	inMeters()
static Distance	inMeters(double meters)	Creates a new distance in meters
double	inMiles()
static Distance	inMiles(double miles)	Creates a new distance in miles
boolean	isLessThan(Distance other)	Returns true if this distance is less than the given other distance

Method Detail

inMeters

public double inMeters()

Returns:

the distance in meters

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

inKilometers

public double inKilometers()

Returns:

the distance in kilometers

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

inFeets

public double inFeets()

Returns:

the distance in feets

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

inMiles

public double inMiles()

Returns:

the distance in miles

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

inMeters

public static Distance inMeters(double meters)

Creates a new distance in meters

Parameters:

meters -

Returns:

created distance

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

inKilometers

public static Distance inKilometers(double kilometers)

Creates a new distance in kilometers

Parameters:

kilometers -

Returns:

created distance

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

inFeets

public static Distance inFeets(double feets)

Creates a new distance in feets

Parameters:

feets -

Returns:

created distance

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

inMiles

public static Distance inMiles(double miles)

Creates a new distance in miles

Parameters:

miles -

Returns:

created distance

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

isLessThan

public boolean isLessThan(Distance other)

Returns true if this distance is less than the given other distance

Parameters:

other - other distance

Returns:

true if less than other

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

formatEnglishUnits

public String formatEnglishUnits()

Returns a string representation with english units miles (mi) or feets (ft). Example: 1225 ft

Returns:

formatted string

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.