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 Western Europe and North America. Using this configuration object can 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.

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

Syntax

config = hereHDLMConfiguration(catalog)

config = hereHDLMConfiguration(catalog,catalogVersion)

Description

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.

config = hereHDLMConfiguration(catalog,catalogVersion) creates a hereHDLMConfiguration object for the specified version of the catalog.

Input Arguments

catalog — Name of HERE HDLM production catalog

string scalar | character vector

Name of HERE HDLM production catalog, specified as a string scalar or character vector. You can obtain production catalog names from HERE Technologies.

Example: 'hrn:here:data::olp-here-had:here-hdlm-protobuf-na-2' specifies a catalog that roughly corresponds to the North America region.

Example: 'hrn:here:data::olp-here-had:here-hdlm-protobuf-weu-2' specifies a catalog that roughly corresponds to the Western Europe region.

catalogVersion — Version number of HERE HDLM production catalog

positive integer

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

Catalog — Name of HERE HDLM production catalog

string scalar | character vector

This property is read-only.

Name of a HERE HDLM production catalog, specified as a string scalar or character vector. This property is set to the name of the catalog specified by the catalog input.

CatalogVersion — Version number of HERE HDLM production catalog

positive integer

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 specified catalog.

Examples

Create Configuration for Specific Catalog

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 catalog that roughly corresponds to Western Europe. 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('hrn:here:data::olp-here-had:here-hdlm-protobuf-weu-2')

config = 
  hereHDLMConfiguration with properties:

           Catalog: 'hrn:here:data::olp-here-had:here-hdlm-protobuf-weu-2'
    CatalogVersion: 5597

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);

Create Configuration for Specific Catalog Version

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 a catalog that roughly corresponds to 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.

catalog = 'hrn:here:data::olp-here-had:here-hdlm-protobuf-na-2';
configLatest = hereHDLMConfiguration(catalog)

configLatest = 
  hereHDLMConfiguration with properties:

           Catalog: 'hrn:here:data::olp-here-had:here-hdlm-protobuf-na-2'
    CatalogVersion: 3320

Create a configuration object for the previous version of the catalog.

previousVersion = configLatest.CatalogVersion - 1;
config = hereHDLMConfiguration(catalog,previousVersion)

config = 
  hereHDLMConfiguration with properties:

           Catalog: 'hrn:here:data::olp-here-had:here-hdlm-protobuf-na-2'
    CatalogVersion: 3319

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',config);

Tips

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

Compatibility Considerations

hereHDLMConfiguration(region) syntax will be removed

Warns starting in R2020b

In hereHDLMConfiguration objects, the syntax for configuring a hereHDLMReader object to search catalogs from a specific region, hereHDLMConfiguration(region), will be removed in a future release. Instead, specify the catalog name that corresponds to that region by using the hereHDLMConfiguration(catalog) syntax.

Previously, the catalog names for regions such as North America were not available to customers. HERE Technologies now makes these catalog names available through the HERE HD Live Map Marketplace, making the region syntax unnecessary.

Update Code

The table shows a typical usage of the hereHDLMConfiguration(region) syntax. It also shows how to update your code using the hereHDLMConfiguration(catalog) syntax.

Discouraged Usage	Recommended Replacement
catalog = hereHDLMConfiguration('North America')	catalog = hereHDLMConfiguration('hrn:here:data::olp-here-had:here-hdlm-protobuf-na-2')