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

Classes
struct	ReverseLookupResult

Public Types
using	ReverseLookupRef = std::shared_ptr< ReverseLookupResult >

Public Member Functions
	LocationDescriptionService (const DatabaseRef &database)

bool	ReverseLookupRegion (const GeoCoord &coord, std::list< ReverseLookupResult > &result) const

bool	ReverseLookupObjects (const std::list< ObjectFileRef > &objects, std::list< ReverseLookupResult > &result) const

bool	ReverseLookupObject (const ObjectFileRef &object, std::list< ReverseLookupResult > &result) const

bool	DescribeLocation (const GeoCoord &location, LocationDescription &description, const Distance &lookupDistance=Distance::Of< Meter >(100), double sizeFilter=1.0)

bool	DescribeLocationByName (const GeoCoord &location, LocationDescription &description, const Distance &lookupDistance=Distance::Of< Meter >(100), double sizeFilter=1.0)

bool	DescribeLocationByAddress (const GeoCoord &location, LocationDescription &description, const Distance &lookupDistance=Distance::Of< Meter >(100), double sizeFilter=1.0)

bool	DescribeLocationByPOI (const GeoCoord &location, LocationDescription &description, const Distance &lookupDistance=Distance::Of< Meter >(100), double sizeFilter=1.0)

bool	DescribeLocationByCrossing (const GeoCoord &location, LocationDescription &description, const Distance &lookupDistance=Distance::Of< Meter >(100))

bool	DescribeLocationByWay (const GeoCoord &location, LocationDescription &description, const Distance &lookupDistance=Distance::Of< Meter >(100))

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.

Member Typedef Documentation

◆ ReverseLookupRef

using osmscout::LocationDescriptionService::ReverseLookupRef = std::shared_ptr<ReverseLookupResult>

Constructor & Destructor Documentation

◆ LocationDescriptionService()

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

explicit

Member Function Documentation

◆ DescribeLocation()

bool osmscout::LocationDescriptionService::DescribeLocation	(	const GeoCoord &	location,
		LocationDescription &	description,
		const Distance &	lookupDistance = `Distance::Of< Meter >(100)`,
		double	sizeFilter = `1.0`
	)

◆ DescribeLocationByAddress()

bool osmscout::LocationDescriptionService::DescribeLocationByAddress	(	const GeoCoord &	location,
		LocationDescription &	description,
		const Distance &	lookupDistance = `Distance::Of< Meter >(100)`,
		double	sizeFilter = `1.0`
	)

◆ DescribeLocationByCrossing()

bool osmscout::LocationDescriptionService::DescribeLocationByCrossing	(	const GeoCoord &	location,
		LocationDescription &	description,
		const Distance &	lookupDistance = `Distance::Of< Meter >(100)`
	)

◆ DescribeLocationByName()

bool osmscout::LocationDescriptionService::DescribeLocationByName	(	const GeoCoord &	location,
		LocationDescription &	description,
		const Distance &	lookupDistance = `Distance::Of< Meter >(100)`,
		double	sizeFilter = `1.0`
	)

◆ DescribeLocationByPOI()

bool osmscout::LocationDescriptionService::DescribeLocationByPOI	(	const GeoCoord &	location,
		LocationDescription &	description,
		const Distance &	lookupDistance = `Distance::Of< Meter >(100)`,
		double	sizeFilter = `1.0`
	)

◆ DescribeLocationByWay()

bool osmscout::LocationDescriptionService::DescribeLocationByWay	(	const GeoCoord &	location,
		LocationDescription &	description,
		const Distance &	lookupDistance = `Distance::Of< Meter >(100)`
	)

◆ ReverseLookupObject()

bool osmscout::LocationDescriptionService::ReverseLookupObject	(	const ObjectFileRef &	object,
		std::list< ReverseLookupResult > &	result
	)		const

◆ ReverseLookupObjects()

bool osmscout::LocationDescriptionService::ReverseLookupObjects	(	const std::list< ObjectFileRef > &	objects,
		std::list< ReverseLookupResult > &	result
	)		const

◆ ReverseLookupRegion()

bool osmscout::LocationDescriptionService::ReverseLookupRegion	(	const GeoCoord &	coord,
		std::list< ReverseLookupResult > &	result
	)		const

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

libosmscout/include/osmscout/LocationDescriptionService.h

Classes

Public Types

Public Member Functions