osmscout::FileScanner Class Reference

#include <FileScanner.h>

Public Types
enum	Mode { Sequential, FastRandom, LowMemRandom, Normal }

Public Member Functions
void	Close ()
	Closes the file. More...
void	CloseFailsafe ()
	Closes the file. More...
	FileScanner ()=default
std::string	GetFilename () const
FileOffset	GetPos () const
	Returns the current position of the reading cursor in relation to the begining of the file. More...
void	GotoBegin ()
	Moves the reading cursor to the start of the file (offset 0) More...
bool	HasError () const
bool	IsEOF () const
bool	IsOpen () const
void	Open (const std::string &filename, Mode mode, bool useMmap)
void	Read (char *buffer, size_t bytes)
uint16_t	Read (size_t bytes)
void	Read (std::vector< Point > &nodes, std::vector< SegmentGeoBox > &segments, GeoBox &bbox, bool readIds)
	Reads vector of Point and pre-compute segments and bounding box for it. More...
bool	ReadBool ()
GeoBox	ReadBox ()
std::byte	ReadByte ()
Color	ReadColor ()
std::tuple< GeoCoord, bool >	ReadConditionalCoord ()
GeoCoord	ReadCoord ()
FileOffset	ReadFileOffset ()
FileOffset	ReadFileOffset (size_t bytes)
int16_t	ReadInt16 ()
int16_t	ReadInt16Number ()
int32_t	ReadInt32 ()
int32_t	ReadInt32Number ()
int64_t	ReadInt64 ()
int64_t	ReadInt64Number ()
int8_t	ReadInt8 ()
ObjectFileRef	ReadObjectFileRef ()
std::vector< ObjectFileRef >	ReadObjectFileRefs (size_t count)
std::string	ReadString ()
TypeId	ReadTypeId (uint8_t maxBytes)
uint16_t	ReadUInt16 ()
uint16_t	ReadUInt16Number ()
uint32_t	ReadUInt32 ()
uint32_t	ReadUInt32 (size_t bytes)
uint32_t	ReadUInt32Number ()
uint64_t	ReadUInt64 ()
uint64_t	ReadUInt64 (size_t bytes)
uint64_t	ReadUInt64Number ()
uint8_t	ReadUInt8 ()
void	SetPos (FileOffset pos)
	Moves the reading cursor to the given file position. More...
	~FileScanner ()

Detailed Description

FileScanner implements platform independent sequential scanning-like access to data in files. File access is buffered.

FileScanner will use mmap in read-only mode if available (and will fall back to normal buffered IO if available but failing), resulting in mapping the complete file into the memory of the process (without allocating real memory) resulting in measurable speed increase because of exchanging buffered file access with in memory array access.

Member Enumeration Documentation

Mode

enum osmscout::FileScanner::Mode

Enumerator
Sequential
FastRandom
LowMemRandom
Normal

Constructor & Destructor Documentation

FileScanner()

osmscout::FileScanner::FileScanner ( )

default

~FileScanner()

osmscout::FileScanner::~FileScanner

(

)

References CloseFailsafe(), IsOpen(), osmscout::log, and osmscout::Log::Warn().

Member Function Documentation

Close()

void osmscout::FileScanner::Close

(

)

Closes the file.

If the file was never opened or was already closed an exception is thrown.

If closing the file fails, an exception is thrown

Referenced by osmscout::CoordDataFile::Close(), osmscout::CoverageIndex::Close(), osmscout::AreaIndex::Close(), osmscout::OptimizeWaysLowZoom::Close(), osmscout::WaterIndex::Close(), osmscout::AreaNodeIndex::Close(), osmscout::OptimizeAreasLowZoom::Close(), osmscout::AreaAreaIndex::Close(), osmscout::TypeConfig::GetDatabaseFileFormatVersion(), osmscout::BoundingBoxDataFile::Load(), osmscout::ObjectVariantDataFile::Load(), osmscout::TypeDistributionDataFile::Load(), and osmscout::TypeConfig::LoadFromDataFile().

CloseFailsafe()

void osmscout::FileScanner::CloseFailsafe

(

)

Closes the file.

Does not throw any exceptions even if an error occurs.

Use this variant of Close() in cases where the file already run into errors and you just want to clean up the resources using best effort.

Referenced by osmscout::CoverageIndex::Close(), osmscout::AreaIndex::Close(), osmscout::OptimizeWaysLowZoom::Close(), osmscout::WaterIndex::Close(), osmscout::AreaNodeIndex::Close(), osmscout::OptimizeAreasLowZoom::Close(), osmscout::AreaAreaIndex::Close(), osmscout::TypeConfig::GetDatabaseFileFormatVersion(), osmscout::BoundingBoxDataFile::Load(), osmscout::ObjectVariantDataFile::Load(), osmscout::TypeDistributionDataFile::Load(), osmscout::TypeConfig::LoadFromDataFile(), osmscout::CoordDataFile::Open(), and ~FileScanner().

GetFilename()

std::string osmscout::FileScanner::GetFilename

(

)

const

Referenced by osmscout::AreaAreaIndex::GetAreasInArea(), osmscout::TypeConfig::LoadFromDataFile(), and osmscout::WaterIndex::Open().

GetPos()

FileOffset osmscout::FileScanner::GetPos

(

)

const

Returns the current position of the reading cursor in relation to the begining of the file.

throws IOException on error

References HasError().

Referenced by osmscout::Node::Read(), osmscout::Route::Read(), osmscout::RouteNode::Read(), osmscout::Way::Read(), osmscout::PTRoute::Read(), osmscout::Area::Read(), osmscout::Area::ReadImport(), osmscout::Way::ReadOptimized(), and osmscout::Area::ReadOptimized().

GotoBegin()

void osmscout::FileScanner::GotoBegin

(

)

Moves the reading cursor to the start of the file (offset 0)

throws IOException on error

References SetPos().

HasError()

bool osmscout::FileScanner::HasError ( ) const

inline

Referenced by GetPos(), IsEOF(), osmscout::CoverageIndex::Open(), osmscout::AreaIndex::Open(), osmscout::OptimizeWaysLowZoom::Open(), osmscout::WaterIndex::Open(), osmscout::OptimizeAreasLowZoom::Open(), osmscout::AreaNodeIndex::Open(), osmscout::AreaAreaIndex::Open(), Read(), ReadBool(), ReadBox(), ReadByte(), ReadColor(), ReadConditionalCoord(), ReadCoord(), ReadFileOffset(), ReadInt16(), ReadInt16Number(), ReadInt32(), ReadInt32Number(), ReadInt64(), ReadInt64Number(), ReadInt8(), ReadString(), ReadUInt16(), ReadUInt16Number(), ReadUInt32(), ReadUInt32Number(), ReadUInt64(), ReadUInt64Number(), ReadUInt8(), and SetPos().

IsEOF()

bool osmscout::FileScanner::IsEOF

(

)

const

References HasError().

IsOpen()

bool osmscout::FileScanner::IsOpen ( ) const

inline

Referenced by osmscout::CoordDataFile::Close(), osmscout::CoverageIndex::Close(), osmscout::AreaIndex::Close(), osmscout::OptimizeWaysLowZoom::Close(), osmscout::WaterIndex::Close(), osmscout::AreaNodeIndex::Close(), osmscout::OptimizeAreasLowZoom::Close(), osmscout::AreaAreaIndex::Close(), osmscout::CoverageIndex::IsOpen(), osmscout::AreaIndex::IsOpen(), and ~FileScanner().

Open()

void osmscout::FileScanner::Open	(	const std::string &	filename,
		Mode	mode,
		bool	useMmap
	)

References osmscout::Log::Error(), FastRandom, osmscout::log, LowMemRandom, and Sequential.

Referenced by osmscout::TypeConfig::GetDatabaseFileFormatVersion(), osmscout::BoundingBoxDataFile::Load(), osmscout::ObjectVariantDataFile::Load(), osmscout::TypeDistributionDataFile::Load(), osmscout::TypeConfig::LoadFromDataFile(), osmscout::CoordDataFile::Open(), osmscout::CoverageIndex::Open(), osmscout::AreaIndex::Open(), osmscout::OptimizeWaysLowZoom::Open(), osmscout::WaterIndex::Open(), osmscout::OptimizeAreasLowZoom::Open(), osmscout::AreaNodeIndex::Open(), and osmscout::AreaAreaIndex::Open().

Read() [1/3]

void osmscout::FileScanner::Read	(	char *	buffer,
		size_t	bytes
	)

References HasError().

Referenced by osmscout::Route::Read(), osmscout::Way::Read(), osmscout::Area::Read(), osmscout::Area::ReadImport(), osmscout::Way::ReadOptimized(), and osmscout::Area::ReadOptimized().

Read() [2/3]

uint16_t osmscout::FileScanner::Read

(

size_t

bytes

)

References HasError().

Read() [3/3]

void osmscout::FileScanner::Read	(	std::vector< Point > &	nodes,
		std::vector< SegmentGeoBox > &	segments,
		GeoBox &	bbox,
		bool	readIds
	)

Reads vector of Point and pre-compute segments and bounding box for it.

Parameters

nodes
segments
bbox
readIds

References osmscout::SegmentGeoBox::bbox, osmscout::SegmentGeoBox::from, osmscout::GetBoundingBox(), osmscout::GeoCoord::GetLat(), osmscout::GeoCoord::GetLon(), osmscout::latConversionFactor, osmscout::lonConversionFactor, ReadCoord(), ReadUInt8(), and osmscout::SegmentGeoBox::to.

ReadBool()

bool osmscout::FileScanner::ReadBool

(

)

References HasError().

Referenced by osmscout::WaterIndex::Open(), osmscout::AreaNodeIndex::Open(), and osmscout::TypeInfo::Read().

ReadBox()

GeoBox osmscout::FileScanner::ReadBox

(

)

References HasError(), and ReadCoord().

Referenced by osmscout::BoundingBoxDataFile::Load(), and osmscout::Route::Read().

ReadByte()

std::byte osmscout::FileScanner::ReadByte

(

)

References HasError().

ReadColor()

Color osmscout::FileScanner::ReadColor

(

)

References HasError().

Referenced by osmscout::ColorFeatureValue::Read(), and osmscout::PTRoute::Read().

ReadConditionalCoord()

std::tuple< GeoCoord, bool > osmscout::FileScanner::ReadConditionalCoord

(

)

References osmscout::coordByteSize, and HasError().

Referenced by osmscout::CoordDataFile::Get().

ReadCoord()

GeoCoord osmscout::FileScanner::ReadCoord

(

)

References osmscout::coordByteSize, and HasError().

Referenced by osmscout::AreaNodeIndex::Open(), osmscout::Node::Read(), osmscout::RouteNode::Read(), Read(), osmscout::Area::Read(), ReadBox(), and osmscout::Area::ReadOptimized().

ReadFileOffset() [1/2]

FileOffset osmscout::FileScanner::ReadFileOffset

(

)

References HasError().

Referenced by osmscout::AreaIndex::GetOffsets(), osmscout::CoordDataFile::Open(), osmscout::AreaIndex::Open(), osmscout::OptimizeWaysLowZoom::Open(), osmscout::WaterIndex::Open(), osmscout::OptimizeAreasLowZoom::Open(), osmscout::AreaNodeIndex::Open(), osmscout::AreaAreaIndex::Open(), and ReadObjectFileRef().

ReadFileOffset() [2/2]

FileOffset osmscout::FileScanner::ReadFileOffset

(

size_t

bytes

)

References HasError().

ReadInt16()

int16_t osmscout::FileScanner::ReadInt16

(

)

References HasError().

ReadInt16Number()

int16_t osmscout::FileScanner::ReadInt16Number

(

)

References osmscout::DecodeNumber(), and HasError().

Referenced by osmscout::EleFeatureValue::Read().

ReadInt32()

int32_t osmscout::FileScanner::ReadInt32

(

)

References HasError().

Referenced by osmscout::ConstructionYearFeatureValue::Read().

ReadInt32Number()

int32_t osmscout::FileScanner::ReadInt32Number

(

)

References osmscout::DecodeNumber(), and HasError().

ReadInt64()

int64_t osmscout::FileScanner::ReadInt64

(

)

References HasError().

ReadInt64Number()

int64_t osmscout::FileScanner::ReadInt64Number

(

)

References osmscout::DecodeNumber(), and HasError().

Referenced by osmscout::TurnRestriction::Read().

ReadInt8()

int8_t osmscout::FileScanner::ReadInt8

(

)

References HasError().

Referenced by osmscout::LayerFeatureValue::Read().

ReadObjectFileRef()

ObjectFileRef osmscout::FileScanner::ReadObjectFileRef

(

)

References ReadFileOffset(), and ReadUInt8().

Referenced by osmscout::RouteNode::Read(), and osmscout::PTRoute::Read().

ReadObjectFileRefs()

std::vector< ObjectFileRef > osmscout::FileScanner::ReadObjectFileRefs

(

size_t

count

)

References ReadUInt64Number().

ReadString()

std::string osmscout::FileScanner::ReadString

(

)

References HasError().

Referenced by osmscout::TypeConfig::LoadFromDataFile(), osmscout::IsInFeatureValue::Read(), osmscout::PhoneFeatureValue::Read(), osmscout::PostalCodeFeatureValue::Read(), osmscout::DestinationFeatureValue::Read(), osmscout::NameShortFeatureValue::Read(), osmscout::WebsiteFeatureValue::Read(), osmscout::OpeningHoursFeatureValue::Read(), osmscout::OperatorFeatureValue::Read(), osmscout::BrandFeatureValue::Read(), osmscout::NetworkFeatureValue::Read(), osmscout::RefFeatureValue::Read(), osmscout::LocationFeatureValue::Read(), osmscout::NameFeatureValue::Read(), osmscout::NameAltFeatureValue::Read(), osmscout::AddressFeatureValue::Read(), osmscout::AdminLevelFeatureValue::Read(), osmscout::MaxStayFeatureValue::Read(), osmscout::ChargingStationFeatureValue::Read(), osmscout::FeeFeatureValue::Read(), osmscout::FromToFeatureValue::Read(), osmscout::LanesFeatureValue::Read(), osmscout::PTRoute::Read(), and osmscout::TypeInfo::Read().

ReadTypeId()

TypeId osmscout::FileScanner::ReadTypeId

(

uint8_t

maxBytes

)

References ReadUInt8().

Referenced by osmscout::Node::Read(), osmscout::Route::Read(), osmscout::Way::Read(), osmscout::Area::Read(), osmscout::Area::ReadImport(), osmscout::Way::ReadOptimized(), and osmscout::Area::ReadOptimized().

ReadUInt16()

uint16_t osmscout::FileScanner::ReadUInt16

(

)

References HasError().

Referenced by osmscout::OptimizeWaysLowZoom::Open(), osmscout::OptimizeAreasLowZoom::Open(), osmscout::AreaNodeIndex::Open(), osmscout::RouteNode::Read(), and osmscout::PTRoute::Read().

ReadUInt16Number()

uint16_t osmscout::FileScanner::ReadUInt16Number

(

)

References HasError().

Referenced by osmscout::AreaNodeIndex::Open().

ReadUInt32() [1/2]

uint32_t osmscout::FileScanner::ReadUInt32

(

)

References HasError().

Referenced by osmscout::TypeConfig::GetDatabaseFileFormatVersion(), osmscout::ObjectVariantDataFile::Load(), osmscout::TypeDistributionDataFile::Load(), osmscout::TypeConfig::LoadFromDataFile(), osmscout::CoordDataFile::Open(), osmscout::CoverageIndex::Open(), osmscout::AreaIndex::Open(), osmscout::OptimizeWaysLowZoom::Open(), osmscout::OptimizeAreasLowZoom::Open(), and osmscout::AreaNodeIndex::Open().

ReadUInt32() [2/2]

uint32_t osmscout::FileScanner::ReadUInt32

(

size_t

bytes

)

References HasError().

ReadUInt32Number()

uint32_t osmscout::FileScanner::ReadUInt32Number

(

)

References HasError().

Referenced by osmscout::AreaIndex::GetOffsets(), osmscout::TypeConfig::LoadFromDataFile(), osmscout::AreaIndex::Open(), osmscout::WaterIndex::Open(), osmscout::AreaAreaIndex::Open(), osmscout::ObjectVariantData::Read(), osmscout::Intersection::Read(), osmscout::TurnRestriction::Read(), osmscout::Route::Read(), osmscout::RouteNode::Read(), osmscout::PTRoute::Read(), osmscout::Area::Read(), osmscout::Area::ReadImport(), and osmscout::Area::ReadOptimized().

ReadUInt64() [1/2]

uint64_t osmscout::FileScanner::ReadUInt64

(

)

References HasError().

Referenced by osmscout::CoordDataFile::Open(), and osmscout::RouteNode::Read().

ReadUInt64() [2/2]

uint64_t osmscout::FileScanner::ReadUInt64

(

size_t

bytes

)

References HasError().

ReadUInt64Number()

uint64_t osmscout::FileScanner::ReadUInt64Number

(

)

References HasError().

Referenced by osmscout::AreaIndex::GetOffsets(), osmscout::Intersection::Read(), osmscout::ChargingStationFeatureValue::Read(), osmscout::Route::Read(), osmscout::RouteNode::Read(), osmscout::ObjectFileRefStreamReader::Read(), and ReadObjectFileRefs().

ReadUInt8()

uint8_t osmscout::FileScanner::ReadUInt8

(

)

References HasError().

Referenced by osmscout::CoordDataFile::Get(), osmscout::CoverageIndex::Open(), osmscout::AreaIndex::Open(), osmscout::WaterIndex::Open(), osmscout::AreaNodeIndex::Open(), osmscout::ObjectVariantData::Read(), osmscout::GradeFeatureValue::Read(), osmscout::MaxSpeedFeatureValue::Read(), osmscout::WidthFeatureValue::Read(), osmscout::AdminLevelFeatureValue::Read(), osmscout::ChargingStationFeatureValue::Read(), osmscout::FeeFeatureValue::Read(), osmscout::SidewayFeatureValue::Read(), osmscout::AccessRestrictedFeatureValue::Read(), osmscout::LanesFeatureValue::Read(), osmscout::RouteNode::Read(), osmscout::AccessFeatureValue::Read(), osmscout::PTRoute::Read(), Read(), osmscout::Area::Read(), osmscout::TypeInfo::Read(), osmscout::FeatureValueBuffer::Read(), osmscout::Area::ReadImport(), ReadObjectFileRef(), osmscout::Area::ReadOptimized(), and ReadTypeId().

SetPos()

void osmscout::FileScanner::SetPos

(

FileOffset

pos

)

Moves the reading cursor to the given file position.

throws IOException on error

References HasError().

Referenced by osmscout::CoordDataFile::Get(), osmscout::AreaIndex::GetOffsets(), GotoBegin(), osmscout::CoordDataFile::Open(), osmscout::OptimizeWaysLowZoom::Open(), and osmscout::OptimizeAreasLowZoom::Open().

---

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

• FileScanner.h
• FileScanner.cpp