com.atakmap.coremap.conversions

Class AreaUtilities

java.lang.Object

com.atakmap.coremap.conversions.AreaUtilities

public class AreaUtilities
extends java.lang.Object

Allows for quick formatting of area information.

Constructor Summary

Constructors

Constructor and Description
AreaUtilities()

Method Summary

Modifier and Type	Method and Description
static double	calcCircleArea(double r) Computes the area of a circle using the most popular algorithm pies are squared
static double	calcRectArea(double h, double w) Computes the area of a rectangle using the most popular algorithm hxw
static double	calcShapeArea(GeoPoint[] points) Computes the area of a list of points assuming to be closed and also assume to be in order.
static double	convertValue(double value, Area from, Area to) Method to convert a value from an area type to another area type
static java.lang.String	formatArea(int unitsType, double value, Area units) Given a unit type and a value with the provided area units will produce the appropriate string.
static void	setFeetToMileThreshold(int value) Sets the threshold used, that when reached that when calls to SpanUtilities will switch from return feet to miles.
static void	setMetersToKilometersThreshold(int value) Sets the threshold used, that when reached that when calls to SpanUtilities will switch from return meters to kilometers.

Methods inherited from class java.lang.Object

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

Constructor Detail

AreaUtilities

public AreaUtilities()

Method Detail

setFeetToMileThreshold

public static void setFeetToMileThreshold(int value)

Sets the threshold used, that when reached that when calls to SpanUtilities will switch from return feet to miles.

setMetersToKilometersThreshold

public static void setMetersToKilometersThreshold(int value)

Sets the threshold used, that when reached that when calls to SpanUtilities will switch from return meters to kilometers.

formatArea

public static java.lang.String formatArea(int unitsType,
                                          double value,
                                          Area units)

Given a unit type and a value with the provided area units will produce the appropriate string.

Parameters:

unitsType - the unit types preferred for display. ENGLISH, METRIC, NM, AC

value - the value to use

units - the units that the value is in.

Returns:

convertValue

public static double convertValue(double value,
                                  Area from,
                                  Area to)

Method to convert a value from an area type to another area type

Parameters:

value - raw value in the format described by the from value

from - the Area of the source value

to - the value to convert to.

Returns:

the value in the newly formatted area type.

calcShapeArea

public static double calcShapeArea(GeoPoint[] points)

Computes the area of a list of points assuming to be closed and also assume to be in order.

Parameters:

points - the list of points.

Returns:

area in meters squared.

calcRectArea

public static double calcRectArea(double h,
                                  double w)

Computes the area of a rectangle using the most popular algorithm hxw

Parameters:

h - height

w - width

Returns:

area in meters squared.

calcCircleArea

public static double calcCircleArea(double r)

Computes the area of a circle using the most popular algorithm pies are squared

Parameters:

r - radius

Returns:

area in meters squared.