#include <libosmscout/include/osmscout/LocationService.h>

Public Member Functions
	LocationService (const DatabaseRef &database)

bool	VisitAdminRegions (AdminRegionVisitor &visitor) const

bool	ResolveAdminRegionHierachie (const AdminRegionRef &adminRegion, std::map< FileOffset, AdminRegionRef > &refs) const

bool	VisitAdminRegionLocations (const AdminRegion &region, const PostalArea &postalArea, LocationVisitor &visitor) const

bool	VisitAdminRegionPOIs (const AdminRegion &region, POIVisitor &visitor) const

bool	VisitLocationAddresses (const AdminRegion &region, const PostalArea &postalArea, const Location &location, AddressVisitor &visitor) const

bool	SearchForLocationByString (const LocationStringSearchParameter &searchParameter, LocationSearchResult &result) const

bool	SearchForLocationByForm (const LocationFormSearchParameter &searchParameter, LocationSearchResult &result) const

bool	SearchForPOIByForm (const POIFormSearchParameter &searchParameter, LocationSearchResult &result) const

Detailed Description

The LocationService offers a number of methods for location lookup ( search for a certain location by its name) and location reverse lookup (retrieve the name of a location).

The support different type of requests for different interfaces the visitor pattern is used.

Currently the following functionalities are supported:

Visit all region (recursivly)
Visit all locations of a region and (optionally) all locations of all sub regions.
Visit all addresses of a location (non recursive)
Resolve all parent regions for a given region
General interface for location lookup, offering default visitors for the individual index traversals.
Retrieve the addresses of one or more objects.

Constructor & Destructor Documentation

◆ LocationService()

osmscout::LocationService::LocationService ( const DatabaseRef & database )

explicit

Member Function Documentation

◆ ResolveAdminRegionHierachie()

bool osmscout::LocationService::ResolveAdminRegionHierachie	(	const AdminRegionRef &	adminRegion,
		std::map< FileOffset, AdminRegionRef > &	refs
	)		const

◆ SearchForLocationByForm()

bool osmscout::LocationService::SearchForLocationByForm	(	const LocationFormSearchParameter &	searchParameter,
		LocationSearchResult &	result
	)		const

◆ SearchForLocationByString()

bool osmscout::LocationService::SearchForLocationByString	(	const LocationStringSearchParameter &	searchParameter,
		LocationSearchResult &	result
	)		const

◆ SearchForPOIByForm()

bool osmscout::LocationService::SearchForPOIByForm	(	const POIFormSearchParameter &	searchParameter,
		LocationSearchResult &	result
	)		const

◆ VisitAdminRegionLocations()

bool osmscout::LocationService::VisitAdminRegionLocations	(	const AdminRegion &	region,
		const PostalArea &	postalArea,
		LocationVisitor &	visitor
	)		const

◆ VisitAdminRegionPOIs()

bool osmscout::LocationService::VisitAdminRegionPOIs	(	const AdminRegion &	region,
		POIVisitor &	visitor
	)		const

◆ VisitAdminRegions()

bool osmscout::LocationService::VisitAdminRegions ( AdminRegionVisitor & visitor ) const

◆ VisitLocationAddresses()

bool osmscout::LocationService::VisitLocationAddresses	(	const AdminRegion &	region,
		const PostalArea &	postalArea,
		const Location &	location,
		AddressVisitor &	visitor
	)		const

The documentation for this class was generated from the following file:

libosmscout/include/osmscout/LocationService.h

Public Member Functions