es.situm.sdk.v1

Class SitumRouteCalculator

java.lang.Object

es.situm.sdk.v1.SitumRouteCalculator

Deprecated.

use DirectionsManager instead

@Deprecated
public class SitumRouteCalculator
extends java.lang.Object

Class to compute routes inside a building. Currently are two types of routes:

• Accesible Routes

This type of routes are suitable for wheelchairs, and are configured in the dashboard.

• Not accesible routes

This type of routes are not valid for wheelchairs. This is the default type of route

To create a route from this class three values are needed. We need the actual point, the destination point and if the route need to be suitable for wheel chairs. The points are SitumFloorPoints in metric coordinates

With this class also we can obtain the distance of a route and compute the nearest position in the valid path given the estimated user position.

See Also:

SitumFloorPoint

Constructor Summary

Constructors

Constructor and Description
SitumRouteCalculator() Deprecated.
SitumRouteCalculator(Building building, java.util.Collection<Floor> floors, BuildingPathGraph buildingGraph) Deprecated.

Method Summary

Modifier and Type	Method and Description
java.util.List<SitumFloorPoint>	computeRoute(SitumFloorPoint from, SitumFloorPoint to, boolean suitableforwheelchairs) Deprecated. Method to compute a route.
static float	distanceToGoal(java.util.List<SitumFloorPoint> route) Deprecated. Obtain the distance in meters to the goal of a route.
SitumFloorPoint	fitPositionToNearestPath(SitumFloorPoint position) Deprecated. Computes the nearest position in the valid path given the estimated user position.

Methods inherited from class java.lang.Object

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

Constructor Detail

SitumRouteCalculator

public SitumRouteCalculator()

Deprecated.

SitumRouteCalculator

@Deprecated
public SitumRouteCalculator(Building building,
                                        java.util.Collection<Floor> floors,
                                        BuildingPathGraph buildingGraph)

Deprecated.

Only for internal SDK use

Method Detail

distanceToGoal

public static float distanceToGoal(java.util.List<SitumFloorPoint> route)

Deprecated.

Obtain the distance in meters to the goal of a route. Note: a common value for walking speed of a human is 1m/s, therefore this function also outputs distance in seconds to goal

Parameters:

route - List of SitumFloorPoint

Returns:

distance in meters

computeRoute

public java.util.List<SitumFloorPoint> computeRoute(SitumFloorPoint from,
                                                    SitumFloorPoint to,
                                                    boolean suitableforwheelchairs)

Deprecated.

Method to compute a route. If the path graph not contains nodes then the result of calling this method is null. We want create accesible routes or not changing the suitableforwheelchairs param. Remember that the from and to params are SitumFloorPoints and the units of the x and y values are in meters

Parameters:

from - Start point of the route. Units: SitumFloorPoint(meters, meters, levelid)

to - End point of the route. Units: SitumFloorPoint(meters, meters, levelid)

suitableforwheelchairs - true if the route should be computed for wheelchairs, false otherwise

Returns:

List of SitumFloorPoint for the route. If no path found or the path is empty then return an empty list of SitumFloorPoint list

fitPositionToNearestPath

public SitumFloorPoint fitPositionToNearestPath(SitumFloorPoint position)

Deprecated.

Computes the nearest position in the valid path given the estimated user position. This method might return null if not has path. The x and y values of the given SitumFloorPoint are in meters

Parameters:

position - current position.

Returns:

nearest position to path or null if the floor has no path