gem::GenericCategories Class Reference

GenericCategories object. More...

Inheritance diagram for gem::GenericCategories:

Collaboration diagram for gem::GenericCategories:

Public Member Functions
	GenericCategories ()=default
	Default constructor.
const LandmarkCategoryListRef	getCategories () const noexcept
	Get generic categories list.
const LandmarkCategoryRef	getCategory (int id) const noexcept
	Get generic category by id.
const LandmarkCategoryListRef	getPoiCategories (int genericCategory) const noexcept
	Get the list of POI categories for the given generic category.
const LandmarkCategoryRef	getGenericCategory (int poiCategory) const noexcept
	Get the generic category for the given POI category.
int	getLandmarkStoreId () const noexcept
	Get the generic categories landmark store id.

Detailed Description

GenericCategories object.

Implements share-read / write Api object over IGenericCategoriesMapping.

This behaves like a singleton, i.e. all instances are shared behind the same API interface

Member Function Documentation

getCategories()

const LandmarkCategoryListRef gem::GenericCategories::getCategories ( ) const

inlinenoexcept

Get generic categories list.

Returns

The list of generic categories

getCategory()

const LandmarkCategoryRef gem::GenericCategories::getCategory ( int id ) const

inlinenoexcept

Get generic category by id.

Parameters

[in]

id

Generic category id, see EGenericCategoriesIDs

Returns

The generic category

getGenericCategory()

const LandmarkCategoryRef gem::GenericCategories::getGenericCategory ( int poiCategory ) const

inlinenoexcept

Get the generic category for the given POI category.

Parameters

[in]

poiCategory

POI category, see ELandmarkStoreType::EMapPoi landmark store type

Returns

The generic category id, see EGenericCategoriesIDs

getLandmarkStoreId()

int gem::GenericCategories::getLandmarkStoreId ( ) const

inlinenoexcept

Get the generic categories landmark store id.

Returns

The landmark store id

getPoiCategories()

const LandmarkCategoryListRef gem::GenericCategories::getPoiCategories ( int genericCategory ) const

inlinenoexcept

Get the list of POI categories for the given generic category.

Parameters

[in]

genericCategory

Generic category id, see EGenericCategoriesIDs

Returns

The list of POI categories