uk.theretiredprogrammer.gpssurvey

Class Depth

java.lang.Object

uk.theretiredprogrammer.gpssurvey.Depth

public class Depth
extends Object

The Depth Class - represents a depth in metres.

Author:

Richard Linsdale (richard at theretiredprogrammer.uk)

Constructor Summary

Constructors

Constructor and Description
Depth(double value) Constructor

Method Summary

Modifier and Type	Method and Description
Depth	clone()
boolean	equals(Object other)
double	get() Get the depth value.
int	hashCode()
String	toString()
String	toStringWithUnits() Format the depth value as a String.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Depth

public Depth(double value)

Constructor

Parameters:

value - the depth (in metres)

Method Detail

get

public double get()

Get the depth value.

Returns:

the depth value (in metres)

clone

public Depth clone()

Overrides:

clone in class Object

toString

public String toString()

Overrides:

toString in class Object

toStringWithUnits

public String toStringWithUnits()

Format the depth value as a String. The string representation includes the units symbol.

Returns:

the formated string

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object