at.ac.ait.ariadne.routeformat.instruction

Class RoundaboutInstruction

java.lang.Object

at.ac.ait.ariadne.routeformat.instruction.Instruction<RoundaboutInstruction>

at.ac.ait.ariadne.routeformat.instruction.RoundaboutInstruction

All Implemented Interfaces:

Validatable

public class RoundaboutInstruction
extends Instruction<RoundaboutInstruction>

Instructions for navigating a roundabout. For pre-trip instructions a single detailed RoundaboutInstruction.SubType.ENTER instruction should be used. In case of on-trip navigation an additional RoundaboutInstruction.SubType.EXIT instruction could be useful.

In its minimal form it consists of a position, a getSubType() and at least one of getOntoStreetName() and getOntoFormOfWay().

Exemplary EBNF of how this instruction can be transformed into human-readable text and what's mandatory / optional. Elements ending with STRING are terminal (not defined any further).

CONTINUE_LANDMARK_STRING must be retrieved from the next Instruction

 
 ROUNDABOUT_INSTRUCTION = ENTER | EXIT;
 
 ENTER = "In the roundabout", [LANDMARK_PART], [ "on" ROUNDABOUT_STREET_NAME_STRING], "take the" [EXIT_NUMBER], "exit", 
         ["onto", NAME_OR_TYPE], [CONFIRMATION_LANDMARK_PART], [CONTINUE];
 EXIT = "Exit roundabout now", ["onto", NAME_OR_TYPE], [CONFIRMATION_LANDMARK_PART], [CONTINUE];
 
 EXIT_NUMBER = "first", "second",...;
 NAME_OR_TYPE = ONTO_STREET_NAME_STRING | ONTO_FORM_OF_WAY_STRING;
 CONTINUE = "and follow it", ["for", UNIT], ["until", CONTINUE_LANDMARK_PART]; (* at least one of the two *)
 UNIT = [DISTANCE_STRING], [TIME_STRING]; (* at least one of the two *)
 
 LANDMARK_PART = PREPOSITION, LANDMARK_STRING;
 CONTINUE_LANDMARK_PART = PREPOSITION, CONTINUE_LANDMARK_STRING;
 CONFIRMATION_LANDMARK_PART = CONFIRMATION_PREPOSITION, CONFIRMATION_LANDMARK_STRING;
 PREPOSITION = "before" | "at" | "after";
 CONFIRMATION_PREPOSITION = "towards" | "through" | "along" | "past";
 
 

Author:

AIT Austrian Institute of Technology GmbH

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RoundaboutInstruction.SubType

Constructor Summary

Constructors

Constructor and Description
RoundaboutInstruction()

Method Summary

Modifier and Type	Method and Description
static RoundaboutInstruction	createMinimalEnter(GeoJSONCoordinate position)
static RoundaboutInstruction	createMinimalExit(GeoJSONCoordinate position)
boolean	equals(Object obj)
Optional<Constants.CompassDirection>	getCompassDirection()
Optional<Landmark>	getConfirmationLandmark()
Optional<Integer>	getContinueMeters()
Optional<Integer>	getContinueSeconds()
Optional<String>	getContinueUntilIntersectingStreetName()
Optional<Integer>	getExitNr()
Optional<Landmark>	getLandmark()
Optional<Constants.FormOfWay>	getOntoFormOfWay() form of way of the street the roundabout exits to
Optional<String>	getOntoStreetName() street name of the street the roundabout exits to
Optional<String>	getRoundaboutStreetName() street name of the roundabout itself
RoundaboutInstruction.SubType	getSubType()
int	hashCode()
RoundaboutInstruction	setCompassDirection(Constants.CompassDirection compassDirection)
RoundaboutInstruction	setConfirmationLandmark(Landmark confirmationLandmark)
RoundaboutInstruction	setContinueMeters(Integer continueMeters)
RoundaboutInstruction	setContinueSeconds(Integer continueSeconds)
RoundaboutInstruction	setContinueUntilIntersectingStreetName(String continueUntilIntersectingStreetName)
RoundaboutInstruction	setExitNr(Integer exitNr)
RoundaboutInstruction	setLandmark(Landmark landmark)
RoundaboutInstruction	setOntoFormOfWay(Constants.FormOfWay ontoFormOfWay)
RoundaboutInstruction	setOntoStreetName(String ontoStreetName)
RoundaboutInstruction	setRoundaboutStreetName(String roundaboutStreetName)
RoundaboutInstruction	setSubType(RoundaboutInstruction.SubType subType)
String	toString()
void	validate() Checks if the instance is in a valid / useful state.

Methods inherited from class at.ac.ait.ariadne.routeformat.instruction.Instruction

getAdditionalInfo, getConfirmationTriggerPosition, getPosition, getPreviewTriggerPosition, getText, setAdditionalInfo, setConfirmationTriggerPosition, setConfirmationTriggerPosition, setPosition, setPosition, setPreviewTriggerPosition, setPreviewTriggerPosition, setText

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RoundaboutInstruction

public RoundaboutInstruction()

Method Detail

getSubType

public RoundaboutInstruction.SubType getSubType()

getCompassDirection

public Optional<Constants.CompassDirection> getCompassDirection()

getRoundaboutStreetName

public Optional<String> getRoundaboutStreetName()

street name of the roundabout itself

getOntoStreetName

public Optional<String> getOntoStreetName()

street name of the street the roundabout exits to

getOntoFormOfWay

public Optional<Constants.FormOfWay> getOntoFormOfWay()

form of way of the street the roundabout exits to

getExitNr

public Optional<Integer> getExitNr()

getContinueMeters

public Optional<Integer> getContinueMeters()

getContinueSeconds

public Optional<Integer> getContinueSeconds()

getContinueUntilIntersectingStreetName

public Optional<String> getContinueUntilIntersectingStreetName()

Returns:

the name of an intersecting road at the end of the current instruction, i.e. the place where the next instruction is

getLandmark

public Optional<Landmark> getLandmark()

Returns:

the landmark at roundabout. At the same time this landmark is the continue-landmark for the previous instruction, i.e. the landmark after getContinueMeters().

getConfirmationLandmark

public Optional<Landmark> getConfirmationLandmark()

Returns:

a landmark between this and the next instruction (or a global landmark in the general direction after this instruction) that helps users to stay on track

setSubType

public RoundaboutInstruction setSubType(RoundaboutInstruction.SubType subType)

setCompassDirection

public RoundaboutInstruction setCompassDirection(Constants.CompassDirection compassDirection)

setRoundaboutStreetName

public RoundaboutInstruction setRoundaboutStreetName(String roundaboutStreetName)

setOntoStreetName

public RoundaboutInstruction setOntoStreetName(String ontoStreetName)

setOntoFormOfWay

public RoundaboutInstruction setOntoFormOfWay(Constants.FormOfWay ontoFormOfWay)

setExitNr

public RoundaboutInstruction setExitNr(Integer exitNr)

setContinueMeters

public RoundaboutInstruction setContinueMeters(Integer continueMeters)

setContinueSeconds

public RoundaboutInstruction setContinueSeconds(Integer continueSeconds)

setContinueUntilIntersectingStreetName

public RoundaboutInstruction setContinueUntilIntersectingStreetName(String continueUntilIntersectingStreetName)

setLandmark

public RoundaboutInstruction setLandmark(Landmark landmark)

setConfirmationLandmark

public RoundaboutInstruction setConfirmationLandmark(Landmark confirmationLandmark)

createMinimalEnter

public static RoundaboutInstruction createMinimalEnter(GeoJSONCoordinate position)

createMinimalExit

public static RoundaboutInstruction createMinimalExit(GeoJSONCoordinate position)

validate

public void validate()

Description copied from interface: Validatable

Checks if the instance is in a valid / useful state. If this is not the case an IllegalArgumentException including a description of the invalid state is thrown.

Specified by:

validate in interface Validatable

Overrides:

validate in class Instruction<RoundaboutInstruction>

hashCode

public int hashCode()

Overrides:

hashCode in class Instruction<RoundaboutInstruction>

equals

public boolean equals(Object obj)

Overrides:

equals in class Instruction<RoundaboutInstruction>

toString

public String toString()

Overrides:

toString in class Instruction<RoundaboutInstruction>