uk.ac.newcastle.team22.usb.navigation

Enum Direction

java.lang.Object

java.lang.Enum<Direction>

uk.ac.newcastle.team22.usb.navigation.Direction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Direction>

public enum Direction
extends java.lang.Enum<Direction>

A class to define navigation directions.

Version:

1.0

Author:

Daniel Vincent

Enum Constant Summary

Enum Constants

Enum Constant and Description
BACKWARD
FORWARD
LEFT
LIFT_DOWN
LIFT_UP
MODERATE_LEFT
MODERATE_RIGHT
RIGHT
SHARP_LEFT
SHARP_RIGHT
STAIR_DOWN
STAIR_UP
TOUR_LOCATION

Method Summary

Modifier and Type	Method and Description
static int	getFirstAngle(java.util.List<Edge> edges) Given a list of edges, return the heading users should face to follow parsed directions.
int	getImageRepresentation()
int	getLocalisedDirection()
static java.util.List<Direction>	parseDirections(java.util.List<Edge> edges) Given a list of edges, returns a list of directions for turn by turn navigation between nodes.
static Direction	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Direction[]	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

FORWARD

public static final Direction FORWARD

BACKWARD

public static final Direction BACKWARD

LEFT

public static final Direction LEFT

MODERATE_LEFT

public static final Direction MODERATE_LEFT

SHARP_LEFT

public static final Direction SHARP_LEFT

RIGHT

public static final Direction RIGHT

MODERATE_RIGHT

public static final Direction MODERATE_RIGHT

SHARP_RIGHT

public static final Direction SHARP_RIGHT

LIFT_UP

public static final Direction LIFT_UP

LIFT_DOWN

public static final Direction LIFT_DOWN

STAIR_UP

public static final Direction STAIR_UP

STAIR_DOWN

public static final Direction STAIR_DOWN

TOUR_LOCATION

public static final Direction TOUR_LOCATION

Method Detail

values

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

Returns:

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

valueOf

public static Direction valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getLocalisedDirection

@StringRes
public int getLocalisedDirection()

Returns:

Localised string representation of the direction.

getImageRepresentation

@DrawableRes
public int getImageRepresentation()

Returns:

Image representation of the direction.

parseDirections

public static java.util.List<Direction> parseDirections(java.util.List<Edge> edges)
                                                 throws java.lang.IllegalArgumentException

Given a list of edges, returns a list of directions for turn by turn navigation between nodes.

Parameters:

edges - list of edges whose directions should be parsed.

Returns:

List of direction enums.

Throws:

java.lang.IllegalArgumentException - Invalid directions were found along the route.

getFirstAngle

public static int getFirstAngle(java.util.List<Edge> edges)

Given a list of edges, return the heading users should face to follow parsed directions.

Parameters:

edges - list of edges whose directions the user will follow.

Returns:

The first angle the user should face to begin navigation.