Central access class to all the individual data files and indexes. More...

#include <Database.h>

Public Member Functions
void	Close ()

	Database (const DatabaseParameter &parameter)

void	DumpStatistics () const

void	FlushCache ()

AreaAreaIndexRef	GetAreaAreaIndex () const

bool	GetAreaByOffset (const FileOffset &offset, AreaRef &area) const

AreaDataFileRef	GetAreaDataFile () const

AreaNodeIndexRef	GetAreaNodeIndex () const

AreaRouteIndexRef	GetAreaRouteIndex () const

bool	GetAreasByBlockSpan (const DataBlockSpan &span, std::vector< AreaRef > &area) const

bool	GetAreasByBlockSpans (const std::vector< DataBlockSpan > &spans, std::vector< AreaRef > &areas) const

template<typename OffsetsCol , typename DataCol >
bool	GetAreasByOffset (const OffsetsCol &offsets, DataCol &areas) const

AreaWayIndexRef	GetAreaWayIndex () const

bool	GetBoundingBox (GeoBox &boundingBox) const

BoundingBoxDataFileRef	GetBoundingBoxDataFile () const

LocationIndexRef	GetLocationIndex () const

bool	GetNodeByOffset (const FileOffset &offset, NodeRef &node) const

NodeDataFileRef	GetNodeDataFile () const

bool	GetNodesByOffset (const std::list< FileOffset > &offsets, std::vector< NodeRef > &nodes) const

bool	GetNodesByOffset (const std::set< FileOffset > &offsets, std::unordered_map< FileOffset, NodeRef > &dataMap) const

bool	GetNodesByOffset (const std::set< FileOffset > &offsets, std::vector< NodeRef > &nodes) const

bool	GetNodesByOffset (const std::vector< FileOffset > &offsets, const GeoBox &boundingBox, std::vector< NodeRef > &nodes) const

bool	GetNodesByOffset (const std::vector< FileOffset > &offsets, std::vector< NodeRef > &nodes) const

OptimizeAreasLowZoomRef	GetOptimizeAreasLowZoom () const

OptimizeWaysLowZoomRef	GetOptimizeWaysLowZoom () const

const DatabaseParameter &	GetParameter () const

std::string	GetPath () const

RouteDataFileRef	GetRouteDataFile () const

template<typename OffsetsCol , typename DataCol >
bool	GetRoutesByOffset (const OffsetsCol &offsets, DataCol &routes) const

SRTMRef	GetSRTMIndex () const

TypeConfigRef	GetTypeConfig () const

WaterIndexRef	GetWaterIndex () const

bool	GetWayByOffset (const FileOffset &offset, WayRef &way) const

WayDataFileRef	GetWayDataFile () const

template<typename OffsetsCol , typename DataCol >
bool	GetWaysByOffset (const OffsetsCol &offsets, DataCol &ways) const

bool	IsOpen () const

AreaRegionSearchResult	LoadAreasInArea (const TypeInfoSet &types, const GeoBox &boundingBox) const
	Load areas of given types in the given geo box.

AreaRegionSearchResult	LoadAreasInRadius (const GeoCoord &location, const TypeInfoSet &types, Distance maxDistance=Distance::Of< Meter >(100)) const
	Load areas of given types with maximum distance to the given coordinate.

NodeRegionSearchResult	LoadNodesInArea (const TypeInfoSet &types, const GeoBox &boundingBox) const
	Load nodes of given types in the given geo box Distance is measured in relation to the center of the bounding box.

NodeRegionSearchResult	LoadNodesInRadius (const GeoCoord &location, const TypeInfoSet &types, Distance maxDistance=Distance::Of< Meter >(100)) const
	Load nodes of given types with maximum distance to the given coordinate.

WayRegionSearchResult	LoadWaysInArea (const TypeInfoSet &types, const GeoBox &boundingBox) const
	Load ways of given types in the given geo box.

WayRegionSearchResult	LoadWaysInRadius (const GeoCoord &location, const TypeInfoSet &types, Distance maxDistance=Distance::Of< Meter >(100)) const
	Load ways of given types with maximum distance to the given coordinate.

bool	Open (const std::string &path)

	~Database ()

Static Public Member Functions
static uint32_t	GetDatabaseFileFormatVersion (const std::string &path)

static uint32_t	GetLibraryFileFormatVersion ()

Detailed Description

Central access class to all the individual data files and indexes.

A db is mainly initialized with a number of optional but performance relevant parameters.

The Database is opened by passing the directory that contains all db files.

Constructor & Destructor Documentation

◆ Database()

osmscout::Database::Database ( const DatabaseParameter & parameter )

explicit

References osmscout::Log::Debug(), and osmscout::log.

◆ ~Database()

osmscout::Database::~Database ( )

References Close(), osmscout::Log::Debug(), IsOpen(), and osmscout::log.

Member Function Documentation

◆ Close()

void osmscout::Database::Close ( )

Referenced by ~Database().

◆ DumpStatistics()

void osmscout::Database::DumpStatistics ( ) const

◆ FlushCache()

void osmscout::Database::FlushCache ( )

◆ GetAreaAreaIndex()

AreaAreaIndexRef osmscout::Database::GetAreaAreaIndex ( ) const

References osmscout::Log::Debug(), osmscout::Log::Error(), osmscout::DatabaseParameter::GetAreaAreaIndexCacheSize(), osmscout::DatabaseParameter::GetIndexMMap(), IsOpen(), osmscout::log, osmscout::StopClock::ResultString(), and osmscout::StopClock::Stop().

Referenced by LoadAreasInArea(), and LoadAreasInRadius().

◆ GetAreaByOffset()

bool osmscout::Database::GetAreaByOffset	(	const FileOffset &	offset,
		AreaRef &	area
	)		const

References GetAreaDataFile(), osmscout::StopClock::GetMilliseconds(), osmscout::log, osmscout::StopClock::ResultString(), osmscout::StopClock::Stop(), and osmscout::Log::Warn().

◆ GetAreaDataFile()

AreaDataFileRef osmscout::Database::GetAreaDataFile ( ) const

References osmscout::Log::Debug(), osmscout::Log::Error(), osmscout::DatabaseParameter::GetAreaDataCacheSize(), osmscout::DatabaseParameter::GetAreasDataMMap(), IsOpen(), osmscout::log, osmscout::StopClock::ResultString(), and osmscout::StopClock::Stop().

Referenced by GetAreaByOffset(), GetAreasByBlockSpan(), and GetAreasByBlockSpans().

◆ GetAreaNodeIndex()

AreaNodeIndexRef osmscout::Database::GetAreaNodeIndex ( ) const

References osmscout::Log::Debug(), osmscout::Log::Error(), osmscout::DatabaseParameter::GetIndexMMap(), IsOpen(), osmscout::log, osmscout::StopClock::ResultString(), and osmscout::StopClock::Stop().

Referenced by LoadNodesInArea(), and LoadNodesInRadius().

◆ GetAreaRouteIndex()

AreaRouteIndexRef osmscout::Database::GetAreaRouteIndex ( ) const

References osmscout::Log::Debug(), osmscout::Log::Error(), osmscout::DatabaseParameter::GetIndexMMap(), IsOpen(), osmscout::log, osmscout::StopClock::ResultString(), and osmscout::StopClock::Stop().

◆ GetAreasByBlockSpan()

bool osmscout::Database::GetAreasByBlockSpan	(	const DataBlockSpan &	span,
		std::vector< AreaRef > &	area
	)		const

References GetAreaDataFile().

◆ GetAreasByBlockSpans()

bool osmscout::Database::GetAreasByBlockSpans	(	const std::vector< DataBlockSpan > &	spans,
		std::vector< AreaRef > &	areas
	)		const

References GetAreaDataFile().

Referenced by LoadAreasInArea(), and LoadAreasInRadius().

◆ GetAreasByOffset()

template<typename OffsetsCol , typename DataCol >

bool osmscout::Database::GetAreasByOffset	(	const OffsetsCol &	offsets,
		DataCol &	areas
	)		const

inline

◆ GetAreaWayIndex()

AreaWayIndexRef osmscout::Database::GetAreaWayIndex ( ) const

References osmscout::Log::Debug(), osmscout::Log::Error(), osmscout::DatabaseParameter::GetIndexMMap(), IsOpen(), osmscout::log, osmscout::StopClock::ResultString(), and osmscout::StopClock::Stop().

Referenced by LoadWaysInArea(), and LoadWaysInRadius().

◆ GetBoundingBox()

bool osmscout::Database::GetBoundingBox ( GeoBox & boundingBox ) const

References GetBoundingBoxDataFile().

◆ GetBoundingBoxDataFile()

BoundingBoxDataFileRef osmscout::Database::GetBoundingBoxDataFile ( ) const

References osmscout::BoundingBoxDataFile::BOUNDINGBOX_DAT, osmscout::Log::Debug(), osmscout::Log::Error(), IsOpen(), osmscout::log, osmscout::StopClock::ResultString(), and osmscout::StopClock::Stop().

Referenced by GetBoundingBox().

◆ GetDatabaseFileFormatVersion()

uint32_t osmscout::Database::GetDatabaseFileFormatVersion ( const std::string & path )

static

References osmscout::TypeConfig::GetDatabaseFileFormatVersion().

◆ GetLibraryFileFormatVersion()

uint32_t osmscout::Database::GetLibraryFileFormatVersion ( )

static

References osmscout::FILE_FORMAT_VERSION.

◆ GetLocationIndex()

LocationIndexRef osmscout::Database::GetLocationIndex ( ) const

References osmscout::Log::Debug(), osmscout::Log::Error(), osmscout::DatabaseParameter::GetIndexMMap(), IsOpen(), osmscout::log, osmscout::StopClock::ResultString(), and osmscout::StopClock::Stop().

◆ GetNodeByOffset()

bool osmscout::Database::GetNodeByOffset	(	const FileOffset &	offset,
		NodeRef &	node
	)		const

References osmscout::StopClock::GetMilliseconds(), GetNodeDataFile(), osmscout::log, osmscout::StopClock::ResultString(), osmscout::StopClock::Stop(), and osmscout::Log::Warn().

◆ GetNodeDataFile()

NodeDataFileRef osmscout::Database::GetNodeDataFile ( ) const

References osmscout::Log::Debug(), osmscout::Log::Error(), osmscout::DatabaseParameter::GetNodeDataCacheSize(), osmscout::DatabaseParameter::GetNodesDataMMap(), IsOpen(), osmscout::log, osmscout::StopClock::ResultString(), and osmscout::StopClock::Stop().

Referenced by GetNodeByOffset(), GetNodesByOffset(), GetNodesByOffset(), GetNodesByOffset(), GetNodesByOffset(), and GetNodesByOffset().

◆ GetNodesByOffset() [1/5]

bool osmscout::Database::GetNodesByOffset	(	const std::list< FileOffset > &	offsets,
		std::vector< NodeRef > &	nodes
	)		const

References osmscout::StopClock::GetMilliseconds(), GetNodeDataFile(), osmscout::log, osmscout::StopClock::ResultString(), osmscout::StopClock::Stop(), and osmscout::Log::Warn().

◆ GetNodesByOffset() [2/5]

bool osmscout::Database::GetNodesByOffset	(	const std::set< FileOffset > &	offsets,
		std::unordered_map< FileOffset, NodeRef > &	dataMap
	)		const

References osmscout::StopClock::GetMilliseconds(), GetNodeDataFile(), osmscout::log, osmscout::StopClock::ResultString(), osmscout::StopClock::Stop(), and osmscout::Log::Warn().

◆ GetNodesByOffset() [3/5]

bool osmscout::Database::GetNodesByOffset	(	const std::set< FileOffset > &	offsets,
		std::vector< NodeRef > &	nodes
	)		const

References osmscout::StopClock::GetMilliseconds(), GetNodeDataFile(), osmscout::log, osmscout::StopClock::ResultString(), osmscout::StopClock::Stop(), and osmscout::Log::Warn().

◆ GetNodesByOffset() [4/5]

bool osmscout::Database::GetNodesByOffset	(	const std::vector< FileOffset > &	offsets,
		const GeoBox &	boundingBox,
		std::vector< NodeRef > &	nodes
	)		const

References osmscout::StopClock::GetMilliseconds(), GetNodeDataFile(), osmscout::log, osmscout::StopClock::ResultString(), osmscout::StopClock::Stop(), and osmscout::Log::Warn().

◆ GetNodesByOffset() [5/5]

bool osmscout::Database::GetNodesByOffset	(	const std::vector< FileOffset > &	offsets,
		std::vector< NodeRef > &	nodes
	)		const

References osmscout::StopClock::GetMilliseconds(), GetNodeDataFile(), osmscout::log, osmscout::StopClock::ResultString(), osmscout::StopClock::Stop(), and osmscout::Log::Warn().

Referenced by LoadNodesInArea(), and LoadNodesInRadius().

◆ GetOptimizeAreasLowZoom()

OptimizeAreasLowZoomRef osmscout::Database::GetOptimizeAreasLowZoom ( ) const

References osmscout::Log::Debug(), osmscout::Log::Error(), osmscout::DatabaseParameter::GetOptimizeLowZoomMMap(), IsOpen(), osmscout::log, osmscout::StopClock::ResultString(), and osmscout::StopClock::Stop().

◆ GetOptimizeWaysLowZoom()

OptimizeWaysLowZoomRef osmscout::Database::GetOptimizeWaysLowZoom ( ) const

References osmscout::Log::Debug(), osmscout::Log::Error(), osmscout::DatabaseParameter::GetOptimizeLowZoomMMap(), osmscout::log, osmscout::StopClock::ResultString(), and osmscout::StopClock::Stop().

◆ GetParameter()

const DatabaseParameter & osmscout::Database::GetParameter ( ) const

inline

◆ GetPath()

std::string osmscout::Database::GetPath ( ) const

◆ GetRouteDataFile()

RouteDataFileRef osmscout::Database::GetRouteDataFile ( ) const

References osmscout::Log::Debug(), osmscout::Log::Error(), osmscout::DatabaseParameter::GetRouteDataCacheSize(), osmscout::DatabaseParameter::GetRoutesDataMMap(), IsOpen(), osmscout::log, osmscout::StopClock::ResultString(), and osmscout::StopClock::Stop().

◆ GetRoutesByOffset()

template<typename OffsetsCol , typename DataCol >

bool osmscout::Database::GetRoutesByOffset	(	const OffsetsCol &	offsets,
		DataCol &	routes
	)		const

inline

◆ GetSRTMIndex()

SRTMRef osmscout::Database::GetSRTMIndex ( ) const

References osmscout::Log::Debug(), osmscout::DatabaseParameter::GetSRTMDirectory(), IsOpen(), osmscout::log, osmscout::StopClock::ResultString(), and osmscout::StopClock::Stop().

◆ GetTypeConfig()

TypeConfigRef osmscout::Database::GetTypeConfig ( ) const

Referenced by osmscout::RoutePostprocessor::PostprocessRouteDescription().

◆ GetWaterIndex()

WaterIndexRef osmscout::Database::GetWaterIndex ( ) const

References osmscout::Log::Debug(), osmscout::Log::Error(), osmscout::DatabaseParameter::GetIndexMMap(), IsOpen(), osmscout::log, osmscout::StopClock::ResultString(), and osmscout::StopClock::Stop().

◆ GetWayByOffset()

bool osmscout::Database::GetWayByOffset	(	const FileOffset &	offset,
		WayRef &	way
	)		const

References osmscout::StopClock::GetMilliseconds(), GetWayDataFile(), osmscout::log, osmscout::StopClock::ResultString(), and osmscout::Log::Warn().

◆ GetWayDataFile()

WayDataFileRef osmscout::Database::GetWayDataFile ( ) const

References osmscout::Log::Debug(), osmscout::Log::Error(), osmscout::DatabaseParameter::GetWayDataCacheSize(), osmscout::DatabaseParameter::GetWaysDataMMap(), IsOpen(), osmscout::log, osmscout::StopClock::ResultString(), and osmscout::StopClock::Stop().

Referenced by GetWayByOffset().

◆ GetWaysByOffset()

template<typename OffsetsCol , typename DataCol >

bool osmscout::Database::GetWaysByOffset	(	const OffsetsCol &	offsets,
		DataCol &	ways
	)		const

inline

Referenced by LoadWaysInArea(), and LoadWaysInRadius().

◆ IsOpen()

bool osmscout::Database::IsOpen ( ) const

Referenced by GetAreaAreaIndex(), GetAreaDataFile(), GetAreaNodeIndex(), GetAreaRouteIndex(), GetAreaWayIndex(), GetBoundingBoxDataFile(), GetLocationIndex(), GetNodeDataFile(), GetOptimizeAreasLowZoom(), GetRouteDataFile(), GetSRTMIndex(), GetWaterIndex(), GetWayDataFile(), and ~Database().

◆ LoadAreasInArea()

AreaRegionSearchResult osmscout::Database::LoadAreasInArea	(	const TypeInfoSet &	types,
		const GeoBox &	boundingBox
	)		const

Load areas of given types in the given geo box.

Distance is measured in relation to the center of the bounding box

Parameters

types	Set of type to load candidates for
boundingBox	Geographic area to search in

Returns: result object

Exceptions

OSMScoutException in case of errors

References osmscout::CalculateDistancePointToLineSegment(), GetAreaAreaIndex(), GetAreasByBlockSpans(), osmscout::GeoBox::GetCenter(), osmscout::GetEllipsoidalDistance(), osmscout::IsCoordInArea(), and osmscout::Distance::Max().

Referenced by osmscout::POIService::GetPOIsInArea().

◆ LoadAreasInRadius()

AreaRegionSearchResult osmscout::Database::LoadAreasInRadius	(	const GeoCoord &	location,
		const TypeInfoSet &	types,
		Distance	maxDistance = `Distance::Of<Meter>(100)`
	)		const

Load areas of given types with maximum distance to the given coordinate.

Parameters

location	Geo coordinate in the center of the given circle
types	Set of type to load conadidates for
maxDistance	- lookup distance in meters Maximum radius from center to search for

Returns: result object

Exceptions

OSMScoutException in case of errors

References osmscout::GeoBox::BoxByCenterAndRadius(), osmscout::CalculateDistancePointToLineSegment(), GetAreaAreaIndex(), GetAreasByBlockSpans(), osmscout::GetEllipsoidalDistance(), osmscout::IsCoordInArea(), and osmscout::Distance::Max().

Referenced by osmscout::POIService::GetPOIsInRadius().

◆ LoadNodesInArea()

NodeRegionSearchResult osmscout::Database::LoadNodesInArea	(	const TypeInfoSet &	types,
		const GeoBox &	boundingBox
	)		const

Load nodes of given types in the given geo box Distance is measured in relation to the center of the bounding box.

Parameters

types	Set of type to load candidates for
boundingBox	Geographic area to search in

Returns: result object

Exceptions

OSMScoutException in case of errors

References GetAreaNodeIndex(), osmscout::GeoBox::GetCenter(), osmscout::GetEllipsoidalDistance(), and GetNodesByOffset().

Referenced by osmscout::POIService::GetPOIsInArea().

◆ LoadNodesInRadius()

NodeRegionSearchResult osmscout::Database::LoadNodesInRadius	(	const GeoCoord &	location,
		const TypeInfoSet &	types,
		Distance	maxDistance = `Distance::Of<Meter>(100)`
	)		const

Load nodes of given types with maximum distance to the given coordinate.

Parameters

location	Geo coordinate in the center of the given circle
types	Set of type to load conadidates for
maxDistance	- lookup distance in meters Maximum radius from center to search for

Returns: result object

Exceptions

OSMScoutException in case of errors

References osmscout::GeoBox::BoxByCenterAndRadius(), GetAreaNodeIndex(), osmscout::GetEllipsoidalDistance(), and GetNodesByOffset().

Referenced by osmscout::POIService::GetPOIsInRadius().

◆ LoadWaysInArea()

WayRegionSearchResult osmscout::Database::LoadWaysInArea	(	const TypeInfoSet &	types,
		const GeoBox &	boundingBox
	)		const

Load ways of given types in the given geo box.

Distance is measured in relation to the center of the bounding box

Parameters

types	Set of type to load candidates for
boundingBox	Geographic area to search in

Returns: result object

Exceptions

OSMScoutException in case of errors

References osmscout::CalculateDistancePointToLineSegment(), GetAreaWayIndex(), osmscout::GeoBox::GetCenter(), osmscout::GetEllipsoidalDistance(), GetWaysByOffset(), and osmscout::Distance::Max().

Referenced by osmscout::POIService::GetPOIsInArea().

◆ LoadWaysInRadius()

WayRegionSearchResult osmscout::Database::LoadWaysInRadius	(	const GeoCoord &	location,
		const TypeInfoSet &	types,
		Distance	maxDistance = `Distance::Of<Meter>(100)`
	)		const

Load ways of given types with maximum distance to the given coordinate.

Parameters

location	Geo coordinate in the center of the given circle
types	Set of type to load conadidates for
maxDistance	- lookup distance in meters Maximum radius from center to search for

Returns: result object

Exceptions

OSMScoutException in case of errors

References osmscout::GeoBox::BoxByCenterAndRadius(), osmscout::CalculateDistancePointToLineSegment(), GetAreaWayIndex(), osmscout::GetEllipsoidalDistance(), GetWaysByOffset(), and osmscout::Distance::Max().

Referenced by osmscout::POIService::GetPOIsInRadius().

◆ Open()

bool osmscout::Database::Open ( const std::string & path )

References osmscout::Log::Error(), and osmscout::log.

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

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Database()

◆ ~Database()

Member Function Documentation

◆ Close()

◆ DumpStatistics()

◆ FlushCache()

◆ GetAreaAreaIndex()

◆ GetAreaByOffset()

◆ GetAreaDataFile()

◆ GetAreaNodeIndex()

◆ GetAreaRouteIndex()

◆ GetAreasByBlockSpan()

◆ GetAreasByBlockSpans()

◆ GetAreasByOffset()

◆ GetAreaWayIndex()

◆ GetBoundingBox()

◆ GetBoundingBoxDataFile()

◆ GetDatabaseFileFormatVersion()

◆ GetLibraryFileFormatVersion()

◆ GetLocationIndex()

◆ GetNodeByOffset()

◆ GetNodeDataFile()

◆ GetNodesByOffset() [1/5]

◆ GetNodesByOffset() [2/5]

◆ GetNodesByOffset() [3/5]

◆ GetNodesByOffset() [4/5]

◆ GetNodesByOffset() [5/5]

◆ GetOptimizeAreasLowZoom()

◆ GetOptimizeWaysLowZoom()

◆ GetParameter()

◆ GetPath()

◆ GetRouteDataFile()

◆ GetRoutesByOffset()

◆ GetSRTMIndex()

◆ GetTypeConfig()

◆ GetWaterIndex()

◆ GetWayByOffset()

◆ GetWayDataFile()

◆ GetWaysByOffset()

◆ IsOpen()

◆ LoadAreasInArea()

◆ LoadAreasInRadius()

◆ LoadNodesInArea()

◆ LoadNodesInRadius()

◆ LoadWaysInArea()

◆ LoadWaysInRadius()

◆ Open()