Namespaces
	ConstLineStringImpl

	detail

	geometry

	helper

	impl

	internal

	io

	io_handlers

	osm

	projection

	test_cases

	test_setup

	traits

	units

	utils

Classes
class	AllWayStop

struct	ArcCoordinates

class	Area

class	AreaData

class	AreaLayer

class	Attribute

struct	AttributeNamesString

struct	AttributeValueString

class	BasicPolygon2d

class	BasicPolygon3d

class	BasicPolygonWithHoles2d

class	BasicPolygonWithHoles3d

class	BoundingBox2d

class	CompoundHybridLineString2d

class	CompoundHybridLineString3d

class	CompoundHybridPolygon2d

class	CompoundHybridPolygon3d

class	CompoundLineString2d

class	CompoundLineString3d

class	CompoundLineStringData

class	CompoundLineStringImpl

class	CompoundPolygon2d

class	CompoundPolygon3d

class	ConstArea

class	ConstHybridLineString2d

class	ConstHybridLineString3d

class	ConstHybridPolygon2d

class	ConstHybridPolygon3d

class	ConstLanelet

class	ConstLaneletOrArea

struct	ConstLaneletWithStopLine

class	ConstLineString2d

class	ConstLineString3d

class	ConstLineStringImpl

class	ConstLineStringOrPolygon3d

class	ConstPoint2d

class	ConstPoint3d

class	ConstPolygon2d

class	ConstPolygon3d

class	ConstPrimitive

class	ConstWeakArea

class	ConstWeakLanelet

class	DefaultProjectionNotAllowedError
	Thrown when a user attempts to load a map with georeferenced data without providing an origin. More...

class	FileNotFoundError
	Error for not existent filepaths. More...

class	ForwardProjectionError
	Thrown by the projector classes if projection from lat/lon to x/y fails. More...

class	GenericRegulatoryElement

class	GeometryError

class	GPSPoint

struct	HashBase

class	HybridMap

class	InvalidInputError

class	InvalidObjectStateError

class	IOError
	Generic error for all errors in this module. More...

class	Lanelet

class	LaneletData

class	LaneletError

class	LaneletLayer

class	LaneletMap

class	LaneletMapLayers

class	LaneletMultiError

class	LaneletSequence

class	LaneletSequenceData

class	LaneletSubmap

struct	LaneletWithStopLine

class	LineString2d

class	LineString3d

class	LineStringData

class	LineStringImpl

class	LineStringOrPolygon3d

class	LineStringOrPolygonBase

class	NoSuchAttributeError

class	NoSuchPrimitiveError

class	NullptrError

struct	Origin

class	ParseError
	Error thrown if some error occured during the parsing of the file. More...

struct	Participants

class	Point2d

class	Point3d

class	PointData

class	Polygon2d

class	Polygon3d

class	Primitive

class	PrimitiveData

class	PrimitiveLayer

class	Projector

class	RegisterRegulatoryElement

class	RegulatoryElement

class	RegulatoryElementData

class	RegulatoryElementFactory

class	ReverseProjectionError
	Thrown by the projector classes if projection from x/y to lat/lon fails. More...

class	RightOfWay

struct	RoleNameString

class	RuleParameterVisitor

class	SpeedLimit

class	TrafficLight

class	TrafficSign

struct	TrafficSignsWithType

class	UnsupportedExtensionError
	Error for an unsupported extension. More...

class	UnsupportedIOHandlerError
	Error thrown if an unsupported handler (parser/writer) has been specified. More...

struct	UsageLookup

struct	UsageLookup< Area >

struct	UsageLookup< Lanelet >

struct	UsageLookup< Point3d >

struct	UsageLookup< RegulatoryElementPtr >

class	WeakArea

class	WeakLanelet

class	WriteError
	Error thown if some error occurd during writing of a map. More...

Typedefs
typedef units::MPS2Quantity	Acceleration

typedef std::shared_ptr< const AreaData >	AreaDataConstPtr

typedef std::vector< AreaDataConstPtr >	AreaDataConstPtrs

typedef std::shared_ptr< AreaData >	AreaDataPtr

typedef std::weak_ptr< AreaData >	AreaDataptr

typedef std::vector< AreaDataPtr >	AreaDataPtrs

typedef std::vector< Area >	Areas

typedef HybridMap< Attribute, decltype(AttributeNamesString::Map)&, AttributeNamesString::Map >	AttributeMap

typedef std::pair< const char *, const AttributeName >	AttributeNamesItem

typedef BasicPoints2d	BasicLineString2d

typedef BasicPoints3d	BasicLineString3d

typedef Eigen::Matrix< double, 2, 1, Eigen::DontAlign >	BasicPoint2d

typedef Eigen::Vector3d	BasicPoint3d

typedef std::vector< Eigen::Vector2d, Eigen::aligned_allocator< Eigen::Vector2d > >	BasicPoints2d

typedef std::vector< BasicPoint3d >	BasicPoints3d

typedef std::vector< BasicPolygon2d >	BasicPolygons2d

typedef std::vector< BasicPolygon3d >	BasicPolygons3d

typedef std::vector< BasicPolygonWithHoles2d >	BasicPolygonsWithHoles2d

typedef std::vector< BasicPolygonWithHoles3d >	BasicPolygonsWithHoles3d

typedef Segment< BasicPoint2d >	BasicSegment2d

typedef Segment< BasicPoint3d >	BasicSegment3d

typedef Eigen::AlignedBox3d	BoundingBox3d

typedef std::vector< CompoundHybridLineString2d >	CompoundHybridLineStrings2d

typedef std::vector< CompoundHybridLineString3d >	CompoundHybridLineStrings3d

typedef std::vector< CompoundHybridPolygon2d >	CompoundHybridPolygons2d

typedef std::vector< CompoundHybridPolygon3d >	CompoundHybridPolygons3d

typedef std::shared_ptr< const CompoundLineStringData >	CompoundLineStringDataConstPtr

typedef std::vector< CompoundLineStringDataConstPtr >	CompoundLineStringDataConstPtrs

typedef std::shared_ptr< CompoundLineStringData >	CompoundLineStringDataPtr

typedef std::vector< CompoundLineStringDataPtr >	CompoundLineStringDataPtrs

typedef std::vector< CompoundLineString2d >	CompoundLineStrings2d

typedef std::vector< CompoundLineString3d >	CompoundLineStrings3d

typedef std::vector< CompoundPolygon2d >	CompoundPolygons2d

typedef std::vector< CompoundPolygon3d >	CompoundPolygons3d

typedef std::vector< ConstArea >	ConstAreas

typedef std::vector< ConstHybridLineString2d >	ConstHybridLineStrings2d

typedef std::vector< ConstHybridLineString3d >	ConstHybridLineStrings3d

typedef std::vector< ConstHybridPolygon2d >	ConstHybridPolygons2d

typedef std::vector< ConstHybridPolygon3d >	ConstHybridPolygons3d

typedef std::vector< ConstLineStrings3d >	ConstInnerBounds

typedef std::vector< ConstLaneletOrArea >	ConstLaneletOrAreas

typedef std::vector< ConstLanelet >	ConstLanelets

typedef std::vector< ConstLineString2d >	ConstLineStrings2d

typedef std::vector< ConstLineString3d >	ConstLineStrings3d

typedef std::vector< ConstLineStringOrPolygon3d >	ConstLineStringsOrPolygons3d

typedef std::vector< ConstPoint2d >	ConstPoints2d

typedef std::vector< ConstPoint3d >	ConstPoints3d

typedef std::vector< ConstPolygon2d >	ConstPolygons2d

typedef std::vector< ConstPolygon3d >	ConstPolygons3d

typedef boost::variant< ConstPoint3d, ConstLineString3d, ConstPolygon3d, ConstWeakLanelet, ConstWeakArea >	ConstRuleParameter

typedef HybridMap< ConstRuleParameters, decltype(RoleNameString::Map)&, RoleNameString::Map >	ConstRuleParameterMap

typedef std::vector< ConstRuleParameter >	ConstRuleParameters

typedef Segment< ConstPoint2d >	ConstSegment2d

typedef Segment< ConstPoint3d >	ConstSegment3d

using	DefaultProjector = projection::SphericalMercatorProjector

using	ErrorMessages = std::vector< std::string >

typedef std::vector< GPSPoint >	GPSPoints

typedef int64_t	Id

typedef std::vector< Id >	Ids

typedef std::enable_if_t< traits::isAreaT< T >(), RetT >	IfAr

typedef std::enable_if_t< traits::isLaneletT< T >(), RetT >	IfLL

typedef std::enable_if_t< traits::isLinestringT< T >(), RetT >	IfLS

typedef std::enable_if_t< traits::isLinestringT< T1 >() &&traits::isLinestringT< T2 >(), RetT >	IfLS2

typedef std::enable_if_t< traits::isPolygonT< T >(), RetT >	IfPoly

typedef std::enable_if_t< traits::isPointT< T >(), RetT >	IfPT

typedef std::enable_if_t< traits::isRegulatoryElementT< T >(), RetT >	IfRE

typedef std::vector< LineStrings3d >	InnerBounds

typedef std::shared_ptr< const LaneletData >	LaneletDataConstPtr

typedef std::vector< LaneletDataConstPtr >	LaneletDataConstPtrs

typedef std::weak_ptr< const LaneletData >	LaneletDataConstWptr

typedef std::vector< LaneletDataConstWptr >	LaneletDataConstWptrs

typedef std::shared_ptr< LaneletData >	LaneletDataPtr

typedef std::weak_ptr< LaneletData >	LaneletDataptr

typedef std::vector< LaneletDataPtr >	LaneletDataPtrs

typedef std::shared_ptr< const LaneletMap >	LaneletMapConstPtr

typedef std::vector< LaneletMapConstPtr >	LaneletMapConstPtrs

typedef std::unique_ptr< const LaneletMap >	LaneletMapConstUPtr

typedef std::shared_ptr< LaneletMap >	LaneletMapPtr

typedef std::vector< LaneletMapPtr >	LaneletMapPtrs

typedef std::unique_ptr< LaneletMap >	LaneletMapUPtr

typedef std::vector< Lanelet >	Lanelets

typedef std::shared_ptr< const LaneletSequenceData >	LaneletSequenceDataConstPtr

typedef std::vector< LaneletSequenceDataConstPtr >	LaneletSequenceDataConstPtrs

typedef std::shared_ptr< LaneletSequenceData >	LaneletSequenceDataPtr

typedef std::vector< LaneletSequenceDataPtr >	LaneletSequenceDataPtrs

typedef std::vector< LaneletSequence >	LaneletSequences

typedef std::shared_ptr< const LaneletSubmap >	LaneletSubmapConstPtr

typedef std::vector< LaneletSubmapConstPtr >	LaneletSubmapConstPtrs

typedef std::unique_ptr< const LaneletSubmap >	LaneletSubmapConstUPtr

typedef std::shared_ptr< LaneletSubmap >	LaneletSubmapPtr

typedef std::vector< LaneletSubmapPtr >	LaneletSubmapPtrs

typedef std::unique_ptr< LaneletSubmap >	LaneletSubmapUPtr

typedef std::vector< LaneletWithStopLine >	LaneletsWithStopLines

typedef std::shared_ptr< const LineStringData >	LineStringDataConstPtr

typedef std::vector< LineStringDataConstPtr >	LineStringDataConstPtrs

typedef std::shared_ptr< LineStringData >	LineStringDataPtr

typedef std::vector< LineStringDataPtr >	LineStringDataPtrs

typedef PrimitiveLayer< LineString3d >	LineStringLayer

typedef std::vector< LineString2d >	LineStrings2d

typedef std::vector< LineString3d >	LineStrings3d

typedef std::vector< LineStringOrPolygon3d >	LineStringsOrPolygons3d

typedef boost::optional< double >	OptDistance

typedef boost::optional< T >	Optional

typedef std::shared_ptr< const PointData >	PointDataConstPtr

typedef std::vector< PointDataConstPtr >	PointDataConstPtrs

typedef std::shared_ptr< PointData >	PointDataPtr

typedef std::vector< PointDataPtr >	PointDataPtrs

typedef PrimitiveLayer< Point3d >	PointLayer

typedef std::vector< Point2d >	Points2d

typedef std::vector< Point3d >	Points3d

typedef PrimitiveLayer< Polygon3d >	PolygonLayer

typedef std::vector< Polygon2d >	Polygons2d

typedef std::vector< Polygon3d >	Polygons3d

typedef std::shared_ptr< const PrimitiveData >	PrimitiveDataConstPtr

typedef std::vector< PrimitiveDataConstPtr >	PrimitiveDataConstPtrs

typedef std::shared_ptr< PrimitiveData >	PrimitiveDataPtr

typedef std::vector< PrimitiveDataPtr >	PrimitiveDataPtrs

typedef std::shared_ptr< const RegulatoryElement >	RegulatoryElementConstPtr

typedef std::vector< RegulatoryElementConstPtr >	RegulatoryElementConstPtrs

typedef std::shared_ptr< const RegulatoryElementData >	RegulatoryElementDataConstPtr

typedef std::vector< RegulatoryElementDataConstPtr >	RegulatoryElementDataConstPtrs

typedef std::shared_ptr< RegulatoryElementData >	RegulatoryElementDataPtr

typedef std::vector< RegulatoryElementDataPtr >	RegulatoryElementDataPtrs

typedef PrimitiveLayer< RegulatoryElementPtr >	RegulatoryElementLayer

typedef std::shared_ptr< RegulatoryElement >	RegulatoryElementPtr

typedef std::vector< RegulatoryElementPtr >	RegulatoryElementPtrs

typedef boost::variant< Point3d, LineString3d, Polygon3d, WeakLanelet, WeakArea >	RuleParameter

typedef HybridMap< RuleParameters, decltype(RoleNameString::Map)&, RoleNameString::Map >	RuleParameterMap

typedef std::vector< RuleParameter >	RuleParameters

typedef std::pair< PointT, PointT >	Segment

typedef Segment< Point2d >	Segment2d

typedef Segment< Point3d >	Segment3d

typedef units::MPSQuantity	Velocity

Enumerations
enum	AttributeName { AttributeName::Type, AttributeName::Subtype, AttributeName::OneWay, AttributeName::ParticipantVehicle, AttributeName::ParticipantPedestrian, AttributeName::SpeedLimit, AttributeName::Location, AttributeName::Dynamic }

enum	LaneletType { LaneletType::OneWay, LaneletType::Bidirectional }

enum	ManeuverType { ManeuverType::Yield, ManeuverType::RightOfWay, ManeuverType::Unknown }

enum	RoleName { RoleName::Refers, RoleName::RefLine, RoleName::RightOfWay, RoleName::Yield, RoleName::Cancels, RoleName::CancelLine }

Functions
Optional< std::string >	Attribute::as< Optional< std::string > > () const

Optional< std::string >	Attribute::as< std::string > () const

DefaultProjector	defaultProjection (Origin origin=Origin::defaultOrigin())

std::unique_ptr< LaneletMap >	load (const std::string &filename, const Origin &origin=Origin::defaultOrigin(), ErrorMessages *errors=nullptr, const io::Configuration &params=io::Configuration())
	Loads a lanelet map from a file. More...

std::unique_ptr< LaneletMap >	load (const std::string &filename, const Projector &projector, ErrorMessages *errors=nullptr, const io::Configuration &params=io::Configuration())
	Loads a lanelet map from a file. More...

std::unique_ptr< LaneletMap >	load (const std::string &filename, const std::string &parserName, const Origin &origin=Origin::defaultOrigin(), ErrorMessages *errors=nullptr, const io::Configuration &params=io::Configuration())
	Loads a lanelet map from a file. More...

std::unique_ptr< LaneletMap >	load (const std::string &filename, const std::string &parserName, const Projector &projector, ErrorMessages *errors=nullptr, const io::Configuration &params=io::Configuration())
	Loads a lanelet map from file. More...

bool	operator!= (const Attribute &lhs, const Attribute &rhs)

bool	operator!= (const CompoundLineStringImpl< Point1T > &lhs, const CompoundLineStringImpl< Point2T > &rhs)

bool	operator!= (const CompoundLineStringImpl< Point1T > &lhs, const std::vector< Point2T > &rhs)

bool	operator!= (const ConstArea &lhs, const ConstArea &rhs)

bool	operator!= (const ConstLanelet &lhs, const ConstLanelet &rhs)

bool	operator!= (const ConstLaneletOrArea &lhs, const ConstLaneletOrArea &rhs)

bool	operator!= (const ConstLineStringImpl< LhsPointT > &lhs, const ConstLineStringImpl< RhsPointT > &rhs)

bool	operator!= (const ConstLineStringImpl< PointT > &lhs, const std::vector< PointT > &rhs)

bool	operator!= (const ConstLineStringOrPolygon3d &lhs, const ConstLineStringOrPolygon3d &rhs)

bool	operator!= (const ConstWeakArea &lhs, const ConstWeakArea &rhs)

bool	operator!= (const ConstWeakLanelet &lhs, const ConstWeakLanelet &rhs)

bool	operator!= (const LaneletSequence &lhs, const LaneletSequence &rhs)

bool	operator!= (const LineStringOrPolygon3d &lhs, const LineStringOrPolygon3d &rhs)

bool	operator!= (const std::vector< Point1T > &lhs, const CompoundLineStringImpl< Point2T > &rhs)

bool	operator!= (const std::vector< PointT > &lhs, const ConstLineStringImpl< PointT > &rhs)

std::ostream &	operator<< (std::ostream &stream, const Attribute &obj)

std::ostream &	operator<< (std::ostream &stream, const AttributeMap &obj)

std::ostream &	operator<< (std::ostream &stream, const CompoundLineStringImpl< PointT > &obj)

std::ostream &	operator<< (std::ostream &stream, const ConstArea &obj)

std::ostream &	operator<< (std::ostream &stream, const ConstLanelet &obj)

std::ostream &	operator<< (std::ostream &stream, const ConstLaneletOrArea &obj)

std::ostream &	operator<< (std::ostream &stream, const ConstLineString2d &obj)

std::ostream &	operator<< (std::ostream &stream, const ConstLineString3d &obj)

std::ostream &	operator<< (std::ostream &stream, const ConstLineStringOrPolygon3d &obj)

std::ostream &	operator<< (std::ostream &stream, const ConstPoint2d &obj)

std::ostream &	operator<< (std::ostream &stream, const ConstPoint3d &obj)

std::ostream &	operator<< (std::ostream &stream, const ConstPolygon2d &obj)

std::ostream &	operator<< (std::ostream &stream, const ConstPolygon3d &obj)

std::ostream &	operator<< (std::ostream &stream, const LaneletSequence &obj)

std::ostream &	operator<< (std::ostream &stream, const LineStringOrPolygon3d &obj)

std::ostream &	operator<< (std::ostream &stream, const Point2d &obj)

std::ostream &	operator<< (std::ostream &stream, const Point3d &obj)

std::ostream &	operator<< (std::ostream &stream, const RegulatoryElement &obj)

std::ostream &	operator<< (std::ostream &stream, HybridMap< Value, Enum, Lookup > map)

bool	operator== (const AreaData &lhs, const AreaData &rhs)

bool	operator== (const Attribute &lhs, const Attribute &rhs)

bool	operator== (const CompoundLineStringImpl< Point1T > &lhs, const CompoundLineStringImpl< Point2T > &rhs)

bool	operator== (const CompoundLineStringImpl< Point1T > &lhs, const std::vector< Point2T > &rhs)

bool	operator== (const ConstArea &lhs, const ConstArea &rhs)

bool	operator== (const ConstLanelet &lhs, const ConstLanelet &rhs)

bool	operator== (const ConstLaneletOrArea &lhs, const ConstLaneletOrArea &rhs)

bool	operator== (const ConstLineStringImpl< LhsPointT > &lhs, const ConstLineStringImpl< RhsPointT > &rhs)

bool	operator== (const ConstLineStringImpl< PointT > &lhs, const std::vector< PointT > &rhs)

bool	operator== (const ConstLineStringOrPolygon3d &lhs, const ConstLineStringOrPolygon3d &rhs)

bool	operator== (const ConstWeakArea &lhs, const ConstWeakArea &rhs)

bool	operator== (const ConstWeakLanelet &lhs, const ConstWeakLanelet &rhs)

bool	operator== (const LaneletData &lhs, const LaneletData &rhs)

bool	operator== (const LaneletMap &rhs, const LaneletMap &lhs)

bool	operator== (const LaneletSequence &lhs, const LaneletSequence &rhs)

bool	operator== (const LineStringData &lhs, const LineStringData &rhs)

bool	operator== (const LineStringOrPolygon3d &lhs, const LineStringOrPolygon3d &rhs)

bool	operator== (const PointData &lhs, const PointData &rhs)

template<typename T >
bool	operator== (const PrimitiveLayer< T > &rhs, const PrimitiveLayer< T > &lhs)

bool	operator== (const RegulatoryElementData &rhs, const RegulatoryElementData &lhs)

bool	operator== (const std::vector< Point1T > &lhs, const CompoundLineStringImpl< Point2T > &rhs)

bool	operator== (const std::vector< PointT > &lhs, const ConstLineStringImpl< PointT > &rhs)

template<>
bool	operator==<RegulatoryElementPtr > (const PrimitiveLayer< RegulatoryElementPtr > &rhs, const PrimitiveLayer< RegulatoryElementPtr > &lhs)

std::vector< std::string >	supportedParserExtensions ()

std::vector< std::string >	supportedParsers ()
	returns the names of the currently registered parsers (parsers from plugins included) More...

std::vector< std::string >	supportedWriterExtensions ()
	returns the names of the currently supported extensions for writing (including the dot) More...

std::vector< std::string >	supportedWriters ()
	returns the names of the currently registered writing (writers from plugins included) More...

void	write (const std::string &filename, const lanelet::LaneletMap &map, const Origin &origin=Origin::defaultOrigin(), ErrorMessages *errors=nullptr, const io::Configuration &params=io::Configuration())
	writes a map to a file More...

void	write (const std::string &filename, const lanelet::LaneletMap &map, const std::string &writerName, const Origin &origin=Origin::defaultOrigin(), ErrorMessages *errors=nullptr, const io::Configuration &params=io::Configuration())
	writes a map to a file More...

void	write (const std::string &filename, const LaneletMap &map, const Projector &projector, ErrorMessages *errors=nullptr, const io::Configuration &params=io::Configuration())
	writes a map to a file More...

void	write (const std::string &filename, const LaneletMap &map, const std::string &writerName, const Projector &projector, ErrorMessages *errors=nullptr, const io::Configuration &params=io::Configuration())
	writes a map to a file More...

Variables
static RegisterRegulatoryElement< GenericRegulatoryElement >	genRegelem

constexpr Id	InvalId

static RegisterRegulatoryElement< AllWayStop >	regAllWayStop

static RegisterRegulatoryElement< RightOfWay >	regRightOfWay

static RegisterRegulatoryElement< SpeedLimit >	regSpeedLimit

static RegisterRegulatoryElement< TrafficLight >	regTraffic

static RegisterRegulatoryElement< TrafficSign >	regTrafficSign

Typedef Documentation

◆ DefaultProjector

using lanelet::DefaultProjector = typedef projection::SphericalMercatorProjector

Definition at line 76 of file Projection.h.

◆ ErrorMessages

typedef std::vector< std::string > lanelet::ErrorMessages

Definition at line 11 of file Io.h.

Function Documentation

◆ defaultProjection()

DefaultProjector lanelet::defaultProjection ( Origin origin = Origin::defaultOrigin() )

inline

Definition at line 78 of file Projection.h.

◆ load() [1/4]

std::unique_ptr< LaneletMap > lanelet::load	(	const std::string &	filename,
		const Origin &	origin = `Origin::defaultOrigin()`,
		ErrorMessages *	errors = `nullptr`,
		const io::Configuration &	params = `io::Configuration()`
	)

Loads a lanelet map from a file.

Parameters

filename	name to load from. The extension decides how the file will be parsed.
origin	origin for the lat/lon -> x/y conversion. This must not be the default origin if the specified format requires an origin (e.g. you must always provide an origin if you load .osm data).
errors	if this points to a valid object, errors occured during parsing the map will be passed via this parameter. If this is nullptr, an exception will be thrown if errors have occurred.
params	optional params for loading. It depends on the parser that is used which parameters are required. If no params are passed, default values will be used

Returns: Loaded map. Pointer is aways valid. Otherwise, an exception will be thrown

Exceptions

lanelet2::IOError if the file did not exist, could not be parsed or extension is not supported. If errors is not null, the loader will instead try to recover and only throw on unrecoverable errors (ie if the map did not exist). However, the loaded map will be incomplete if errors occurred. The loader will also throw if you did not provide a valid origin for a map that requires an origin for projections.

It can not be stressed enough that it is important to provide a valid origin to write/load maps with georeferenced (lat/lon) data. If no origin is specified, the loaded map will most likely be not correctly located and deformed.

Definition at line 24 of file Io.cpp.

◆ load() [2/4]

std::unique_ptr< LaneletMap > lanelet::load	(	const std::string &	filename,
		const Projector &	projector,
		ErrorMessages *	errors = `nullptr`,
		const io::Configuration &	params = `io::Configuration()`
	)

Loads a lanelet map from a file.

Parameters

filename	name to load from. The extension decides how the file will be parsed.
projector	projection object for the transformations used
errors	if not null, errors will be reported here instead of throwing
params	optional params for loading. It depends on the parser that is used which parameters are required. If no params are passed, default values will be used

Returns: Loaded map. Pointer is aways valid. Otherwise, an exception will be thrown

Exceptions

lanelet2::IOError if the file did not exist, could not be parsed or extension is not supported. If errors is not null, the loader will instead try to recover and only throw on unrecoverable errors (ie if the map did not exist). However, the loaded map will be incomplete if errors occurred.

Definition at line 29 of file Io.cpp.

◆ load() [3/4]

std::unique_ptr< LaneletMap > lanelet::load	(	const std::string &	filename,
		const std::string &	parserName,
		const Origin &	origin = `Origin::defaultOrigin()`,
		ErrorMessages *	errors = `nullptr`,
		const io::Configuration &	params = `io::Configuration()`
	)

Loads a lanelet map from a file.

Parameters

filename	name to load from
parserName	name of the parser to use. Available parsers can be queried with supportedParsers()
origin	origin for the lat/lon -> x/y conversion. This must not be the default origin if the specified format requires an origin (e.g. you must always provide an origin if you load .osm data).
errors	if this points to a valid object, errors occured during parsing the map will be passed via this parameter. If this is nullptr, an exception will be thrown if errors have occurred.
params	optional params for loading. It depends on the parser that is used which parameters are required. If no params are passed, default values will be used

Returns: Loaded map. Pointer is aways valid. Otherwise, an exception will be thrown

Exceptions

lanelet2::IOError if the file did not exist, could not be parsed, the default origin was provided for a map that requires osm conversion or extension is not supported

Definition at line 41 of file Io.cpp.

◆ load() [4/4]

std::unique_ptr< LaneletMap > lanelet::load	(	const std::string &	filename,
		const std::string &	parserName,
		const Projector &	projector,
		ErrorMessages *	errors = `nullptr`,
		const io::Configuration &	params = `io::Configuration()`
	)

Loads a lanelet map from file.

Parameters

filename	name to load from
parserName	name of the parser to use. Available parsers can be queried with supportedParsers()
errors	if this points to a valid object, errors occured during parsing the map will be passed via this parameter. If this is nullptr, an exception will be thrown if errors have occurred.
projector	projection object for the transformations
params	optional params for loading. It depends on the parser that is used which parameters are required. If no params are passed, default values will be used

Returns: Loaded map. Pointer is aways valid. Otherwise, an exception will be thrown

Exceptions

lanelet2::IOError if the file did not exist, could not be parsed or extension is not supported

Definition at line 46 of file Io.cpp.

◆ operator==() [1/7]

bool lanelet::operator==	(	const AreaData &	lhs,
		const AreaData &	rhs
	)

inline

Definition at line 34 of file TestSetup.h.

◆ operator==() [2/7]

bool lanelet::operator==	(	const LaneletData &	lhs,
		const LaneletData &	rhs
	)

inline

Definition at line 24 of file TestSetup.h.

◆ operator==() [3/7]

bool lanelet::operator==	(	const LaneletMap &	rhs,
		const LaneletMap &	lhs
	)

inline

Definition at line 62 of file TestSetup.h.

◆ operator==() [4/7]

bool lanelet::operator==	(	const LineStringData &	lhs,
		const LineStringData &	rhs
	)

inline

Definition at line 16 of file TestSetup.h.

◆ operator==() [5/7]

bool lanelet::operator==	(	const PointData &	lhs,
		const PointData &	rhs
	)

inline

Definition at line 12 of file TestSetup.h.

◆ operator==() [6/7]

template<typename T >

bool lanelet::operator==	(	const PrimitiveLayer< T > &	rhs,
		const PrimitiveLayer< T > &	lhs
	)

inline

Definition at line 48 of file TestSetup.h.

◆ operator==() [7/7]

bool lanelet::operator==	(	const RegulatoryElementData &	rhs,
		const RegulatoryElementData &	lhs
	)

inline

Definition at line 21 of file TestSetup.h.

◆ operator==<RegulatoryElementPtr >()

template<>

bool lanelet::operator==<RegulatoryElementPtr >	(	const PrimitiveLayer< RegulatoryElementPtr > &	rhs,
		const PrimitiveLayer< RegulatoryElementPtr > &	lhs
	)

inline

Definition at line 55 of file TestSetup.h.

◆ supportedParserExtensions()

std::vector< std::string > lanelet::supportedParserExtensions ( )

Definition at line 59 of file Io.cpp.

◆ supportedParsers()

std::vector< std::string > lanelet::supportedParsers ( )

returns the names of the currently registered parsers (parsers from plugins included)

Returns: list of names

Definition at line 57 of file Io.cpp.

◆ supportedWriterExtensions()

std::vector< std::string > lanelet::supportedWriterExtensions ( )

returns the names of the currently supported extensions for writing (including the dot)

Returns: list of extensions

Definition at line 84 of file Io.cpp.

◆ supportedWriters()

std::vector< std::string > lanelet::supportedWriters ( )

returns the names of the currently registered writing (writers from plugins included)

Returns: list of names

Definition at line 82 of file Io.cpp.

◆ write() [1/4]

void lanelet::write	(	const std::string &	filename,
		const lanelet::LaneletMap &	map,
		const Origin &	origin = `Origin::defaultOrigin()`,
		ErrorMessages *	errors = `nullptr`,
		const io::Configuration &	params = `io::Configuration()`
	)

writes a map to a file

Parameters

filename	file to write to (parent folders must exist!)
map	map to be written
origin	origin for x,y -> lat/lon conversion. You will receive a warning if you try to write to a format that requires lat/lon conversion and passed the defaultOrigin.
errors	if this points to a valid object, errors occured during write will be passed via this parameter. If this is nullptr, an exception will be thrown if errors have occurred.
params	extra parameters for the writer (if required). If empty, default parameters will be used.

Exceptions

lanelet2::IOError if the file could not be created or writing failed. If errors is not null, the writer will instead try to recover and only throw on unrecoverable errors (ie if the file could not be created). However, the written map will be incomplete if errors occurred.

It can not be stressed enough that it is important to provide a valid origin to write/load maps with georeferenced (lat/lon) data. If no origin is specified, the written map will most likely be not correctly located and deformed.

Definition at line 61 of file Io.cpp.

◆ write() [2/4]

void lanelet::write	(	const std::string &	filename,
		const lanelet::LaneletMap &	map,
		const std::string &	writerName,
		const Origin &	origin = `Origin::defaultOrigin()`,
		ErrorMessages *	errors = `nullptr`,
		const io::Configuration &	params = `io::Configuration()`
	)

writes a map to a file

Parameters

filename	file to write to (parent folders must exist!). The extension is used to deduce the format.
map	map to be written
writerName	name of the writer format to use. Available writers can be queried with supportedWriters().
errors	if this points to a valid object, errors occured during write will be passed via this parameter. If this is nullptr, an exception will be thrown if errors have occurred.
origin	origin definition for x,y -> lat/lon conversion
params	extra parameters for the writer (if required). If empty, default parameters will be used.

Exceptions

lanelet2::IOError if the file could not be created or writing failed.

Definition at line 71 of file Io.cpp.

◆ write() [3/4]

void lanelet::write	(	const std::string &	filename,
		const LaneletMap &	map,
		const Projector &	projector,
		ErrorMessages *	errors = `nullptr`,
		const io::Configuration &	params = `io::Configuration()`
	)

writes a map to a file

Parameters

filename	file to write to (parent folders must exist!). The extension is used to deduce the format.
map	map to be written
projector	projector object for x,y -> lat/lon conversion. You will receive a warning if you try to write to a format that requires lat/lon conversion and passed the defaultOrigin.
errors	if this points to a valid object, errors occured during write will be passed via this parameter. If this is nullptr, an exception will be thrown if errors have occurred.
params	extra parameters for the writer (if required). If empty, default parameters will be used.

Exceptions

lanelet2::IOError if the file could not be created or writing failed.

Definition at line 65 of file Io.cpp.

◆ write() [4/4]

void lanelet::write	(	const std::string &	filename,
		const LaneletMap &	map,
		const std::string &	writerName,
		const Projector &	projector,
		ErrorMessages *	errors = `nullptr`,
		const io::Configuration &	params = `io::Configuration()`
	)

writes a map to a file

Parameters

filename	file to write to (parent folders must exist!). The extension is used to deduce the format.
map	map to be written
writerName	name of the writer format to use. Available writers can be queried with supportedWriters().
projector	projector object for x,y -> lat/lon conversion
errors	if this points to a valid object, errors occured during write will be passed via this parameter. If this is nullptr, an exception will be thrown if errors have occurred.
params	extra parameters for the writer (if required). If empty, default parameters will be used.

Exceptions

lanelet2::IOError if the file could not be created or writing failed.

Definition at line 75 of file Io.cpp.

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ DefaultProjector

◆ ErrorMessages

Function Documentation

◆ defaultProjection()

◆ load() [1/4]

◆ load() [2/4]

◆ load() [3/4]

◆ load() [4/4]

◆ operator==() [1/7]

◆ operator==() [2/7]

◆ operator==() [3/7]

◆ operator==() [4/7]

◆ operator==() [5/7]

◆ operator==() [6/7]

◆ operator==() [7/7]

◆ operator==<RegulatoryElementPtr >()

◆ supportedParserExtensions()

◆ supportedParsers()

◆ supportedWriterExtensions()

◆ supportedWriters()

◆ write() [1/4]

◆ write() [2/4]

◆ write() [3/4]

◆ write() [4/4]