fr.cnes.sirius.patrius.projections

Enum EnumLineProperty

java.lang.Object

java.lang.Enum<EnumLineProperty>

fr.cnes.sirius.patrius.projections.EnumLineProperty

All Implemented Interfaces:

Serializable, Comparable<EnumLineProperty>

public enum EnumLineProperty
extends Enum<EnumLineProperty>

This enumeration allows user to know how polygon's points are connected. The enumeration can be of three kind :

STRAIGHT : A straight line is connecting each point. The associated projection is the IdentityProjection. Use this if you're interested in polygonal computation speed.

GREAT_CIRCLE : A great circle line is the shortest way to connect two points on a sphere (or on ellipsoid). Its associated projection method is a Gnomonic projection.

STRAIGHT_RHUMB_LINE : A straight rhumb line is a line of constant direction (constant bearing). The Mercator projection basically satisfied this property and all rhumb lines are shown as straight lines.

NONE : No property.

Since:

3.2

Version:

$Id$

Enum Constant Summary

Enum Constants

Enum Constant and Description
GREAT_CIRCLE Great circle line property.
NONE No particular property
STRAIGHT Straight line property.
STRAIGHT_RHUMB_LINE Rhumb line property.

Method Summary

Modifier and Type	Method and Description
String	getName() Get the line property's name.
static EnumLineProperty	valueOf(String name) Returns the enum constant of this type with the specified name.
static EnumLineProperty[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STRAIGHT

public static final EnumLineProperty STRAIGHT

Straight line property.

GREAT_CIRCLE

public static final EnumLineProperty GREAT_CIRCLE

Great circle line property.

STRAIGHT_RHUMB_LINE

public static final EnumLineProperty STRAIGHT_RHUMB_LINE

Rhumb line property.

NONE

public static final EnumLineProperty NONE

No particular property

Method Detail

values

public static EnumLineProperty[] 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 (EnumLineProperty c : EnumLineProperty.values())
    System.out.println(c);

Returns:

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

valueOf

public static EnumLineProperty 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

getName

public String getName()

Get the line property's name.

Returns:

name of the type