com.mapinfo.midev.unit

Enum AngularUnit

java.lang.Object

java.lang.Enum<AngularUnit>

com.mapinfo.midev.unit.AngularUnit

All Implemented Interfaces:

Serializable, Comparable<AngularUnit>

public enum AngularUnit
extends Enum<AngularUnit>

An unit of measure for angles.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEGREE An AngularUnit representing degrees.
GRADIAN An AngularUnit representing a gradian.
MINUTE An AngularUnit representing arc-minutes.
RADIAN An AngularUnit representing radians.
SECOND An AngularUnit representing arc-seconds.

Method Summary

Modifier and Type	Method and Description
static double	convert(double angle, AngularUnit fromUnit, AngularUnit toUnit) Convert the specified angle to its equivalent value in another angular unit.
double	getDegreesPerUnit() Get the number of degrees equivalent to one of this unit of measure.
static AngularUnit	valueOf(String name) Returns the enum constant of this type with the specified name.
static AngularUnit[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DEGREE

public static final AngularUnit DEGREE

An AngularUnit representing degrees.

MINUTE

public static final AngularUnit MINUTE

An AngularUnit representing arc-minutes.

SECOND

public static final AngularUnit SECOND

An AngularUnit representing arc-seconds.

RADIAN

public static final AngularUnit RADIAN

An AngularUnit representing radians.

GRADIAN

public static final AngularUnit GRADIAN

An AngularUnit representing a gradian.

Method Detail

values

public static AngularUnit[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AngularUnit c : AngularUnit.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AngularUnit valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getDegreesPerUnit

public double getDegreesPerUnit()

Get the number of degrees equivalent to one of this unit of measure.

Returns:

The number of degrees equivalent to one of this unit of measure.

convert

public static double convert(double angle,
                             AngularUnit fromUnit,
                             AngularUnit toUnit)

Convert the specified angle to its equivalent value in another angular unit.

Parameters:

angle - An angle with unit fromUnit

fromUnit - The angular unit of the specified angle.

toUnit - The angular unit for the converted value.

Returns:

The converted angle in the specified units.