Package com.here.platform.location.referencing.javadsl

Class TmcLocationReferenceCreators

java.lang.Object

com.here.platform.location.referencing.javadsl.TmcLocationReferenceCreators

public class TmcLocationReferenceCreators
extends Object

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

Constructor Summary

Constructors

Constructor	Description
TmcLocationReferenceCreators(TmcLayers tmcLayers)
TmcLocationReferenceCreators(TmcLayers tmcLayers, TmcAdjacencyProvider adjacencyProvider)

Method Summary

Modifier and Type	Method	Description
LocationReferenceCreator<LinearLocation,ExtendedTMCLocationReference>	extendedTmc()	Generates a creator for ExtendedTMCLocationReferences.
static LocationReferenceCreator<LinearLocation,ExtendedTMCLocationReference>	extendedTmc(PropertyMap<Vertex,Double> length, DirectedGraph<Vertex,Edge> graph, PropertyMap<TrafficMessageChannelCode,Optional<LinearLocation>> tmcCodesToLinearLocations, RangeBasedPropertyMap<Vertex,Set<TrafficMessageChannelCode>> trafficMessageChannelCodes, Optional<TmcAdjacencyProvider> adjacencyProvider)	Generates a creator for ExtendedTMCLocationReferences.
LocationReferenceCreator<LinearLocation,PiecewiseTmcCoverage>	piecewiseExtendedTmc()	Generates a creator for PiecewiseTmcCoverage.
static LocationReferenceCreator<LinearLocation,PiecewiseTmcCoverage>	piecewiseExtendedTmc(PropertyMap<Vertex,Double> length, DirectedGraph<Vertex,Edge> graph, PropertyMap<TrafficMessageChannelCode,Optional<LinearLocation>> tmcCodesToLinearLocations, RangeBasedPropertyMap<Vertex,Set<TrafficMessageChannelCode>> trafficMessageChannelCodes, Optional<TmcAdjacencyProvider> adjacencyProvider)	Generates a creator for PiecewiseTmcCoverage.
LocationReferenceCreator<LinearLocation,TMCLocationReference>	tmc()	Generates a creator for simple TMCLocationReferences.
static LocationReferenceCreator<LinearLocation,TMCLocationReference>	tmc(PropertyMap<Vertex,Double> length, DirectedGraph<Vertex,Edge> graph, PropertyMap<TrafficMessageChannelCode,Optional<LinearLocation>> tmcCodesToLinearLocations, RangeBasedPropertyMap<Vertex,Set<TrafficMessageChannelCode>> trafficMessageChannelCodes, Optional<TmcAdjacencyProvider> adjacencyProvider)	Generates a creator for simple TMCLocationReferences.

Methods inherited from class java.lang.Object

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

Constructor Details

TmcLocationReferenceCreators

public TmcLocationReferenceCreators(TmcLayers tmcLayers)

TmcLocationReferenceCreators

public TmcLocationReferenceCreators(TmcLayers tmcLayers,
 TmcAdjacencyProvider adjacencyProvider)

Method Details

tmc

public LocationReferenceCreator<LinearLocation,TMCLocationReference> tmc()

Generates a creator for simple 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 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 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 with extent < 1. If no adjacencyProvider is given, the creator will fail with a NoLinearAvailableException if the given location is not fully covered by the same location code.

extendedTmc

public LocationReferenceCreator<LinearLocation,ExtendedTMCLocationReference> extendedTmc()

Generates a creator for ExtendedTMCLocationReferences.

This reference creator takes a LinearLocation and returns an extended TMC location reference. The extended TMC reference will have preciseTMCInfo populated to match the LinearLocation that was passed in. The resolution of the produced 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 ExtendedTMCLocationReferences that contain a tmcLocation, not a tmcExitEntryLocation.

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

For details on how TMC works, see the Developer Guide.

Note that this method has the same behavior as the corresponding V2 static method.

Note that without passing in a valid adjacencyProvider this API only supports creating references with extent < 1. If no adjacencyProvider is given, the creator will fail with a NoLinearAvailableException if the given location is not fully covered by the same location code.

piecewiseExtendedTmc

public LocationReferenceCreator<LinearLocation,PiecewiseTmcCoverage> piecewiseExtendedTmc()

Generates a creator for 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 produced preciseTMCInfo 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 PiecewiseTmcCoverages that contain TMCLocationReferences, not 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 with extent < 1. If no adjacencyProvider is given, the creator will create multiple location references, one reference for each location code on the path.

Note that this method has the same behavior as the corresponding V2 static method.

tmc

public static LocationReferenceCreator<LinearLocation,TMCLocationReference> tmc(PropertyMap<Vertex,Double> length,
 DirectedGraph<Vertex,Edge> graph,
 PropertyMap<TrafficMessageChannelCode,Optional<LinearLocation>> tmcCodesToLinearLocations,
 RangeBasedPropertyMap<Vertex,Set<TrafficMessageChannelCode>> trafficMessageChannelCodes,
 Optional<TmcAdjacencyProvider> adjacencyProvider)

Generates a creator for simple 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 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 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 with extent < 1. If no adjacencyProvider is given, the creator will fail with a NoLinearAvailableException if the given location is not fully covered by the same location code.

extendedTmc

public static LocationReferenceCreator<LinearLocation,ExtendedTMCLocationReference> extendedTmc(PropertyMap<Vertex,Double> length,
 DirectedGraph<Vertex,Edge> graph,
 PropertyMap<TrafficMessageChannelCode,Optional<LinearLocation>> tmcCodesToLinearLocations,
 RangeBasedPropertyMap<Vertex,Set<TrafficMessageChannelCode>> trafficMessageChannelCodes,
 Optional<TmcAdjacencyProvider> adjacencyProvider)

Generates a creator for ExtendedTMCLocationReferences.

This reference creator takes a LinearLocation and returns an extended TMC location reference. The extended TMC reference will have preciseTMCInfo populated to match the LinearLocation that was passed in. The resolution of the produced 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 ExtendedTMCLocationReferences that contain a tmcLocation, not a tmcExitEntryLocation.

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

For details on how TMC works, see the Developer Guide.

Note that this method has the same behavior as the corresponding V2 static method.

Note that without passing in a valid adjacencyProvider this API only supports creating references with extent < 1. If no adjacencyProvider is given, the creator will fail with a NoLinearAvailableException if the given location is not fully covered by the same location code.

piecewiseExtendedTmc

public static LocationReferenceCreator<LinearLocation,PiecewiseTmcCoverage> piecewiseExtendedTmc(PropertyMap<Vertex,Double> length,
 DirectedGraph<Vertex,Edge> graph,
 PropertyMap<TrafficMessageChannelCode,Optional<LinearLocation>> tmcCodesToLinearLocations,
 RangeBasedPropertyMap<Vertex,Set<TrafficMessageChannelCode>> trafficMessageChannelCodes,
 Optional<TmcAdjacencyProvider> adjacencyProvider)

Generates a creator for 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 produced preciseTMCInfo 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 PiecewiseTmcCoverages that contain TMCLocationReferences, not 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 with extent < 1. If no adjacencyProvider is given, the creator will create multiple location references, one reference for each location code on the path.

Note that this method has the same behavior as the corresponding V2 static method.