com.atakmap.android.preference

Class UnitPreferences

java.lang.Object

com.atakmap.android.preference.AtakPreferences

com.atakmap.android.preference.UnitPreferences

Direct Known Subclasses:

BloodHoundPreferences

public class UnitPreferences
extends AtakPreferences

Unit preferences helper class

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALTITUDE_REFERENCE
static java.lang.String	ALTITUDE_UNITS
static java.lang.String	AREA_SYSTEM
static java.lang.String	BEARING_UNITS
static java.lang.String	COORD_FMT
static java.lang.String	FT_MILES_THRESH
static java.lang.String	M_KM_THRESH
static java.lang.String	NORTH_REFERENCE
static java.lang.String	RANGE_SYSTEM

Fields inherited from class com.atakmap.android.preference.AtakPreferences

_context, _prefs

Constructor Summary

Constructors

Constructor and Description
UnitPreferences(MapView mapView)

Method Summary

Modifier and Type	Method and Description
java.lang.String	formatAltitude(GeoPoint point) Produce a human-readable altitude string
java.lang.String	formatAltitude(GeoPointMetaData pointMD) Produce a human-readable altitude string
java.lang.String	formatPoint(GeoPoint point, boolean includeAlt) Given a point, format the point using the default preference into a human readable format.
java.lang.String	formatPoint(GeoPointMetaData point, boolean includeAlt) Produce a human-readable coordinate string
java.lang.String	getAltitudeReference() Get the current altitude reference for display
Span	getAltitudeUnits() Get the preferred altitude units
int	getAreaSystem() Get the preferred area system
Angle	getBearingUnits() Get the preferred bearing units
CoordinateFormat	getCoordinateFormat() Get the preferred coordinate format
NorthReference	getNorthReference() Get the preferred north reference
int	getRangeSystem() Get the preferred range system
Span	getRangeUnits(double range) Get preferred range units based on set thresholds
void	setAltitudeUnits(Span unit)
void	setAreaSystem(int system)
void	setBearingUnits(Angle units)
void	setCoordinateFormat(CoordinateFormat format)
void	setNorthReference(NorthReference ref) Set the north reference for the default units.
void	setRangeSystem(int rangeSys)

Methods inherited from class com.atakmap.android.preference.AtakPreferences

contains, get, get, get, get, get, getAll, getSharedPrefs, getStringSet, registerListener, remove, set, unregisterListener

Methods inherited from class java.lang.Object

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

Field Detail

COORD_FMT

public static final java.lang.String COORD_FMT

See Also:

Constant Field Values

RANGE_SYSTEM

public static final java.lang.String RANGE_SYSTEM

See Also:

Constant Field Values

BEARING_UNITS

public static final java.lang.String BEARING_UNITS

See Also:

Constant Field Values

NORTH_REFERENCE

public static final java.lang.String NORTH_REFERENCE

See Also:

Constant Field Values

FT_MILES_THRESH

public static final java.lang.String FT_MILES_THRESH

See Also:

Constant Field Values

M_KM_THRESH

public static final java.lang.String M_KM_THRESH

See Also:

Constant Field Values

AREA_SYSTEM

public static final java.lang.String AREA_SYSTEM

See Also:

Constant Field Values

ALTITUDE_REFERENCE

public static final java.lang.String ALTITUDE_REFERENCE

See Also:

Constant Field Values

ALTITUDE_UNITS

public static final java.lang.String ALTITUDE_UNITS

See Also:

Constant Field Values

Constructor Detail

UnitPreferences

public UnitPreferences(MapView mapView)

Method Detail

getCoordinateFormat

public CoordinateFormat getCoordinateFormat()

Get the preferred coordinate format

Returns:

Coordinate format

setCoordinateFormat

public void setCoordinateFormat(CoordinateFormat format)

getRangeSystem

public int getRangeSystem()

Get the preferred range system

Returns:

Span#ENGLISH, Span#METRIC, or Span#NM

setRangeSystem

public void setRangeSystem(int rangeSys)

getRangeUnits

public Span getRangeUnits(double range)

Get preferred range units based on set thresholds

Parameters:

range - Range value to use as reference (meters)

Returns:

Range units

getAreaSystem

public int getAreaSystem()

Get the preferred area system

Returns:

Area.METRIC, Area.ENGLISH, Area.NM, or Area.AC

setAreaSystem

public void setAreaSystem(int system)

getBearingUnits

public Angle getBearingUnits()

Get the preferred bearing units

Returns:

Bearing units

setBearingUnits

public void setBearingUnits(Angle units)

getAltitudeReference

public java.lang.String getAltitudeReference()

Get the current altitude reference for display

Returns:

Altitude reference (MSL, HAE, or AGL)

getAltitudeUnits

public Span getAltitudeUnits()

Get the preferred altitude units

Returns:

Preferred altitude span

setAltitudeUnits

public void setAltitudeUnits(Span unit)

getNorthReference

public NorthReference getNorthReference()

Get the preferred north reference

Returns:

North reference

setNorthReference

public void setNorthReference(NorthReference ref)

Set the north reference for the default units.

Parameters:

ref - the reference to be used.

formatPoint

public java.lang.String formatPoint(GeoPointMetaData point,
                                    boolean includeAlt)

Produce a human-readable coordinate string

Parameters:

point - Point

includeAlt - True to include altitude on a new line

Returns:

Coordinate string

formatPoint

public java.lang.String formatPoint(GeoPoint point,
                                    boolean includeAlt)

Given a point, format the point using the default preference into a human readable format.

Parameters:

point - the point to be used

includeAlt - if altitude should be included in the human readable string

Returns:

the humand readable string for the point

formatAltitude

public java.lang.String formatAltitude(GeoPointMetaData pointMD)

Produce a human-readable altitude string

Parameters:

pointMD - Altitude point

Returns:

Altitude string

formatAltitude

public java.lang.String formatAltitude(GeoPoint point)

Produce a human-readable altitude string

Parameters:

point - Altitude point

Returns:

Altitude string