Inheritance diagram for gem::SearchPreferences:

Collaboration diagram for gem::SearchPreferences:

Public Member Functions
	SearchPreferences (const SearchPreferences &searchPref)=default
	Default copy constructor.
	SearchPreferences (SearchPreferences &&searchPref)=default
	Default move constructor noexcept is deduced.
SearchPreferences &	operator= (const SearchPreferences &searchPref)=default
	Default copy assignment.
SearchPreferences &	operator= (SearchPreferences &&searchPref)=default
	Default move assignment noexcept is deduced.
int	getMaxMatches () const noexcept
	Get the max number of matches.
SearchPreferences &	setMaxMatches (int value) noexcept
	Set the max number of matches.
bool	isExactMatchEnabled () const noexcept
	Test if exact match is used.
SearchPreferences &	setExactMatch (bool value) noexcept
	Set/unset the exact match.
bool	isSearchAddressesEnabled () const noexcept
	Check if search through addresses is enabled.
SearchPreferences &	setSearchAddresses (bool value=true) noexcept
	Enable or disable search through addresses.
bool	isSearchMapPOIsEnabled () const noexcept
	Check if search should look through map POIs.
SearchPreferences &	setSearchMapPOIs (bool value=true) noexcept
	Enable or disable search through map POIs.
bool	isSearchGeofencesEnabled () const noexcept
	Check if search should look through geofences.
SearchPreferences &	setSearchGeofences (bool value=true) noexcept
	Enable or disable search through geofences.
LandmarkStoreCollectionRef	lmks () noexcept
	Get access to the search target landmark stores collection.
OverlayMutableCollectionRef	overlays () noexcept
	Get access to the search target overlays collection.
SearchPreferences &	setSearchOnlyOnboard (bool searchOnlyOnboard) noexcept
	Set the flag for onboard search.
bool	isSearchOnlyOnboardEnabled () const noexcept
	Get the flag for onboard search.
SearchPreferences &	setThresholdDistance (int threshold) noexcept
	Set the threshold distance for the operation.
int	getThresholdDistance () const noexcept
	Get the threshold distance for the request.
SearchPreferences &	setAllowFuzzyResults (bool value) noexcept
	Enable or disable the inclusion of fuzzy search results.
bool	getAllowFuzzyResults () const noexcept
	Test if fuzzy search results are allowed.
SearchPreferences &	setEstimateMissingHouseNumbers (bool value=true) noexcept
	Enable or disable the inclusion of interpolated house number results.
bool	getEstimateMissingHouseNumbers () const noexcept
	Test if fuzzy search results are allowed.
SearchPreferences &	setEasyAccessOnlyResults (bool value) noexcept
	Enable or disable the easy access filter for results.
bool	getEasyAccessOnlyResults () const noexcept
	Test if easy access filter is enabled.

Detailed Description

SearchPreferences object.

Implements share-read / copy-on-write Api object over ISearchPreferences.

Constructor & Destructor Documentation

◆ SearchPreferences() [1/2]

gem::SearchPreferences::SearchPreferences ( const SearchPreferences & searchPref )

default

Default copy constructor.

Parameters

searchPref The object to copy

◆ SearchPreferences() [2/2]

gem::SearchPreferences::SearchPreferences ( SearchPreferences && searchPref )

default

Default move constructor noexcept is deduced.

Parameters

searchPref The object to move

Member Function Documentation

◆ getAllowFuzzyResults()

bool gem::SearchPreferences::getAllowFuzzyResults ( ) const

inlinenoexcept

Test if fuzzy search results are allowed.

Returns: True if fuzzy search results are allowed

◆ getEasyAccessOnlyResults()

bool gem::SearchPreferences::getEasyAccessOnlyResults ( ) const

inlinenoexcept

Test if easy access filter is enabled.

Returns: True if easy access filter is enabled

◆ getEstimateMissingHouseNumbers()

bool gem::SearchPreferences::getEstimateMissingHouseNumbers ( ) const

inlinenoexcept

Test if fuzzy search results are allowed.

Returns: True if fuzzy search results are allowed

◆ getMaxMatches()

int gem::SearchPreferences::getMaxMatches ( ) const

inlinenoexcept

Get the max number of matches.

Note: Default is 40.

Returns: The max number of matches.

◆ getThresholdDistance()

int gem::SearchPreferences::getThresholdDistance ( ) const

inlinenoexcept

Get the threshold distance for the request.

Returns: The threshold distance

◆ isExactMatchEnabled()

bool gem::SearchPreferences::isExactMatchEnabled ( ) const

inlinenoexcept

Test if exact match is used.

Note: Default is false.

Returns: True if only an exact match of free text search token is returned as result

◆ isSearchAddressesEnabled()

bool gem::SearchPreferences::isSearchAddressesEnabled ( ) const

inlinenoexcept

Check if search through addresses is enabled.

Note: Default is true.

Returns: True if search through addresses is enabled

◆ isSearchGeofencesEnabled()

bool gem::SearchPreferences::isSearchGeofencesEnabled ( ) const

inlinenoexcept

Check if search should look through geofences.

Default is false

Returns: True if search through geofences is enabled

◆ isSearchMapPOIsEnabled()

bool gem::SearchPreferences::isSearchMapPOIsEnabled ( ) const

inlinenoexcept

Check if search should look through map POIs.

Default is true

Returns: True if search through map POIs is enabled

◆ isSearchOnlyOnboardEnabled()

bool gem::SearchPreferences::isSearchOnlyOnboardEnabled ( ) const

inlinenoexcept

Get the flag for onboard search.

Returns: True if the search is done using only onboard data

◆ lmks()

LandmarkStoreCollectionRef gem::SearchPreferences::lmks ( )

inlinenoexcept

Get access to the search target landmark stores collection.

Returns: The collection of landmark stores

◆ operator=() [1/2]

SearchPreferences & gem::SearchPreferences::operator= ( const SearchPreferences & searchPref )

default

Default copy assignment.

Parameters

searchPref The object to copy

Returns: The object that was copied

◆ operator=() [2/2]

SearchPreferences & gem::SearchPreferences::operator= ( SearchPreferences && searchPref )

default

Default move assignment noexcept is deduced.

Parameters

searchPref The object to move

Returns: The object that was moved

◆ overlays()

OverlayMutableCollectionRef gem::SearchPreferences::overlays ( )

inlinenoexcept

Get access to the search target overlays collection.

Returns: The collection of overlays

◆ setAllowFuzzyResults()

SearchPreferences & gem::SearchPreferences::setAllowFuzzyResults ( bool value )

inlinenoexcept

Enable or disable the inclusion of fuzzy search results.

Note: Default is true

Parameters

value The flag to set

Returns: A reference to the object

◆ setEasyAccessOnlyResults()

SearchPreferences & gem::SearchPreferences::setEasyAccessOnlyResults ( bool value )

inlinenoexcept

Enable or disable the easy access filter for results.

Parameters

value The flag to set

Returns: A reference to the object

◆ setEstimateMissingHouseNumbers()

SearchPreferences & gem::SearchPreferences::setEstimateMissingHouseNumbers ( bool value = true )

inlinenoexcept

Enable or disable the inclusion of interpolated house number results.

Note: Default is true

Parameters

value The flag to set

Returns: A reference to the object

◆ setExactMatch()

SearchPreferences & gem::SearchPreferences::setExactMatch ( bool value )

inlinenoexcept

Set/unset the exact match.

If set to true, only an exact match of free text search token is returned as result

Parameters

value The flag to set

Returns: A reference to the object

◆ setMaxMatches()

SearchPreferences & gem::SearchPreferences::setMaxMatches ( int value )

inlinenoexcept

Set the max number of matches.

Parameters

value The max number of matches.

Returns: A reference to the object

◆ setSearchAddresses()

SearchPreferences & gem::SearchPreferences::setSearchAddresses ( bool value = true )

inlinenoexcept

Enable or disable search through addresses.

Parameters

value The flag to set

Returns: A reference to the object

◆ setSearchGeofences()

SearchPreferences & gem::SearchPreferences::setSearchGeofences ( bool value = true )

inlinenoexcept

Enable or disable search through geofences.

Parameters

value The flag to set

Returns: A reference to the object

◆ setSearchMapPOIs()

SearchPreferences & gem::SearchPreferences::setSearchMapPOIs ( bool value = true )

inlinenoexcept

Enable or disable search through map POIs.

Parameters

value The flag to set

Returns: A reference to the object

◆ setSearchOnlyOnboard()

SearchPreferences & gem::SearchPreferences::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.

Note: By default it is false.

Parameters

searchOnlyOnboard The flag to set

Returns: A reference to the object

◆ setThresholdDistance()

SearchPreferences & gem::SearchPreferences::setThresholdDistance ( int threshold )

inlinenoexcept

Set the threshold distance for the operation.

This may be used to control the reverse geocoding and search along route lookup area.

When searching along route, the threshold is the result maximum distance from the target route

When searching around position, the threshold is the result maximum distance from the reference point

Returns: A reference to the object

Parameters

threshold The threshold distance

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SearchPreferences() [1/2]

◆ SearchPreferences() [2/2]

Member Function Documentation

◆ getAllowFuzzyResults()

◆ getEasyAccessOnlyResults()

◆ getEstimateMissingHouseNumbers()

◆ getMaxMatches()

◆ getThresholdDistance()

◆ isExactMatchEnabled()

◆ isSearchAddressesEnabled()

◆ isSearchGeofencesEnabled()

◆ isSearchMapPOIsEnabled()

◆ isSearchOnlyOnboardEnabled()

◆ lmks()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ overlays()

◆ setAllowFuzzyResults()

◆ setEasyAccessOnlyResults()

◆ setEstimateMissingHouseNumbers()

◆ setExactMatch()

◆ setMaxMatches()

◆ setSearchAddresses()

◆ setSearchGeofences()

◆ setSearchMapPOIs()

◆ setSearchOnlyOnboard()

◆ setThresholdDistance()