com.oym.indoor

Class Instruction

java.lang.Object

com.oym.indoor.Instruction

public class Instruction
extends java.lang.Object

This class defines an instruction to be used in the routing

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Instruction.InstructionType Enumeration containing all the instructions

Field Summary

Fields

Modifier and Type	Field and Description
Indicator	destination
double	distance Distance from the start point
Instruction.InstructionType	instruction Instruction to apply at that distance
Indicator	orientation
java.util.HashMap<java.lang.String,java.lang.String>	props Values retrieved for the instruction

Constructor Summary

Constructors

Constructor and Description
Instruction(double distance, Instruction.InstructionType instruction, java.util.HashMap<java.lang.String,java.lang.String> props) Instruction constructor.

Method Summary

Modifier and Type	Method and Description
int	getFloorNumber() Getter for the floor number.
int	getTurnAngle() Getter for the turn angle.
java.lang.String	toJson() This method provides compatibility by returning relevant info into a JSON String.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

distance

public final double distance

Distance from the start point

instruction

public final Instruction.InstructionType instruction

Instruction to apply at that distance

props

public final java.util.HashMap<java.lang.String,java.lang.String> props

Values retrieved for the instruction

orientation

public Indicator orientation

destination

public Indicator destination

Constructor Detail

Instruction

public Instruction(double distance,
                   Instruction.InstructionType instruction,
                   java.util.HashMap<java.lang.String,java.lang.String> props)

Instruction constructor.

Parameters:

distance - Distance from the start point

instruction - Instruction to apply at that distance

props - Hashmap including extra values to complete the instruction

Method Detail

toJson

public java.lang.String toJson()

This method provides compatibility by returning relevant info into a JSON String.

Returns:

A JSON String including the encoded info, null if an error occurs

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getFloorNumber

public int getFloorNumber()

Getter for the floor number.

Returns:

The floor number, 0 if not available

getTurnAngle

public int getTurnAngle()

Getter for the turn angle.

Returns:

The turn angle in degrees, 0 if not available