#include <Way.h>

Public Member Functions
const Point &	GetBack () const

Id	GetBackId () const

GeoBox	GetBoundingBox () const

bool	GetCenter (GeoCoord &center) const

const GeoCoord &	GetCoord (size_t index) 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

const Point &	GetFront () const

Id	GetFrontId () const

Id	GetId (size_t index) const

FileOffset	GetNextFileOffset () const

bool	GetNodeIndexByNodeId (Id id, size_t &index) const

ObjectFileRef	GetObjectFileRef () const

const Point &	GetPoint (size_t index) const

Id	GetSerial (size_t index) const

TypeInfoRef	GetType () const

bool	HasFeature (size_t idx) const

bool	Intersects (const GeoBox &boundingBox) const
	Returns true if the bounding box of the object intersects the given bounding box. More...

bool	IsCircular () const

bool	IsValid () const

void	Read (const TypeConfig &typeConfig, FileScanner &scanner)
	Read the data from the given FileScanner. More...

void	ReadOptimized (const TypeConfig &typeConfig, FileScanner &scanner)
	Read the data from the given FileScanner. More...

void	SetFeatures (const FeatureValueBuffer &buffer)

void	SetType (const TypeInfoRef &type)

void	UnsetFeature (size_t idx)

	Way ()=default

void	Write (const TypeConfig &typeConfig, FileWriter &writer) const
	Writes the data to the given FileWriter. More...

void	WriteOptimized (const TypeConfig &typeConfig, FileWriter &writer) const
	Writes the data to the given FileWriter. More...

Public Attributes
GeoBox	bbox
	Precomputed (cache) bounding box. More...

std::vector< Point >	nodes
	Note that way nodes, bbox and segments fields are public for simple manipulation. More...

std::vector< SegmentGeoBox >	segments
	Precomputed (cache) segment bounding boxes for optimisation. More...

Constructor & Destructor Documentation

◆ Way()

osmscout::Way::Way ( )

default

Member Function Documentation

◆ GetBack()

const Point& osmscout::Way::GetBack ( ) const

inline

◆ GetBackId()

Id osmscout::Way::GetBackId ( ) const

inline

◆ GetBoundingBox()

GeoBox osmscout::Way::GetBoundingBox ( ) const

inline

References osmscout::GetBoundingBox(), and osmscout::GeoBox::IsValid().

Referenced by osmscout::DescriptionService::GetDescription().

◆ GetCenter()

bool osmscout::Way::GetCenter ( GeoCoord & center ) const

References nodes, and osmscout::GeoCoord::Set().

◆ GetCoord()

const GeoCoord& osmscout::Way::GetCoord ( size_t index ) const

inline

◆ GetFeature()

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

inline

References osmscout::FeatureValueBuffer::GetType().

◆ GetFeatureCount()

size_t osmscout::Way::GetFeatureCount ( ) const

inline

References osmscout::FeatureValueBuffer::GetType().

◆ GetFeatureValue()

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

inline

References osmscout::FeatureValueBuffer::GetValue().

◆ GetFeatureValueBuffer()

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

inline

Referenced by osmscout::AbstractRoutingProfile::CanUse(), osmscout::AbstractRoutingProfile::CanUseBackward(), osmscout::AbstractRoutingProfile::CanUseForward(), and osmscout::DescriptionService::GetDescription().

◆ GetFileOffset()

FileOffset osmscout::Way::GetFileOffset ( ) const

inline

◆ GetFront()

const Point& osmscout::Way::GetFront ( ) const

inline

◆ GetFrontId()

Id osmscout::Way::GetFrontId ( ) const

inline

◆ GetId()

Id osmscout::Way::GetId ( size_t index ) const

inline

Referenced by GetNodeIndexByNodeId().

◆ GetNextFileOffset()

FileOffset osmscout::Way::GetNextFileOffset ( ) const

inline

◆ GetNodeIndexByNodeId()

bool osmscout::Way::GetNodeIndexByNodeId	(	Id	id,
		size_t &	index
	)		const

References GetId(), and nodes.

◆ GetObjectFileRef()

ObjectFileRef osmscout::Way::GetObjectFileRef ( ) const

inline

References osmscout::refWay.

Referenced by osmscout::DescriptionService::GetDescription().

◆ GetPoint()

const Point& osmscout::Way::GetPoint ( size_t index ) const

inline

◆ GetSerial()

Id osmscout::Way::GetSerial ( size_t index ) const

inline

◆ GetType()

TypeInfoRef osmscout::Way::GetType ( ) const

inline

References osmscout::FeatureValueBuffer::GetType().

Referenced by osmscout::AbstractRoutingProfile::CanUse(), osmscout::AbstractRoutingProfile::CanUseBackward(), and osmscout::AbstractRoutingProfile::CanUseForward().

◆ HasFeature()

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

inline

References osmscout::FeatureValueBuffer::HasFeature().

◆ Intersects()

bool osmscout::Way::Intersects ( const GeoBox & boundingBox ) const

inline

Returns true if the bounding box of the object intersects the given bounding box.

Parameters

boundingBox bounding box to test for intersection

Returns: true on intersection, else false

References osmscout::GetBoundingBox().

◆ IsCircular()

bool osmscout::Way::IsCircular ( ) const

inline

◆ IsValid()

bool osmscout::Way::IsValid ( ) const

inline

◆ Read()

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

Read the data from the given FileScanner.

Exceptions

IOException

References bbox, osmscout::FileScanner::GetPos(), osmscout::TypeConfig::GetWayTypeIdBytes(), osmscout::TypeConfig::GetWayTypeInfo(), nodes, osmscout::FileScanner::Read(), osmscout::FeatureValueBuffer::Read(), osmscout::FileScanner::ReadTypeId(), segments, and osmscout::FeatureValueBuffer::SetType().

◆ ReadOptimized()

void osmscout::Way::ReadOptimized	(	const TypeConfig &	typeConfig,
		FileScanner &	scanner
	)

Read the data from the given FileScanner.

Node Ids are not read.

Exceptions

IOException

References bbox, osmscout::FileScanner::GetPos(), osmscout::TypeConfig::GetWayTypeIdBytes(), osmscout::TypeConfig::GetWayTypeInfo(), nodes, osmscout::FileScanner::Read(), osmscout::FeatureValueBuffer::Read(), osmscout::FileScanner::ReadTypeId(), segments, and osmscout::FeatureValueBuffer::SetType().

◆ SetFeatures()

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

inline

References osmscout::FeatureValueBuffer::Set().

◆ SetType()

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

inline

References osmscout::FeatureValueBuffer::SetType().

◆ UnsetFeature()

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

inline

References osmscout::FeatureValueBuffer::FreeValue().

◆ Write()

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

Writes the data to the given FileWriter.

Exceptions

IOException

References osmscout::FeatureValueBuffer::GetType(), osmscout::TypeConfig::GetWayTypeIdBytes(), nodes, osmscout::FileWriter::Write(), osmscout::FeatureValueBuffer::Write(), and osmscout::FileWriter::WriteTypeId().

◆ WriteOptimized()

void osmscout::Way::WriteOptimized	(	const TypeConfig &	typeConfig,
		FileWriter &	writer
	)		const

Writes the data to the given FileWriter.

Node Ids are not written.

Exceptions

IOException

References osmscout::FeatureValueBuffer::GetType(), osmscout::TypeConfig::GetWayTypeIdBytes(), nodes, osmscout::FileWriter::Write(), osmscout::FeatureValueBuffer::Write(), and osmscout::FileWriter::WriteTypeId().

Member Data Documentation

◆ bbox

GeoBox osmscout::Way::bbox

Precomputed (cache) bounding box.

Referenced by Read(), and ReadOptimized().

◆ nodes

std::vector<Point> osmscout::Way::nodes

Note that way nodes, bbox and segments fields are public for simple manipulation.

User that modify it is responsible to keep these values in sync! You should not rely on segments and bbox, it is just a cache used some algorithms. It may be empty/invalid! List of nodes

Referenced by GetCenter(), GetNodeIndexByNodeId(), Read(), ReadOptimized(), Write(), and WriteOptimized().

◆ segments

std::vector<SegmentGeoBox> osmscout::Way::segments

Precomputed (cache) segment bounding boxes for optimisation.

Referenced by Read(), and ReadOptimized().

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

Public Member Functions

Public Attributes

Constructor & Destructor Documentation

◆ Way()

Member Function Documentation

◆ GetBack()

◆ GetBackId()

◆ GetBoundingBox()

◆ GetCenter()

◆ GetCoord()

◆ GetFeature()

◆ GetFeatureCount()

◆ GetFeatureValue()

◆ GetFeatureValueBuffer()

◆ GetFileOffset()

◆ GetFront()

◆ GetFrontId()

◆ GetId()

◆ GetNextFileOffset()

◆ GetNodeIndexByNodeId()

◆ GetObjectFileRef()

◆ GetPoint()

◆ GetSerial()

◆ GetType()

◆ HasFeature()

◆ Intersects()

◆ IsCircular()

◆ IsValid()

◆ Read()

◆ ReadOptimized()

◆ SetFeatures()

◆ SetType()

◆ UnsetFeature()

◆ Write()

◆ WriteOptimized()

Member Data Documentation

◆ bbox

◆ nodes

◆ segments