osmscout::AreaIndex Class Reference

Generic area index for lookup objects by area. More...

#include <AreaIndex.h>

Inheritance diagram for osmscout::AreaIndex:

Classes
struct	TypeData

Public Member Functions
	AreaIndex ()=default
	AreaIndex (AreaIndex &&)=delete
	AreaIndex (const AreaIndex &)=delete
void	Close ()
std::string	GetFilename () const
bool	GetOffsets (const GeoBox &boundingBox, const TypeInfoSet &types, std::vector< FileOffset > &offsets, TypeInfoSet &loadedTypes) const
bool	IsOpen () const
bool	Open (const TypeConfigRef &typeConfig, const std::string &path, bool memoryMappedData)
AreaIndex &	operator= (AreaIndex &&)=delete
AreaIndex &	operator= (const AreaIndex &)=delete
virtual	~AreaIndex ()

Protected Member Functions
	AreaIndex (const std::string &indexFileName)
void	GetOffsets (const TypeData &typeData, const GeoBox &boundingBox, std::unordered_set< FileOffset > &offsets) const
virtual void	ReadTypeData (const TypeConfigRef &typeConfig, TypeData &data)=0

Protected Attributes
FileScanner	scanner
	Scanner instance for reading this file.

Detailed Description

Generic area index for lookup objects by area.

Constructor & Destructor Documentation

AreaIndex() [1/4]

osmscout::AreaIndex::AreaIndex ( const std::string &  indexFileName )

explicitprotected

AreaIndex() [2/4]

osmscout::AreaIndex::AreaIndex ( )

default

AreaIndex() [3/4]

osmscout::AreaIndex::AreaIndex ( const AreaIndex &  )

delete

AreaIndex() [4/4]

osmscout::AreaIndex::AreaIndex ( AreaIndex &&  )

delete

~AreaIndex()

osmscout::AreaIndex::~AreaIndex ( )

virtual

References Close().

Member Function Documentation

Close()

void osmscout::AreaIndex::Close

(

)

References osmscout::FileScanner::Close(), osmscout::FileScanner::CloseFailsafe(), osmscout::Log::Error(), osmscout::IOException::GetDescription(), osmscout::FileScanner::IsOpen(), osmscout::log, and scanner.

Referenced by ~AreaIndex().

GetFilename()

std::string osmscout::AreaIndex::GetFilename ( ) const

inline

GetOffsets() [1/2]

bool osmscout::AreaIndex::GetOffsets	(	const GeoBox &	boundingBox,
		const TypeInfoSet &	types,
		std::vector< FileOffset > &	offsets,
		TypeInfoSet &	loadedTypes
	)		const

References osmscout::TypeInfoSet::Clear(), osmscout::Log::Error(), osmscout::IOException::GetDescription(), osmscout::GeoBox::GetDisplayText(), osmscout::StopClock::GetMilliseconds(), GetOffsets(), osmscout::TypeInfoSet::IsSet(), osmscout::log, osmscout::StopClock::ResultString(), osmscout::TypeInfoSet::Set(), osmscout::StopClock::Stop(), and osmscout::Log::Warn().

GetOffsets() [2/2]

void osmscout::AreaIndex::GetOffsets ( const TypeData &  typeData, const GeoBox &  boundingBox, std::unordered_set< FileOffset > &  offsets  ) const

protected

References osmscout::AreaIndex::TypeData::bitmapOffset, osmscout::AreaIndex::TypeData::boundingBox, osmscout::AreaIndex::TypeData::dataOffsetBytes, osmscout::AreaIndex::TypeData::GetCellOffset(), osmscout::AreaIndex::TypeData::GetDataOffset(), osmscout::TileIdBox::GetMaxX(), osmscout::TileIdBox::GetMaxY(), osmscout::TileIdBox::GetMinX(), osmscout::TileIdBox::GetMinY(), osmscout::AreaIndex::TypeData::indexLevel, osmscout::TileIdBox::Intersection(), osmscout::GeoBox::Intersects(), osmscout::TileIdBox::Intersects(), osmscout::FileScanner::ReadFileOffset(), osmscout::FileScanner::ReadUInt32Number(), osmscout::FileScanner::ReadUInt64Number(), scanner, osmscout::FileScanner::SetPos(), and osmscout::AreaIndex::TypeData::tileBox.

Referenced by GetOffsets().

IsOpen()

bool osmscout::AreaIndex::IsOpen ( ) const

inline

References osmscout::FileScanner::IsOpen().

Open()

bool osmscout::AreaIndex::Open	(	const TypeConfigRef &	typeConfig,
		const std::string &	path,
		bool	memoryMappedData
	)

References osmscout::AppendFileToDir(), osmscout::AreaIndex::TypeData::bitmapOffset, osmscout::AreaIndex::TypeData::boundingBox, osmscout::AreaIndex::TypeData::dataOffsetBytes, osmscout::Log::Error(), osmscout::FileScanner::FastRandom, osmscout::TileIdBox::GetBoundingBox(), osmscout::IOException::GetDescription(), osmscout::FileScanner::HasError(), osmscout::AreaIndex::TypeData::indexLevel, osmscout::log, osmscout::FileScanner::Open(), osmscout::FileScanner::ReadFileOffset(), ReadTypeData(), osmscout::FileScanner::ReadUInt32(), osmscout::FileScanner::ReadUInt32Number(), osmscout::FileScanner::ReadUInt8(), scanner, and osmscout::AreaIndex::TypeData::tileBox.

operator=() [1/2]

AreaIndex & osmscout::AreaIndex::operator= ( AreaIndex &&  )

delete

operator=() [2/2]

AreaIndex & osmscout::AreaIndex::operator= ( const AreaIndex &  )

delete

ReadTypeData()

virtual void osmscout::AreaIndex::ReadTypeData ( const TypeConfigRef &  typeConfig, TypeData &  data  )

protectedpure virtual

Referenced by Open().

Member Data Documentation

scanner

FileScanner osmscout::AreaIndex::scanner

mutableprotected

Scanner instance for reading this file.

Referenced by Close(), GetOffsets(), and Open().

---

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

• AreaIndex.h
• AreaIndex.cpp