osmscout::Route Class Reference

Representation of route. More...

#include <Route.h>

Classes
struct	Segment
struct	SegmentMember

Public Types
using	MemberCache = std::unordered_map< FileOffset, WayRef >
enum	MemberDirection { MemberDirection::forward, MemberDirection::backward }

Public Member Functions
GeoBox	GetBoundingBox () const
const FeatureInstance &	GetFeature (size_t idx) const
size_t	GetFeatureCount () const
FeatureValue *	GetFeatureValue (size_t idx) const
const FeatureValueBuffer &	GetFeatureValueBuffer () const
FileOffset	GetFileOffset () const
std::vector< FileOffset >	GetMemberOffsets () const
FileOffset	GetNextFileOffset () const
MemberCache	GetResolvedMembers () const
TypeInfoRef	GetType () const
bool	HasFeature (size_t idx) const
bool	HasResolvedMembers () const
void	Read (const TypeConfig &typeConfig, FileScanner &scanner)
	Route ()=default
void	SetFeatures (const FeatureValueBuffer &buffer)
void	SetResolvedMembers (const MemberCache &map)
void	SetType (const TypeInfoRef &type)
void	UnsetFeature (size_t idx)
void	Write (const TypeConfig &typeConfig, FileWriter &writer) const

Public Attributes
GeoBox	bbox
std::vector< Segment >	segments

Detailed Description

Representation of route.

Route is sequence of ways. Way may be part of multiple routes. It may represent hiking, cycling, public transport (...) route.

It is created from OpenStreetMap relation of "route" type, as described on wiki: https://wiki.openstreetmap.org/wiki/Relation:route

Member Typedef Documentation

MemberCache

using osmscout::Route::MemberCache = std::unordered_map<FileOffset,WayRef>

Member Enumeration Documentation

MemberDirection

enum osmscout::Route::MemberDirection

strong

Enumerator
forward
backward

Constructor & Destructor Documentation

Route()

osmscout::Route::Route ( )

default

Member Function Documentation

GetBoundingBox()

GeoBox osmscout::Route::GetBoundingBox ( ) const

inline

GetFeature()

const FeatureInstance& osmscout::Route::GetFeature ( size_t  idx ) const

inline

References osmscout::FeatureValueBuffer::GetType().

GetFeatureCount()

size_t osmscout::Route::GetFeatureCount ( ) const

inline

References osmscout::FeatureValueBuffer::GetType().

GetFeatureValue()

FeatureValue* osmscout::Route::GetFeatureValue ( size_t  idx ) const

inline

References osmscout::FeatureValueBuffer::GetValue().

GetFeatureValueBuffer()

const FeatureValueBuffer& osmscout::Route::GetFeatureValueBuffer ( ) const

inline

GetFileOffset()

FileOffset osmscout::Route::GetFileOffset ( ) const

inline

GetMemberOffsets()

std::vector< FileOffset > osmscout::Route::GetMemberOffsets

(

)

const

References segments.

GetNextFileOffset()

FileOffset osmscout::Route::GetNextFileOffset ( ) const

inline

GetResolvedMembers()

MemberCache osmscout::Route::GetResolvedMembers ( ) const

inline

GetType()

TypeInfoRef osmscout::Route::GetType ( ) const

inline

References osmscout::FeatureValueBuffer::GetType().

HasFeature()

bool osmscout::Route::HasFeature ( size_t  idx ) const

inline

References osmscout::FeatureValueBuffer::HasFeature().

HasResolvedMembers()

bool osmscout::Route::HasResolvedMembers ( ) const

inline

Read()

void osmscout::Route::Read	(	const TypeConfig &	typeConfig,
		FileScanner &	scanner
	)

References backward, bbox, osmscout::BitsToBytes(), osmscout::FileScanner::GetPos(), osmscout::TypeConfig::GetRouteTypeIdBytes(), osmscout::TypeConfig::GetRouteTypeInfo(), osmscout::FileScanner::Read(), osmscout::FeatureValueBuffer::Read(), osmscout::FileScanner::ReadBox(), osmscout::FileScanner::ReadTypeId(), osmscout::FileScanner::ReadUInt32Number(), osmscout::FileScanner::ReadUInt64Number(), segments, and osmscout::FeatureValueBuffer::SetType().

SetFeatures()

void osmscout::Route::SetFeatures ( const FeatureValueBuffer &  buffer )

inline

References osmscout::FeatureValueBuffer::Set().

SetResolvedMembers()

void osmscout::Route::SetResolvedMembers ( const MemberCache &  map )

inline

SetType()

void osmscout::Route::SetType ( const TypeInfoRef &  type )

inline

References osmscout::FeatureValueBuffer::SetType().

UnsetFeature()

void osmscout::Route::UnsetFeature ( size_t  idx )

inline

References osmscout::FeatureValueBuffer::FreeValue().

Write()

void osmscout::Route::Write	(	const TypeConfig &	typeConfig,
		FileWriter &	writer
	)		const

References backward, bbox, osmscout::BitsToBytes(), osmscout::TypeConfig::GetRouteTypeIdBytes(), osmscout::FeatureValueBuffer::GetType(), segments, osmscout::FileWriter::Write(), osmscout::FeatureValueBuffer::Write(), osmscout::FileWriter::WriteBox(), osmscout::FileWriter::WriteNumber(), and osmscout::FileWriter::WriteTypeId().

Member Data Documentation

bbox

GeoBox osmscout::Route::bbox

Referenced by Read(), and Write().

segments

std::vector<Segment> osmscout::Route::segments

Referenced by GetMemberOffsets(), Read(), and Write().

---

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

• Route.h
• Route.cpp