com.here.platform.location.referencing
LocationReferenceCreators
Companion class LocationReferenceCreators
object LocationReferenceCreators
Provides LocationReferenceCreators factories to create different location reference types from Location Library data model specific representations.
- Alphabetic
- By Inheritance
- LocationReferenceCreators
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def apply(optimizedMap: OptimizedMapLayers, adjacencyProvider: TmcAdjacencyProvider): LocationReferenceCreators
- def apply(optimizedMap: OptimizedMapLayers): LocationReferenceCreators
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
olrCircle: LocationReferenceCreator[CircleLocation, CircleLocationReference]
Generates a creator for com.here.platform.location.tpeg2.olr.CircleLocationReference.
Generates a creator for com.here.platform.location.tpeg2.olr.CircleLocationReference.
A circle location is given by a geo-location of the center of the circle and its radius.
Real-world examples include a Wi-Fi hotspot with its signal range, or the center and radius used with a proximity search.
This reference type is disconnected from the road network, and does not require a catalog to be created.
-
def
olrGeoCoordinate[GC](implicit arg0: GeoCoordinateOperations[GC]): LocationReferenceCreator[GC, GeoCoordinateLocationReference]
Generates a creator for com.here.platform.location.tpeg2.olr.GeoCoordinateLocationReference.
Generates a creator for com.here.platform.location.tpeg2.olr.GeoCoordinateLocationReference.
This creator converts WGS84 coordinates to OLR geocoordinates represented by integer values.
This reference type is disconnected from the road network, and does not require a catalog to be created.
-
def
olrGeoCoordinate: LocationReferenceCreator[GeoCoordinateLocation, GeoCoordinateLocationReference]
Generates a creator for com.here.platform.location.tpeg2.olr.GeoCoordinateLocationReference.
Generates a creator for com.here.platform.location.tpeg2.olr.GeoCoordinateLocationReference.
This creator converts WGS84 coordinates to OLR geocoordinates represented by integer values.
This reference type is disconnected from the road network, and does not require a catalog to be created.
-
def
olrGrid: LocationReferenceCreator[GridLocation, GridLocationReference]
Generates a creator for com.here.platform.location.tpeg2.olr.GridLocationReference.
Generates a creator for com.here.platform.location.tpeg2.olr.GridLocationReference.
Grid locations are defined in terms of a base rectangle location and a number of rows and columns. The base rectangle is multiplied to the north by the the number of rows and to the east by the number of columns.
Weather reports are a real-world example for this reference type. For instance, average rainfall could be defined for every cell of the grid.
This reference type is disconnected from the road network, and does not require a catalog to be created.
-
def
olrPolygon[LR](implicit arg0: LinearRingOperations[LR]): LocationReferenceCreator[LR, PolygonLocationReference]
Generates a creator for com.here.platform.location.tpeg2.olr.PolygonLocationReference.
Generates a creator for com.here.platform.location.tpeg2.olr.PolygonLocationReference.
A polygon location is a non-intersecting shape defined by a sequence of geocoordinate pairs. It can be used to represent any complex area in the map, like a low emission zone, or an area where traffic is overloaded.
This reference type is disconnected from the road network, and does not require a catalog to be created.
-
def
olrPolygon: LocationReferenceCreator[PolygonLocation, PolygonLocationReference]
Generates a creator for com.here.platform.location.tpeg2.olr.PolygonLocationReference.
Generates a creator for com.here.platform.location.tpeg2.olr.PolygonLocationReference.
A polygon location is a non-intersecting shape defined by a sequence of geocoordinate pairs. It can be used to represent any complex area in the map, like a low emission zone, or an area where traffic is overloaded.
This reference type is disconnected from the road network, and does not require a catalog to be created.
-
def
olrRectangle[BB](implicit arg0: BoundingBoxOperations[BB]): LocationReferenceCreator[BB, RectangleLocationReference]
Generates a creator for com.here.platform.location.tpeg2.olr.RectangleLocationReference.
Generates a creator for com.here.platform.location.tpeg2.olr.RectangleLocationReference.
A rectangle location reference is based on rectangular shapes and is defined in terms of a pair of geopoints, defining north/south latitude limits, and east/west longitude limits.
This reference type is disconnected from the road network, and does not require a catalog to be created.
-
def
olrRectangle: LocationReferenceCreator[RectangleLocation, RectangleLocationReference]
Generates a creator for com.here.platform.location.tpeg2.olr.RectangleLocationReferences.
Generates a creator for com.here.platform.location.tpeg2.olr.RectangleLocationReferences.
A rectangle location reference is based on rectangular shapes and is defined in terms of a pair of geopoints, defining north/south latitude limits, and east/west longitude limits.
This reference type is disconnected from the road network, and does not require a catalog to be created.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
Deprecated Value Members
-
def
extendedTmcV2(optimizedMap: Catalog, cacheManager: DataLoaderProvider, adjacencyProvider: TmcAdjacencyProvider = ThrowingTmcAdjacencyProvider): LocationReferenceCreator[LinearLocation, ExtendedTMCLocationReference]
Generates a creator for com.here.platform.location.tpeg2.etl.ExtendedTMCLocationReferences.
Generates a creator for com.here.platform.location.tpeg2.etl.ExtendedTMCLocationReferences.
This reference creator takes a
LinearLocation
and returns an extended TMC location reference. The extended TMC reference will havepreciseTMCInfo
populated to match theLinearLocation
that was passed in. The resolution of the produced com.here.platform.location.tpeg2.etl.PreciseTMCInformation is 100m. The rounding is done in such a way that the TMC reference covers the full linear location, so it might be up to 100m longer at each end.This creator will always return com.here.platform.location.tpeg2.etl.ExtendedTMCLocationReferences that contain a
tmcLocation
, not atmcExitEntryLocation
.Because TMC relies on pre-coded, shared location tables, it is possible that a LinearLocation can not be encoded in TMC. In such cases the creator will throw a com.here.platform.location.referencing.tmc.TmcCreatorException.
For details on how TMC works, see the Developer Guide.
Note that without passing in a valid
adjacencyProvider
this API only supports creating references withextent
<= 1.The creator will fail if with a com.here.platform.location.referencing.tmc.NoLinearAvailableException if the given location is not fully covered by the same location code.
- optimizedMap
An Optimized Map for Location Library instance.
- adjacencyProvider
Provides information about TMC location adjacency to support creation of references with
extent
> 1.
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version SDK 2.54) Use methods based on OptimizedMapLayers instead.
-
def
olr(optimizedMap: Catalog, cacheManager: DataLoaderProvider): LocationReferenceCreator[ReferencingLocation, OpenLRLocationReference]
Generates a creator for com.here.platform.location.tpeg2.olr.OpenLRLocationReferences from com.here.platform.location.referencing.ReferencingLocations.
Generates a creator for com.here.platform.location.tpeg2.olr.OpenLRLocationReferences from com.here.platform.location.referencing.ReferencingLocations.
This creator chooses the correct type of OpenLR reference depending on the actual subtype of com.here.platform.location.referencing.ReferencingLocation that is being passed in.
- optimizedMap
An Optimized Map for Location Library instance
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version SDK 2.54) Use methods based on OptimizedMapLayers instead.
-
def
olrClosedLinear(optimizedMap: Catalog, cacheManager: DataLoaderProvider): LocationReferenceCreator[ClosedLinearLocation, ClosedLinearLocationReference]
Generates a creator for com.here.platform.location.tpeg2.olr.ClosedLinearLocationReferences.
Generates a creator for com.here.platform.location.tpeg2.olr.ClosedLinearLocationReferences.
A
ClosedLinearLocationReference
refers to a closed path in the road network and thus needs to be created against a map.- optimizedMap
An Optimized Map for Location Library instance.
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version SDK 2.54) Use methods based on OptimizedMapLayers instead.
-
def
olrLinear(optimizedMap: Catalog, cacheManager: DataLoaderProvider): LocationReferenceCreator[LinearLocation, LinearLocationReference]
Generates a creator for com.here.platform.location.tpeg2.olr.LinearLocationReferences.
Generates a creator for com.here.platform.location.tpeg2.olr.LinearLocationReferences.
As a
LinearLocationReference
refers to a path in the road network, you need to create this reference against a map.- optimizedMap
An Optimized Map for Location Library instance.
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version SDK 2.54) Use methods based on OptimizedMapLayers instead.
-
def
olrPoiWithAccessPoint(optimizedMap: Catalog, cacheManager: DataLoaderProvider): LocationReferenceCreator[PointOfInterest, POIWithAccessPointLocationReference]
Generates a creator for com.here.platform.location.tpeg2.olr.POIWithAccessPointLocationReferences.
Generates a creator for com.here.platform.location.tpeg2.olr.POIWithAccessPointLocationReferences.
A
POIWithAccessPointLocationReference
refers to an access point on a road section and thus needs to be created against a map.- optimizedMap
An Optimized Map for Location Library instance.
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version SDK 2.54) Use methods based on OptimizedMapLayers instead.
-
def
olrPointAlongLine(optimizedMap: Catalog, cacheManager: DataLoaderProvider): LocationReferenceCreator[AccessPoint, PointAlongLineLocationReference]
Generates a creator for com.here.platform.location.tpeg2.olr.PointAlongLineLocationReferences.
Generates a creator for com.here.platform.location.tpeg2.olr.PointAlongLineLocationReferences.
A
PointAlongLineLocationReference
refers to a point on a road section and thus needs to be created against a map.- optimizedMap
An Optimized Map for Location Library instance.
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version SDK 2.54) Use methods based on OptimizedMapLayers instead.
-
def
piecewiseExtendedTmcV2(optimizedMap: Catalog, cacheManager: DataLoaderProvider, adjacencyProvider: TmcAdjacencyProvider = EmptyTmcAdjacencyProvider): LocationReferenceCreator[LinearLocation, PiecewiseTmcCoverage]
Generates a creator for com.here.platform.location.referencing.tmc.PiecewiseTmcCoverage.
Generates a creator for com.here.platform.location.referencing.tmc.PiecewiseTmcCoverage.
Because TMC relies on pre-coded, shared location tables, it is possible that a LinearLocation can not be encoded or not fully encoded in TMC.
This reference creator takes a LinearLocation and returns the potentially piecewise TMC coverage for those parts of the given
LinearLocation
that can be encoded into TMC.The extended TMC references will have
preciseTMCInfo
populated to match the LinearLocation that was passed in. The resolution of the producedpreciseTMCInfo
is 100m. The rounding is done in such a way that the TMC reference covers the full linear location, so it might be up to 100m longer at each end.This creator will always return com.here.platform.location.referencing.tmc.PiecewiseTmcCoverages that contain com.here.platform.location.tpeg2.etl.TMCLocationReferences, not com.here.platform.location.tpeg2.etl.TMCExitEntryLocationReferences.
For details on how TMC works, see the Developer Guide.
Note that without passing in a valid
adjacencyProvider
this API only supports creating references withextent
<= 1.If no adjacencyProvider is given, the creator will create multiple location references, one reference for each location code on the path.
- optimizedMap
An Optimized Map for Location Library instance.
- adjacencyProvider
Provides information about TMC location adjacency to support creation of references with
extent
> 1.
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version SDK 2.54) Use methods based on OptimizedMapLayers instead.
-
def
tmc(optimizedMap: Catalog, cacheManager: DataLoaderProvider, adjacencyProvider: TmcAdjacencyProvider = ThrowingTmcAdjacencyProvider): LocationReferenceCreator[LinearLocation, TMCLocationReference]
Generates a creator for simple com.here.platform.location.tpeg2.tmc.TMCLocationReferences.
Generates a creator for simple com.here.platform.location.tpeg2.tmc.TMCLocationReferences.
This reference creator takes a LinearLocation and returns a simple TMC location reference. The simple TMC reference will have
preciseTMCInfo
populated to match the LinearLocation that was passed in. The resolution of the produced com.here.platform.location.tpeg2.etl.PreciseTMCInformation is 100m. The rounding is done in such a way that the TMC reference covers the full linear location, so it might be up to 100m longer at each end.Because TMC relies on pre-coded, shared location tables, it is possible that a LinearLocation can not be encoded in TMC. In such cases the creator will throw a com.here.platform.location.referencing.tmc.TmcCreatorException.
For details on how TMC works, see the Developer Guide.
Note that without passing in a valid
adjacencyProvider
this API only supports creating references withextent
<= 1.The creator will fail if with a com.here.platform.location.referencing.tmc.NoLinearAvailableException if the given location is not fully covered by the same location code.
- optimizedMap
An Optimized Map for Location Library instance.
- adjacencyProvider
Provides information about TMC location adjacency to support creation of references with
extent
> 1.
- Annotations
- @Deprecated @deprecated
- Deprecated
(Since version SDK 2.54) Use methods based on OptimizedMapLayers instead.