gem::GuidedAddressSearchPreferences Class Reference

GuidedAddressSearchPreferences object. More...

Inheritance diagram for gem::GuidedAddressSearchPreferences:

Collaboration diagram for gem::GuidedAddressSearchPreferences:

Public Member Functions
int	getMaximumMatches () const noexcept
	Get the maximum number of matches.
void	setMaximumMatches (int matches) noexcept
	Set the maximum number of matches.
void	setSearchOnlyOnboard (bool searchOnlyOnboard) noexcept
	Set the flag for onboard search.
bool	getSearchOnlyOnboard () const noexcept
	Get the flag for onboard search.
void	setAutomaticLevelSkip (bool enableAutomaticLevelSkip) noexcept
	When there is only one result at a specific level and there is only one possible next level to search then the engine will automatically skip that level if this flag is set to true.
bool	getAutomaticLevelSkip () const noexcept
	Get the automatic level skip flag.
void	setAllowFuzzyResults (bool bAllow) noexcept
	Enable or disable the inclusion of fuzzy search results.
bool	getAllowFuzzyResults () const noexcept
	Test if fuzzy search results are allowed.

Detailed Description

GuidedAddressSearchPreferences object.

Implements share-read / write Api object over IGuidedAddressSearchPreferences.

Provides guided search for addresses.

Suggests and completes addresses interactively, supporting predictive search and structured address lookup for navigation inputs.

Member Function Documentation

getAllowFuzzyResults()

bool gem::GuidedAddressSearchPreferences::getAllowFuzzyResults ( ) const

inlinenoexcept

Test if fuzzy search results are allowed.

Returns

True if fuzzy search results are allowed

getAutomaticLevelSkip()

bool gem::GuidedAddressSearchPreferences::getAutomaticLevelSkip ( ) const

inlinenoexcept

Get the automatic level skip flag.

Returns

True if the engine will automatically skip levels.

getMaximumMatches()

int gem::GuidedAddressSearchPreferences::getMaximumMatches ( ) const

inlinenoexcept

Get the maximum number of matches.

Note

Default is 40.

Returns

Maximum number of matches.

getSearchOnlyOnboard()

bool gem::GuidedAddressSearchPreferences::getSearchOnlyOnboard ( ) const

inlinenoexcept

Get the flag for onboard search.

Returns

True if the search is done using only onboard data.

setAllowFuzzyResults()

void gem::GuidedAddressSearchPreferences::setAllowFuzzyResults ( bool bAllow )

inlinenoexcept

Enable or disable the inclusion of fuzzy search results.

Note

Default is true

Parameters

bAllow

True to allow fuzzy search results

setAutomaticLevelSkip()

void gem::GuidedAddressSearchPreferences::setAutomaticLevelSkip ( bool enableAutomaticLevelSkip )

inlinenoexcept

When there is only one result at a specific level and there is only one possible next level to search then the engine will automatically skip that level if this flag is set to true.

Parameters

enableAutomaticLevelSkip

Flag for automatic level skip.

setMaximumMatches()

void gem::GuidedAddressSearchPreferences::setMaximumMatches ( int matches )

inlinenoexcept

Set the maximum number of matches.

Parameters

matches

Maximum number of matches.

setSearchOnlyOnboard()

void gem::GuidedAddressSearchPreferences::setSearchOnlyOnboard ( bool searchOnlyOnboard )

inlinenoexcept

Set the flag for onboard search.

If this flag is true then the search will be done using only onboard data. By default it is false.

Parameters

searchOnlyOnboard

Flag for onboard search.