org.ka2ddo.yaac.osm

Class Speed

java.lang.Object

org.ka2ddo.yaac.osm.Speed

public class Speed
extends java.lang.Object

This class defines a compound object containing a speed value and the units of speed.

Author:

Andrew Pavlin, KA2DDO

Constructor Summary

Constructors

Constructor and Description
Speed(int speed, DistanceUnit unit) Create a Speed object for the specified magnitude and unit.
Speed(java.lang.String value) Create a Speed object from the specified string

Method Summary

Modifier and Type	Method and Description
java.lang.String	getIsoCountryCode() Get the ISO country code (if any) associated with this Speed value.
int	getSpeed() Get the speed in the specified unit.
DistanceUnit	getUnit() Get the DistanceUnit (interpreted as a speed unit in DistanceUnit per hour) for this Speed.
java.lang.String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Speed

public Speed(java.lang.String value)

Create a Speed object from the specified string

Parameters:

value - String to be interpreted as a speed value, possibly with appended units and prefixed country code

Speed

public Speed(int speed,
             DistanceUnit unit)

Create a Speed object for the specified magnitude and unit.

Parameters:

speed - int speed magnitude

unit - DistanceUnit corresponding to the units-per-hour speed value

Method Detail

getSpeed

public int getSpeed()

Get the speed in the specified unit.

Returns:

speed in the specified unit

See Also:

getUnit()

getUnit

public DistanceUnit getUnit()

Get the DistanceUnit (interpreted as a speed unit in DistanceUnit per hour) for this Speed.

Returns:

DistanceUnit for measuring the speed

getIsoCountryCode

public java.lang.String getIsoCountryCode()

Get the ISO country code (if any) associated with this Speed value.

Returns:

ISO country code String, or null if none specified

toString

public java.lang.String toString()

Returns a string representation of the object.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object.