libosmscout  0.1
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules
osmscout::AreaIndex Class Referenceabstract

#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)
 
AreaIndexoperator= (AreaIndex &&)=delete
 
AreaIndexoperator= (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. More...
 

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()

◆ GetFilename()

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

◆ GetOffsets() [1/2]

◆ GetOffsets() [2/2]

◆ IsOpen()

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

◆ Open()

◆ 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: