at.ac.ait.ariadne.routeformat.instruction

Class RoadCrossingInstruction

java.lang.Object

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

at.ac.ait.ariadne.routeformat.instruction.RoadCrossingInstruction

All Implemented Interfaces:

Validatable

public class RoadCrossingInstruction
extends Instruction<RoadCrossingInstruction>

Instructions for crossing a road or several roads that are close together. Typically relevant for foot and bicycle traffic using zebra crossings or bicycle crossings.

For the simple case just switching the side of a road see RoadInstruction.SubType.SWITCH_SIDE_OF_ROAD.

This instruction deliberately has no continue-part as it only covers a more or less complex crossing and should directly be followed by a RoadInstruction which then explains where to turn / continue after the crossing.

Examples:

• At the POI go straight over the zebra crossing
• Before the church go slight left over the traffic light.

In its minimal form it consists of a position and a turn direction.

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).

 
 ROAD_CROSSING_INSTRUCTION = [LANDMARK_PART], DIRECTION, "over the", [ROAD_CROSSING];
 LANDMARK_PART = PREPOSITION, "the", LANDMARK_STRING;
 PREPOSITION = "before" | "at" | "after";
 DIRECTION = STRAIGHT | ("turn", TURN_DIRECTION);
 STRAIGHT = "go straight";
 TURN_DIRECTION = ["slight"], ("left" | "right");
 ROAD_CROSSING = "crossing" | "zebra crossing" | "traffic light";
 
 

Author:

AIT Austrian Institute of Technology GmbH

Constructor Summary

Constructors

Constructor and Description
RoadCrossingInstruction()

Method Summary

Modifier and Type	Method and Description
static RoadCrossingInstruction	createMinimal(GeoJSONCoordinate position, Constants.TurnDirection turnDirection)
boolean	equals(Object obj)
Optional<Landmark>	getLandmark()
Optional<Constants.RoadCrossing>	getRoadCrossing()
Constants.TurnDirection	getTurnDirection()
int	hashCode()
RoadCrossingInstruction	setLandmark(Landmark landmark)
RoadCrossingInstruction	setRoadCrossing(Constants.RoadCrossing roadCrossing)
RoadCrossingInstruction	setTurnDirection(Constants.TurnDirection turnDirection)
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

RoadCrossingInstruction

public RoadCrossingInstruction()

Method Detail

getTurnDirection

public Constants.TurnDirection getTurnDirection()

getLandmark

public Optional<Landmark> getLandmark()

getRoadCrossing

public Optional<Constants.RoadCrossing> getRoadCrossing()

setTurnDirection

public RoadCrossingInstruction setTurnDirection(Constants.TurnDirection turnDirection)

setLandmark

public RoadCrossingInstruction setLandmark(Landmark landmark)

setRoadCrossing

public RoadCrossingInstruction setRoadCrossing(Constants.RoadCrossing roadCrossing)

createMinimal

public static RoadCrossingInstruction createMinimal(GeoJSONCoordinate position,
                                                    Constants.TurnDirection turnDirection)

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<RoadCrossingInstruction>

hashCode

public int hashCode()

Overrides:

hashCode in class Instruction<RoadCrossingInstruction>

equals

public boolean equals(Object obj)

Overrides:

equals in class Instruction<RoadCrossingInstruction>

toString

public String toString()

Overrides:

toString in class Instruction<RoadCrossingInstruction>