Package com.here.sdk.routing

Class RouteOffset

  • java.lang.Object
    • com.here.sdk.routing.RouteOffset
  • public final class RouteOffset
extends java.lang.Object

    Represents a specific location along the route. A RouteOffset is a location on the route defined by the section index and the distance in meters from the start of that section to the specified location on the route. An offset in meters indicates the distance that needs to be traveled to reach a specific location along the route, such as a railway crossing. For the latter case, the location of a railway crossing can be retrieved from RouteRailwayCrossing.coordinates.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      double offsetInMeters
      Offset from the start of the indexed Section to the specified location along the route.
      int sectionIndex
      Index of the corresponding route Section.

    • Constructor Summary

      Constructors 
      Constructor Description
      RouteOffset​(int sectionIndex, double offsetInMeters)
      Creates a new instance.

    • Method Summary

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • sectionIndex

        public int sectionIndex

        Index of the corresponding route Section. The start of the section indicates the start of the offset.

      • offsetInMeters

        public double offsetInMeters

        Offset from the start of the indexed Section to the specified location along the route. The maximum possible offset is limited by the length of the section and cannot exceed it.

    • Constructor Detail

      • RouteOffset

        public RouteOffset​(int sectionIndex,
                   double offsetInMeters)

        Creates a new instance.

        Parameters:
        sectionIndex -

        Index of the corresponding route Section. The start of the section indicates the start of the offset.

        offsetInMeters -

        Offset from the start of the indexed Section to the specified location along the route. The maximum possible offset is limited by the length of the section and cannot exceed it.