hereHDLMConfiguration

Configure HERE HD Live Map reader

Description

A hereHDLMConfiguration object configures a hereHDLMReader object to search for map data in only a specific HERE HD Live Map[1] (HDLM) production catalog or catalog version. These catalogs roughly correspond to various geographic regions, such as North America or Western Europe. Use this configuration object to speed up the performance of the reader, so that it does not search unnecessary catalogs. The configuration object is stored in the Configuration property of a hereHDLMReader object. For more details on creating configuration objects, see Create Configuration for HERE HD Live Map Reader.

Note

Use of the hereHDLMConfiguration object requires valid HERE HDLM credentials. If you have not previously set up credentials, a dialog box prompts you to enter them. Enter the Access Key ID and Access Key Secret that you obtained from HERE Technologies, and click OK.

Creation

Description

example

config = hereHDLMConfiguration(catalog) creates a hereHDLMConfiguration object for the latest version of the specified HERE HDLM catalog. A hereHDLMReader object with this configuration searches for the selected map tiles within only the catalog and version specified by that configuration.

example

config = hereHDLMConfiguration(region) creates a hereHDLMConfiguration object for the latest version of the catalog that corresponds to the specified region.

example

config = hereHDLMConfiguration(___,catalogVersion) creates a hereHDLMConfiguration object for the specified version of the catalog. Along with the catalog version, specify either the catalog name or the region name that corresponds to a catalog.

Input Arguments

expand all

Name of HERE HDLM production catalog, specified as a string scalar or character vector. This table shows the valid region names and their corresponding HERE HDLM production catalog names.

RegionCatalog
'North America''hrn:here:data::olp-here-had:here-hdlm-protobuf-na-2'
'Western Europe''hrn:here:data::olp-here-had:here-hdlm-protobuf-weu-2'

Name of geographic region that corresponds to a HERE HDLM production catalog, specified as a string scalar or character vector. This table shows the valid region names and their corresponding HERE HDLM production catalog names.

RegionCatalog
'North America''hrn:here:data::olp-here-had:here-hdlm-protobuf-na-2'
'Western Europe''hrn:here:data::olp-here-had:here-hdlm-protobuf-weu-2'

Version number of a HERE HDLM production catalog, specified as a positive integer. The HERE HDLM web service determines the availability of previous versions of the catalog. If you specify a version of a catalog that is not available, then hereHDLMConfiguration returns an error.

Properties

expand all

This property is read-only.

Name of HERE HDLM production catalog, specified as a string scalar or character vector.

  • If you specified the catalog input argument, then this property is set to the name of that catalog.

  • If you specified the region input argument, then this property is set to the catalog name that corresponds to that region.

This property is read-only.

Version number of a HERE HDLM production catalog, specified as a positive integer. The version number corresponds to the value specified in the catalogVersion input argument. If you do not specify catalogVersion, then this property is set to the latest version of the catalog specified in the Catalog property.

Examples

collapse all

Define a HERE tile ID for an area of Berlin, Germany.

tileID = uint32(377894435);

Create a HERE HD Live Map (HERE HDLM) configuration object for the Western Europe catalog. If you have not previously set up HERE HDLM credentials, a dialog box prompts you to enter them.

config = hereHDLMConfiguration('Western Europe');

Create a HERE HDLM reader using the specified HERE tile ID and configuration object. During creation, hereHDLMReader searches for the tile ID within only the Western Europe catalog. This reader is configured to read map data from only that catalog.

reader = hereHDLMReader(tileID,'Configuration',config);

Load a sequence of latitude and longitude coordinates for a driving route in Boston, MA, USA.

data = load('geoRoute.mat')
data = struct with fields:
     latitude: [256×1 double]
    longitude: [256×1 double]

Create a HERE HD Live Map (HERE HDLM) configuration object for the region that the driving route is in (North America). If you have not previously set up HERE HDLM credentials, a dialog box prompts you to enter them. Your catalog version might differ from the one shown here.

config = hereHDLMConfiguration('North America')
config = 
  hereHDLMConfiguration with properties:

           Catalog: 'here-hdmap-ext-na-1'
    CatalogVersion: 2291

Create a HERE HDLM reader using the specified coordinates and configuration object. During creation, hereHDLMReader searches for map tiles containing these coordinates. It searches within only the catalog that is associated with the North America region. The created reader is configured to read map data from only the North America catalog.

reader = hereHDLMReader(data.latitude,data.longitude,'Configuration',config);

Create a HERE HD Live Map (HERE HDLM) configuration object for the previous version of a catalog.

Load a sequence of latitude and longitude coordinates for a driving route in Los Altos, California, USA.

data = load('geoSequence.mat')
data = struct with fields:
     latitude: [1000×1 double]
    longitude: [1000×1 double]

Create a HERE HDLM configuration object for the latest version of the North America catalog. If you have not previously set up HERE HDLM credentials, a dialog box prompts you to enter them. View the catalog version. Your catalog version might differ from the one shown here.

configLatest = hereHDLMConfiguration('North America');
configLatest.CatalogVersion
ans = 6966

Create a configuration object for the previous version of the catalog. Verify that the catalog version is one less than the catalog for the latest version.

previousVersion = configLatest.CatalogVersion - 1;
configPrevious = hereHDLMConfiguration('North America',previousVersion);
configPrevious.CatalogVersion
ans = 6965

Create a HERE HDLM reader using the specified configuration object. The reader is configured to read data from only the previous version of the North America catalog.

reader = hereHDLMReader(data.latitude,data.longitude,'Configuration',configPrevious);

Tips

  • To save HERE HDLM credentials between MATLAB® sessions, select the corresponding option in the HERE HD Live Map Credentials dialog box. To manage HERE HDLM credentials, use the hereHDLMCredentials function.

Introduced in R2019a


[1] You need to enter into a separate agreement with HERE in order to gain access to the HDLM services and to get the required credentials (access_key_id and access_key_secret) for using the HERE Service.