Type Members

1.  case class AccessPoint(vertex: Vertex, fraction: Double, sideOfRoad: SideOfRoad, orientation: PointOrientation) extends ReferencingLocation with Product with Serializable

   An access point defined by a point along a LinearLocation.

   An access point defined by a point along a LinearLocation.

   vertex

   The exact vertex, part of the linear location, that the access point is.

   fraction

   A fraction (0.0;1.0) in vertex where the access point is.

   sideOfRoad

   The side of the road the access point is.

   orientation

   The orientation of the access point.

2.  case class BidirectionalLinearLocation(location: LinearLocation, oppositeLocation: Option[LinearLocation]) extends ReferencingLocation with Product with Serializable

   A linear location that has a main direction in the road network and an optional opposite linear location.

   A linear location that has a main direction in the road network and an optional opposite linear location.

   location

   representing a path in the main direction.

   oppositeLocation

   representing a path in the opposite direction.

3.  case class CircleLocation(latitude: Double, longitude: Double, radiusInMeters: Double) extends ReferencingLocation with Product with Serializable

   A location represented by a circle.

   A location represented by a circle.

   radiusInMeters

   The radius of the circle in number of meters.

4.  case class ClosedLinearLocation(path: Seq[Vertex]) extends ReferencingLocation with Product with Serializable

   A closed path in the road network expressed in the Location Library's data model.

   A closed path in the road network expressed in the Location Library's data model.

   path

   The vertices for this location. The vertices are expected to be connected and traversable in the order in which they appear.

5.  case class GeoCoordinateLocation(latitude: Double, longitude: Double) extends ReferencingLocation with GeoCoordinateHolder with Product with Serializable

   A location represented by a pair of geocoordinates.

6.  case class GridLocation(northLatitude: Double, southLatitude: Double, eastLongitude: Double, westLongitude: Double, rows: Int, columns: Int) extends ReferencingLocation with Product with Serializable

   A grid of rectangles.

   A grid of rectangles.

   A grid is defined in terms of a base rectangle and a number of rows and columns. The number of rows and columns describe how the base rectangle is replicated to define the grid. It is multiplied to the north by the the number of rows and to the east by the number of columns.

   For example (X denotes the base rectangle):

   North (rows)
       ^
       |   +-----+-----+
       | 3 |     |     |
       |   +-----+-----+
       | 2 |     |     |
       |   +-----+-----+
       | 1 |XXXXX|     |
       |   +-----+-----+
       |      1     2
       +-------------------> East (columns)
   

   rows

   The number of rows in the grid.

   columns

   The number of columns in the grid.

7.  case class LinearLocation(path: Seq[Vertex], startOffset: Double = 0.0, endOffset: Double = 1.0) extends ReferencingLocation with Product with Serializable

   A path in the road network expressed in the Location Library's data model.

   A path in the road network expressed in the Location Library's data model.

   path

   The vertices for this location. The vertices are expected to be connected and traversable in the order in which they appear.

   startOffset

   A relative offset for the first vertex, indicating where the linear location starts. It must be in the [0.0; 1.0) range. 0.0, for example, indicates that the linear location starts at the beginning of the vertex.

   endOffset

   A relative offset for the last vertex, indicating where the linear location ends. It must be in the (0.0; 1.0] range. 1.0, for example, indicates that the whole vertex is part of the location.

8.  trait LocationReferenceCreator[L, LR] extends AnyRef

   Creates location references from locations.

   Creates location references from locations.

   Instances of LocationReferenceCreator can be obtained using the factory object LocationReferenceCreators.

   L

   Location type

   LR

   Location Reference type

9.  trait LocationReferenceCreatorException extends Exception with LocationReferenceException

   A basic type to represent errors that happened when creating location references.

10.  class LocationReferenceCreators extends AnyRef

    Provides LocationReferenceCreators factories to create different location reference types from Location Library data model specific representations.

11.  sealed trait LocationReferenceException extends Exception

    A basic type to represent errors that happened when creating or resolving location references.

12.  trait LocationReferenceResolver[LR, R] extends AnyRef

    Represents a way of resolving location references into map-specific representations.

    Represents a way of resolving location references into map-specific representations.

    Instances of LocationReferenceResolver can be obtained using the factory object LocationReferenceResolvers.

    LR

    Location Reference type

    R

    Resolved type

13.  trait LocationReferenceResolverException extends Exception with LocationReferenceException

    A basic type to represent errors that happened when resolving location references.

14.  class LocationReferenceResolvers extends AnyRef

    Provides LocationReferenceResolvers factories to resolve different location reference types into Location Library data model specific representations.

15.  class LocationReferencingPropertyMaps extends AnyRef

    Provides com.here.platform.location.core.graph.PropertyMap factories for location referencing reference data.

16.  class OlrLayers extends AnyRef
17.  class OlrLocationReferenceCreators extends AnyRef

    Provides LocationReferenceCreators factories to create different Olr location reference types from Location Library data model specific representations.

18.  class OlrLocationReferenceResolvers extends AnyRef

    Provides LocationReferenceResolvers factories to resolve different location reference types into Location Library data model specific representations.

19.  case class PointOfInterest(point: GeoCoordinate, accessPoint: AccessPoint, pathToPoint: Seq[GeoCoordinate]) extends ReferencingLocation with Product with Serializable

    A geocoordinate based point of interest (POI).

    A geocoordinate based point of interest (POI).

    point

    The geocoordinates of the POI.

    accessPoint

    The access point for the POI.

    pathToPoint

    The path between the access point and the POI's geocoordinates.

20.  sealed trait PointOrientation extends AnyRef

    The orientation of an event in the road.

    The orientation of an event in the road.

    The event can be in the direction of the line, against the direction of the line, in both directions, or declared as unknown.

21.  case class PolygonLocation(points: Seq[GeoCoordinate]) extends ReferencingLocation with LinearRingHolder[GeoCoordinate] with Product with Serializable

    A location surrounded by a sequence of points given as geocoordinates.

    A location surrounded by a sequence of points given as geocoordinates.

    The polygon is formed by straight lines between each consecutive pair of geopoints. The first and last geopoints also form a pair. A polygon should be formed by at least three geopoints.

    points

    At least three geopoints that form the polygon.

22.  case class RectangleLocation(northLatitude: Double, southLatitude: Double, eastLongitude: Double, westLongitude: Double) extends ReferencingLocation with BoundingBoxHolder with Product with Serializable

    A location represented by a bounding-box.

23.  sealed trait ReferencingLocation extends AnyRef

    An abstract location using the Location Library's data model.

    An abstract location using the Location Library's data model.

    Locations can be anything that includes a geo-spatial component, such as points, lines, roads, sequences of roads or polygons.

24.  sealed trait SideOfRoad extends AnyRef

    The side of the road of an event.

    The side of the road of an event.

    The event can be on the right side, on the left, on both sides, or declared as unknown.

25.  class TmcLayers extends AnyRef
26.  class TmcLocationReferenceCreators extends AnyRef

    Provides LocationReferenceCreators factories to create Tmc location reference types from Location Library data model specific representations.

27.  class TmcLocationReferenceResolvers extends AnyRef

    Provides LocationReferenceResolvers factories to resolve different location reference types into Location Library data model specific representations.