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

Interface NavigationModule

All Known Implementing Classes:
RoutingNavigationModule
public interface NavigationModule
Interface to access navigational functions of the vehicle. As one part, it offers methods to calculate routes from the current position of the vehicle to a provided target location.

  • Method Details

    • calculateRoutes

      RoutingResponse calculateRoutes(RoutingPosition targetPosition, RoutingParameters routingParameters)
      Calculates one or more routes from the position of the vehicle to the given target location.
      Parameters:
      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.

    • calculateRoutes

      RoutingResponse calculateRoutes(GeoPoint targetGeoPoint, RoutingParameters routingParameters)
      Calculates one or more routes from the position of the vehicle to the given target GeoPoint given as geographical location.
      Parameters:
      targetGeoPoint - The target position of the required route given as GeoPoint.
      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.

    • switchRoute

      boolean switchRoute(CandidateRoute route)
      Switch to a specific route.
      Parameters:
      route - The route to switch to.
      Returns:
      boolean whether route is switched.

    • getCurrentRoute

      VehicleRoute getCurrentRoute()
      Returns the current route.
      Returns:
      the route the vehicle is currently driving on

    • getTargetPosition

      GeoPoint getTargetPosition()
      Returns the target position of the vehicle.
      Returns:
      The target position of the vehicle.

    • getCurrentPosition

      GeoPoint getCurrentPosition()
      Returns the current position of the vehicle.
      Returns:
      The current position of the vehicle.

    • getRoadPosition

      IRoadPosition getRoadPosition()
      Returns the road position the vehicle is currently driving on.
      Returns:
      The road position the vehicle is currently driving on.

    • getDistanceToNodeOnRoute

      double getDistanceToNodeOnRoute(String nodeId)
      Returns the distance in m to the specified node.
      Returns:
      The distance in m to the specified node.

    • getNextJunctionNode

      INode getNextJunctionNode()
      Returns next node that is a junction on the vehicle's current route.
      Returns:
      Next node that is a junction on the vehicle's current route.

    • getNextTrafficLightNode

      INode getNextTrafficLightNode()
      Returns next node that has a traffic light on the vehicle's current route.
      Returns:
      Next node that has a traffic light on the vehicle's current route.

    • getVehicleData

      @Nullable VehicleData getVehicleData()
      Returns the current vehicle information.
      Returns:
      the current vehicle information.

    • getNode

      INode getNode(String node)
      Returns data for the specified node id.
      Parameters:
      node - the id of the node
      Returns:
      the INode containing data for the specified node id.

    • 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 which is closest to specified GeoPoint.
      Parameters:
      geoPoint - the geographic position to search a node for
      Returns:
      the closest INode

    • getClosestRoadPosition

      IRoadPosition getClosestRoadPosition(GeoPoint geoPoint)
      Returns the road position (i.e. an edge) which is closest to specified GeoPoint
      Parameters:
      geoPoint - the geographic position to search a road position for
      Returns:
      the closest IRoadPosition

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