Inheritance diagram for gem::LandmarkStoreCollection:

[legend]

Collaboration diagram for gem::LandmarkStoreCollection:

[legend]

Public Member Functions
int	size () const noexcept
	Get the number of stores in the list.
int	getStoreIdAt (int index) const noexcept
	Get the store ID for the specified index.
template<typename TCollector>
bool	iterateLandmarkStores (TCollector collector) const noexcept
	Iterate all landmark stores in collection and call collector for each.
bool	contains (int storeId) const noexcept
	Check if the specified store ID has any category in the list.
bool	contains (const LandmarkStore &lms) const noexcept
	Check if the specified store has any category in the list.
bool	contains (int storeId, int categoryId) const noexcept
	Check if the specified category ID from the specified store ID was already added.
int	getCategoryCount (int storeId) const noexcept
	Get the number of categories enabled for the specified store.
int	getStoreCategoryId (int storeId, int indexCategory) const noexcept
	Get the specified category ID for the specified store.
int	addStoreCategoryId (int storeId, int categoryId) noexcept
	Add a new category ID into the specified store list.
int	addStoreCategoryList (int storeId, LandmarkCategoryList const &categories) noexcept
	Add a list of categories into the specified store list.
int	addAllStoreCategories (int storeId) noexcept
	Add all categories of the specified store ID.
int	add (const LandmarkStore &lms) noexcept
	Add all categories of the specified store.
int	removeStoreCategoryId (int storeId, int categoryId) noexcept
	Remove category ID from the specified store list.
int	removeAllStoreCategories (int storeId) noexcept
	Remove all categories of the specified store ID.
int	remove (const LandmarkStore &lms) noexcept
	Remove all categories of the specified store.
LandmarkStoreCollection &	clear () noexcept
	Remove all stores and categories.

Detailed Description

LandmarkStoreCollection object.

Implements share-read / write Api object over ILandmarkStoresCollection.

Member Function Documentation

◆ add()

int gem::LandmarkStoreCollection::add ( const LandmarkStore & lms )

inlinenoexcept

Add all categories of the specified store.

Returns: KNoError on success.

Parameters

lms The store

◆ addAllStoreCategories()

int gem::LandmarkStoreCollection::addAllStoreCategories ( int storeId )

inlinenoexcept

Add all categories of the specified store ID.

Returns: KNoError on success.

Parameters

storeId The store ID

◆ addStoreCategoryId()

int gem::LandmarkStoreCollection::addStoreCategoryId	(	int	storeId,
		int	categoryId )

inlinenoexcept

Add a new category ID into the specified store list.

Returns: KNoError on success.

Parameters

storeId	The store ID
categoryId	The category ID

◆ addStoreCategoryList()

int gem::LandmarkStoreCollection::addStoreCategoryList	(	int	storeId,
		LandmarkCategoryList const &	categories )

inlinenoexcept

Add a list of categories into the specified store list.

Returns: KNoError on success.

Parameters

storeId	The store ID
categories	The list of categories

◆ clear()

LandmarkStoreCollection & gem::LandmarkStoreCollection::clear ( )

inlinenoexcept

Remove all stores and categories.

Returns: self

◆ contains() [1/3]

bool gem::LandmarkStoreCollection::contains ( const LandmarkStore & lms ) const

inlinenoexcept

Check if the specified store has any category in the list.

Returns: true if the store has any category in the list

Parameters

lms The store

◆ contains() [2/3]

bool gem::LandmarkStoreCollection::contains ( int storeId ) const

inlinenoexcept

Check if the specified store ID has any category in the list.

Returns: true if the store has any category in the list

Parameters

storeId The store ID

◆ contains() [3/3]

bool gem::LandmarkStoreCollection::contains	(	int	storeId,
		int	categoryId ) const

inlinenoexcept

Check if the specified category ID from the specified store ID was already added.

Returns: true if the category ID from the store ID was already added

Parameters

storeId	The store ID
categoryId	The category ID

◆ getCategoryCount()

int gem::LandmarkStoreCollection::getCategoryCount ( int storeId ) const

inlinenoexcept

Get the number of categories enabled for the specified store.

Returns: The number of categories

Parameters

storeId The store ID

◆ getStoreCategoryId()

int gem::LandmarkStoreCollection::getStoreCategoryId	(	int	storeId,
		int	indexCategory ) const

inlinenoexcept

Get the specified category ID for the specified store.

Returns: The category ID

Parameters

storeId	The store ID
indexCategory	The index of the category

◆ getStoreIdAt()

int gem::LandmarkStoreCollection::getStoreIdAt ( int index ) const

inlinenoexcept

Get the store ID for the specified index.

Parameters

[in] index The index should be less than the value provided by size().

Returns: On success it returns > 0.; On error it returns < 0.

◆ iterateLandmarkStores()

template<typename TCollector>

bool gem::LandmarkStoreCollection::iterateLandmarkStores ( TCollector collector ) const

inlinenoexcept

Iterate all landmark stores in collection and call collector for each.

Collector should return true if iteration should continue and false if iteration should stop

Template Parameters

TCollector The collector type

Parameters

[in] collector The collector

Returns: true if all stores were iterated, false if iteration was stopped by collector

◆ remove()

int gem::LandmarkStoreCollection::remove ( const LandmarkStore & lms )

inlinenoexcept

Remove all categories of the specified store.

Returns: KNoError on success.

Parameters

lms The store

◆ removeAllStoreCategories()

int gem::LandmarkStoreCollection::removeAllStoreCategories ( int storeId )

inlinenoexcept

Remove all categories of the specified store ID.

Returns: KNoError on success.

Parameters

storeId The store ID

◆ removeStoreCategoryId()

int gem::LandmarkStoreCollection::removeStoreCategoryId	(	int	storeId,
		int	categoryId )

inlinenoexcept

Remove category ID from the specified store list.

Returns: KNoError on success.

Parameters

storeId	The store ID
categoryId	The category ID

◆ size()

int gem::LandmarkStoreCollection::size ( ) const

inlinenoexcept

Get the number of stores in the list.

Returns: The number of stores

Public Member Functions

Detailed Description

Member Function Documentation

◆ add()

◆ addAllStoreCategories()

◆ addStoreCategoryId()

◆ addStoreCategoryList()

◆ clear()

◆ contains() [1/3]

◆ contains() [2/3]

◆ contains() [3/3]

◆ getCategoryCount()

◆ getStoreCategoryId()

◆ getStoreIdAt()

◆ iterateLandmarkStores()

◆ remove()

◆ removeAllStoreCategories()

◆ removeStoreCategoryId()

◆ size()