libosmscout 0.1
Loading...
Searching...
No Matches
osmscout::AreaIndex Class Referenceabstract
Database

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 ()
size_t GetEntryCount () const
 The number of entries this index carries; the index file holds one entry per type it indexed.
size_t GetExaminedEntryCount () const
 The number of entries the last lookup examined (diagnostic for tests).
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

Referenced by AreaIndex(), AreaIndex(), osmscout::AreaRouteIndex::AreaRouteIndex(), osmscout::AreaWayIndex::AreaWayIndex(), operator=(), and operator=().

◆ AreaIndex() [2/4]

osmscout::AreaIndex::AreaIndex ( )
default

◆ AreaIndex() [3/4]

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

References AreaIndex().

◆ AreaIndex() [4/4]

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

References AreaIndex().

◆ ~AreaIndex()

osmscout::AreaIndex::~AreaIndex ( )
virtual

References Close().

Member Function Documentation

◆ Close()

void osmscout::AreaIndex::Close ( )

References osmscout::IOException::GetDescription(), osmscout::log, and scanner.

Referenced by operator=(), and ~AreaIndex().

◆ GetEntryCount()

size_t osmscout::AreaIndex::GetEntryCount ( ) const
inline

The number of entries this index carries; the index file holds one entry per type it indexed.

◆ GetExaminedEntryCount()

size_t osmscout::AreaIndex::GetExaminedEntryCount ( ) const
inline

The number of entries the last lookup examined (diagnostic for tests).

◆ 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::IOException::GetDescription(), osmscout::GeoBox::GetDisplayText(), osmscout::StopClock::GetMilliseconds(), GetOffsets(), osmscout::log, osmscout::StopClock::ResultString(), osmscout::TypeInfoSet::Set(), and osmscout::StopClock::Stop().

◆ GetOffsets() [2/2]

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

References osmscout::TileIdBox::GetMaxX(), osmscout::TileIdBox::GetMaxY(), osmscout::TileIdBox::GetMinX(), osmscout::TileIdBox::GetMinY(), osmscout::TileIdBox::Intersection(), osmscout::GeoBox::Intersects(), osmscout::TileIdBox::Intersects(), and scanner.

Referenced by GetOffsets().

◆ IsOpen()

bool osmscout::AreaIndex::IsOpen ( ) const
inline

References scanner.

◆ 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::FileScanner::FastRandom, osmscout::TileIdBox::GetBoundingBox(), osmscout::IOException::GetDescription(), osmscout::AreaIndex::TypeData::indexLevel, osmscout::log, ReadTypeData(), scanner, and osmscout::AreaIndex::TypeData::tileBox.

Referenced by operator=().

◆ operator=() [1/2]

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

References AreaIndex(), Close(), and Open().

◆ operator=() [2/2]

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

References AreaIndex().

◆ 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(), IsOpen(), and Open().

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