Package org.eclipse.mosaic.fed.application.app.api.navigation

Interface RoutingModule

All Known Implementing Classes:
RoutingNavigationModule
public interface RoutingModule
Interface to access road routing functionalities for server or road side units. The offered methods, for example, provide route calculation from a provided source to a provided target location.
In contrast to NavigationModule, a RoutingModule can only calculate routes, but is not able to switch to calculated routes. Thus, the RoutingModule can be used in server units to emulate central routíng service functionalities.

  • Method Details

    • calculateRoutes

      RoutingResponse calculateRoutes(RoutingPosition sourcePosition, RoutingPosition targetPosition, RoutingParameters routingParameters)
      Calculates one or more routes from the position of the vehicle to the given target location.
      Parameters:
      sourcePosition - The source position of the required route.
      targetPosition - The target position of the required route.
      routingParameters - Properties defining the way routes are calculated (e.g. number of routes, weighting).
      Returns:
      The response including a set of routes towards the target.

    • getNode

      INode getNode(String nodeId)
      Returns the node object identified by the given nodeId.
      Parameters:
      nodeId - The id of the requested node.
      Returns:
      The node object identified by the given nodeId.

    • getConnection

      IConnection getConnection(String connection)
      Returns data for the specified connection id.
      Parameters:
      connection - the id of the node
      Returns:
      the IConnection containing data for the specified connection id.

    • getClosestNode

      INode getClosestNode(GeoPoint geoPoint)
      Returns the node object, which is closest to the given GeoPoint.
      Parameters:
      geoPoint - The geographical location to search a node for.
      Returns:
      The node object, which is closest to the given location.

    • getClosestRoadPosition

      IRoadPosition getClosestRoadPosition(GeoPoint geoPoint)
      Returns the road position, which is closest to the given GeoPoint.
      Parameters:
      geoPoint - The geographical location to search a road position for.
      Returns:
      The road position, which is closest to the given location.

    • getClosestRoadPosition

      IRoadPosition getClosestRoadPosition(GeoPoint geoPoint, double heading)
      Returns the road position, which is closest to the given GeoPoint. If two adjacent edges overlap, the heading will be used as a similarity measure.
      Parameters:
      geoPoint - The geographical location to search a road position for.
      heading - used as a measure of similarity if multiple edges match
      Returns:
      The road position, which is closest to the given location.