Package com.here.sdk.mapdata

Class SegmentReferenceConverter

java.lang.Object

com.here.NativeBase

com.here.sdk.mapdata.SegmentReferenceConverter

public final class SegmentReferenceConverter
extends NativeBase

A SegmentReferenceConverter provides possibility to convert mapmatched instances of SegmentReference to corresponding instances of DirectedOCMSegmentId.

Note: Loading map data can be time-consuming, so SegmentReferenceConverter can be used in a background thread to avoid blocking the main thread. However, this class is not thread-safe, and each instance should be used exclusively by a single thread.

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Constructor Summary

Constructors

Constructor	Description
SegmentReferenceConverter(SDKNativeEngine sdkEngine)	Creates a new instance of this class.

Method Summary

Modifier and Type	Method	Description
DirectedLocalSegmentId	getLocalSegmentId(SegmentReference segmentReference)	The DirectedLocalSegmentId for provided SegmentReference.
DirectedOCMSegmentId	getOCMSegmentId(SegmentReference segmentReference)	Deprecated. Will be removed in v4.30.0.

Methods inherited from class java.lang.Object

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

Constructor Details

SegmentReferenceConverter

public SegmentReferenceConverter(@NonNull
 SDKNativeEngine sdkEngine)
                          throws InstantiationErrorException

Creates a new instance of this class.

Parameters:

sdkEngine -

A SDKEngine instance.

Throws:

InstantiationErrorException -

Indicates what went wrong when the instantiation was attempted.

Method Details

getOCMSegmentId

@Deprecated
@Nullable
public DirectedOCMSegmentId getOCMSegmentId(@NonNull
 SegmentReference segmentReference)

Deprecated.

Will be removed in v4.30.0. Use getLocalSegmentId() instead.

The DirectedOCMSegmentId for provided SegmentReference.

Parameters:

segmentReference -

SegmentReference to convert.

Returns:

DirectedOCMSegmentId corresponding to provided SegmentReference.

getLocalSegmentId

@Nullable
public DirectedLocalSegmentId getLocalSegmentId(@NonNull
 SegmentReference segmentReference)

The DirectedLocalSegmentId for provided SegmentReference.

Parameters:

segmentReference -

SegmentReference to convert.

Returns:

DirectedLocalSegmentId corresponding to provided SegmentReference.