HERE Android SDK Developer's Guide

StreetLevelCoverage

The class StreetLevelCoverage is a member of com.here.android.mpa.streetlevel .

Class Summary

public final class StreetLevelCoverage

extends java.lang.Object

Represents a class to determine whether specific areas of a map are covered for street level imagery.

[For complete information, see the section Class Details]

Nested Class Summary

Table 1. Nested Classes in StreetLevelCoverage
Nested Classes

public static abstract interface StreetLevelCoverage.Listener

Represents a listener to provide notification upon completion of a StreetLevelCoverage operation.

public static final enumeration StreetLevelCoverage.ResultCode

Represents values describing possible result types of the coverage check operation

Constructor Summary

Table 2. Constructors in StreetLevelCoverage
Constructors

StreetLevelCoverage ()

Public constructor.

Method Summary

Table 3. Methods in StreetLevelCoverage
Methods

public void cancel (GeoCoordinate geoCoordinate)

Cancel coverage check at GeoCoordinate GeoCoordinate, if still pending.

public boolean checkInCoverageZone (GeoCoordinate geoCoordinate, int radius, boolean useAbsoluteCoverageCheck, Listener listener)

Determines whether the specified GeoCoordinate GeoCoordinate is within the street level coverage zone.

public long getTimeoutLimit ()

Gets a timeout value in milliseconds for coverage check when an outstanding request should be cancelled.

public void setTimeoutLimit (long value)

Sets a timeout value in milliseconds for coverage check when an outstanding request should be cancelled.

Class Details

Represents a class to determine whether specific areas of a map are covered for street level imagery.

Constructor Details

StreetLevelCoverage ()

Public constructor.

Throws:

  • AccessControlException

    Access to this operation is denied. Contact your HERE representative for more information.

Method Details

public void cancel (GeoCoordinate geoCoordinate)

Cancel coverage check at GeoCoordinate GeoCoordinate, if still pending.

Parameters:

  • geoCoordinate

    The location where coverage-check should be cancelled

public boolean checkInCoverageZone (GeoCoordinate geoCoordinate, int radius, boolean useAbsoluteCoverageCheck, Listener listener)

Determines whether the specified GeoCoordinate GeoCoordinate is within the street level coverage zone.

Note: use the onCoverageCheckCompleted(GeoCoordinate, int, StreetLevelCoverage.ResultCode) callback to get the result.

Parameters:

  • geoCoordinate

    A GeoCoordinate to check for containment within the coverage zone

  • radius

    A int representing the radius in meters

  • useAbsoluteCoverageCheck

    This argument (when true) performs a precise street level coverage check. When enabled, additional map data maybe downloaded which may increase the time to perform the check. It is recommended the absolute coverage check be performed at high zoom levels (close to streel level) or when an accurate coverage check is required. At low zoom levels or when an approximate coverage check is needed, pass false.

  • listener

    Callback listener.

Returns:

True if coverage request successfully submitted. False, if pending request still in-progress.

public long getTimeoutLimit ()

Gets a timeout value in milliseconds for coverage check when an outstanding request should be cancelled. Default value is -1, which means there will not be a timeout limit.

Returns:

Timeout value in millisecond

public void setTimeoutLimit (long value)

Sets a timeout value in milliseconds for coverage check when an outstanding request should be cancelled. Caller of the request will received a callback with CANCELLED.

Parameters:

  • value

    Timeout value in millisecond. Acceptable values can be either a positive number or -1 to indicate no timeout.

Throws:

  • IllegalArgumentException

    if the timeout value is invalid.