org.ka2ddo.yaac.osm

Class Length

java.lang.Object

org.ka2ddo.yaac.osm.Length

All Implemented Interfaces:

QuantityUnitMeasure<DistanceUnit>

public class Length
extends java.lang.Object
implements QuantityUnitMeasure<DistanceUnit>

This class defines a compound object containing a length, width, or height value and the unit of length.

Author:

Andrew Pavlin, KA2DDO

Constructor Summary

Constructors

Constructor and Description
Length(float length) Create a Length with the specified magnitude in meters.
Length(float length, DistanceUnit unit) Create a Length with the specified magnitude.
Length(java.lang.String value) Decode a Length value from the specified String representation.

Method Summary

Modifier and Type	Method and Description
float	getMagnitude() Get the magnitude of this length in its unit.
float	getMagnitude(DistanceUnit otherUnit) Get this length in the specified units.
float	getMagnitudeInDefaultUnit() Get the length in the application-default units (meters).
DistanceUnit	getUnit() Get the unit in which the length magnitude is measured.
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

Length

public Length(java.lang.String value)

Decode a Length value from the specified String representation.

Parameters:

value - a String representation of a length

Throws:

java.lang.IllegalArgumentException - if the string cannot be successfully parsed

Length

public Length(float length,
              DistanceUnit unit)

Create a Length with the specified magnitude.

Parameters:

length - float length value in the specified units

unit - DistanceUnit of the length value

Length

public Length(float length)

Create a Length with the specified magnitude in meters.

Parameters:

length - float length value in meters

Method Detail

getMagnitude

public float getMagnitude()

Get the magnitude of this length in its unit.

Specified by:

getMagnitude in interface QuantityUnitMeasure<DistanceUnit>

Returns:

float length value

getMagnitude

public float getMagnitude(DistanceUnit otherUnit)

Get this length in the specified units.

Specified by:

getMagnitude in interface QuantityUnitMeasure<DistanceUnit>

Parameters:

otherUnit - DistanceUnit for scaling the length

Returns:

float length value in the specified units

getMagnitudeInDefaultUnit

public float getMagnitudeInDefaultUnit()

Get the length in the application-default units (meters).

Specified by:

getMagnitudeInDefaultUnit in interface QuantityUnitMeasure<DistanceUnit>

Returns:

float length value in meters

getUnit

public DistanceUnit getUnit()

Get the unit in which the length magnitude is measured.

Specified by:

getUnit in interface QuantityUnitMeasure<DistanceUnit>

Returns:

DistanceUnit of length

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.