com.mappedin.sdk

Class Instruction

java.lang.Object

com.mappedin.sdk.Instruction

public class Instruction
extends java.lang.Object

An instruction for a user to get from one coordinate to another. It will have a coordinate it happens at, an Action (depart, arrive, turn, take vortex), and optional Locations to perform this "at" or "towards", as well as a String representing the text instructions to display to the user. The "at/towardsLocation" properties are to let you mark or highlight key reference locations on the MapView if they will help the user find or keep their bearings.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Instruction.Action An Action is the type of thing being performed at a coordinate: Instruction.Departure, Instruction.Arrival, Instruction.Turn, or Instruction.TakeVortex.
static class	Instruction.Arrival End when you get at this Coordinate
static class	Instruction.Bearing Types of turns to take
static class	Instruction.Departure Start out leaving from this Coordinate
static class	Instruction.ExitVortex Exit a Vortex (ie: escalator, elevator, etc) used to go from one Map to another
static class	Instruction.ReferencePosition Whether a turn should occur before, after, or right at a certain landmark
static class	Instruction.TakeVortex Use a Vortex (ie: escalator, elevator, etc) to go from one Map to another
static class	Instruction.Turn Turn when you get to this Coordinate.
static class	Instruction.Walk Walk when you get at this Coordinate

Field Summary

Fields

Modifier and Type	Field and Description
Instruction.Action	action The type of thing happening at this Node
Location	atLocation A Location to display to the user, indicating where this Instruction should occur (since a Node can just be an arbitrary spot on the floor)
Coordinate	coordinate The coordinate this Instruction occurs at
java.lang.String	instruction Text instructions to display to the user

Method Summary

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

coordinate

public final Coordinate coordinate

The coordinate this Instruction occurs at

action

public final Instruction.Action action

The type of thing happening at this Node

atLocation

public final Location atLocation

A Location to display to the user, indicating where this Instruction should occur (since a Node can just be an arbitrary spot on the floor)

instruction

public final java.lang.String instruction

Text instructions to display to the user