An immutable 2d point. More...

#include <Point.h>

Inheritance diagram for lanelet::ConstPoint2d:

[legend]

Public Types
using	BasicPoint = BasicPoint2d
	returned basic point type More...

using	Category = traits::PointTag

using	ConstType = ConstPoint2d

using	MutableType = Point2d

using	ThreeDType = ConstPoint3d

using	TwoDType = ConstPoint2d

Public Types inherited from lanelet::ConstPrimitive< PointData >
using	DataType = PointData

Public Member Functions
const BasicPoint &	basicPoint () const noexcept
	Get an Eigen point for faster calculations. More...

const BasicPoint2d &	basicPoint2d () const noexcept

	ConstPoint2d (Id id, const BasicPoint3d &point, const AttributeMap &attributes=AttributeMap())
	Construct from an id and a point. More...

	ConstPoint2d (Id id=InvalId, double x=0., double y=0., double z=0., const AttributeMap &attributes=AttributeMap())
	Construct from an id and coordinates. More...

	ConstPrimitive (const ConstPrimitive &rhs)=default

	ConstPrimitive (const std::shared_ptr< const Data > &data)
	Construct from a pointer to the data. More...

	ConstPrimitive (ConstPrimitive &&rhs) noexcept=default

	operator BasicPoint2d () const noexcept
	A ConstPoint 2d is implicitly convertible to a normal 2d point. More...

double	x () const noexcept
	gets x coordinate More...

double	y () const noexcept
	gets y coordinate More...

Public Member Functions inherited from lanelet::ConstPrimitive< PointData >
const Attribute &	attribute (AttributeName name) const
	retrieve an attribute (enum version) More...

const Attribute &	attribute (const std::string &name) const
	retrieve an attribute More...

T	attributeOr (AttributeName name, T defaultVal) const
	retrieve an attribute (enum version) More...

T	attributeOr (const std::string &name, T defaultVal) const noexcept
	retrieve an attribute (string version) More...

const AttributeMap &	attributes () const
	get the attributes of this primitive More...

const std::shared_ptr< const PointData > &	constData () const
	get the internal data of this primitive More...

	ConstPrimitive (const std::shared_ptr< const PointData > &data)
	Construct from a pointer to the data. More...

bool	hasAttribute (AttributeName name) const noexcept
	check for an attribute (enum version) More...

bool	hasAttribute (const std::string &name) const noexcept
	check whether this primitive has a specific attribute More...

Id	id () const noexcept
	get the unique id of this primitive More...

bool	operator!= (const ConstPrimitive &rhs) const

bool	operator== (const ConstPrimitive &rhs) const

Static Public Attributes
static constexpr traits::Dimensions	Dimension = traits::Dimensions::Two

Static Public Attributes inherited from lanelet::ConstPrimitive< PointData >
static constexpr bool	IsConst

Protected Member Functions
const BasicPoint3d &	point () const

const BasicPoint2d &	point2d () const

Protected Member Functions inherited from lanelet::ConstPrimitive< PointData >
	ConstPrimitive (const ConstPrimitive &rhs)=default

	ConstPrimitive (ConstPrimitive &&rhs) noexcept=default

ConstPrimitive &	operator= (const ConstPrimitive &rhs)=default

ConstPrimitive &	operator= (ConstPrimitive &&rhs) noexcept=default

	~ConstPrimitive () noexcept=default

Detailed Description

An immutable 2d point.

Definition at line 150 of file primitives/Point.h.

Member Typedef Documentation

◆ BasicPoint

using lanelet::ConstPoint2d::BasicPoint = BasicPoint2d

returned basic point type

Definition at line 152 of file primitives/Point.h.

◆ Category

using lanelet::ConstPoint2d::Category = traits::PointTag

Definition at line 157 of file primitives/Point.h.

◆ ConstType

using lanelet::ConstPoint2d::ConstType = ConstPoint2d

Definition at line 153 of file primitives/Point.h.

◆ MutableType

using lanelet::ConstPoint2d::MutableType = Point2d

Definition at line 154 of file primitives/Point.h.

◆ ThreeDType

using lanelet::ConstPoint2d::ThreeDType = ConstPoint3d

Definition at line 156 of file primitives/Point.h.

◆ TwoDType

using lanelet::ConstPoint2d::TwoDType = ConstPoint2d

Definition at line 155 of file primitives/Point.h.

Constructor & Destructor Documentation

◆ ConstPoint2d() [1/2]

lanelet::ConstPoint2d::ConstPoint2d	(	Id	id,
		const BasicPoint3d &	point,
		const AttributeMap &	attributes = `AttributeMap()`
	)

inline

Construct from an id and a point.

Definition at line 163 of file primitives/Point.h.

◆ ConstPoint2d() [2/2]

lanelet::ConstPoint2d::ConstPoint2d	(	Id	id = `InvalId`,
		double	x = `0.`,
		double	y = `0.`,
		double	z = `0.`,
		const AttributeMap &	attributes = `AttributeMap()`
	)

inlineexplicit

Construct from an id and coordinates.

The z coordinate is required because this point can be converted to a 3d point, where z matters.

Definition at line 171 of file primitives/Point.h.

Member Function Documentation

◆ basicPoint()

const BasicPoint& lanelet::ConstPoint2d::basicPoint ( ) const

inlinenoexcept

Get an Eigen point for faster calculations.

Definition at line 182 of file primitives/Point.h.

◆ basicPoint2d()

const BasicPoint2d& lanelet::ConstPoint2d::basicPoint2d ( ) const

inlinenoexcept

Get a 2d Eigen point. Does not make sense for this particular class, but for its children.

Definition at line 186 of file primitives/Point.h.

◆ ConstPrimitive() [1/3]

lanelet::ConstPrimitive< Data >::ConstPrimitive

default

◆ ConstPrimitive() [2/3]

lanelet::ConstPrimitive< Data >::ConstPrimitive

inlineexplicit

Construct from a pointer to the data.

Parameters

data	internal data for this primitive. Must not be null.

Definition at line 78 of file Primitive.h.

◆ ConstPrimitive() [3/3]

lanelet::ConstPrimitive< Data >::ConstPrimitive

defaultnoexcept

◆ operator BasicPoint2d()

lanelet::ConstPoint2d::operator BasicPoint2d ( ) const

inlinenoexcept

A ConstPoint 2d is implicitly convertible to a normal 2d point.

Definition at line 177 of file primitives/Point.h.

◆ point()

const BasicPoint3d& lanelet::ConstPoint2d::point ( ) const

inlineprotected

Definition at line 195 of file primitives/Point.h.

◆ point2d()

const BasicPoint2d& lanelet::ConstPoint2d::point2d ( ) const

inlineprotected

Definition at line 196 of file primitives/Point.h.

◆ x()

double lanelet::ConstPoint2d::x ( ) const

inlinenoexcept

gets x coordinate

Definition at line 189 of file primitives/Point.h.

◆ y()

double lanelet::ConstPoint2d::y ( ) const

inlinenoexcept

gets y coordinate

Definition at line 192 of file primitives/Point.h.

Member Data Documentation

◆ Dimension

constexpr traits::Dimensions lanelet::ConstPoint2d::Dimension = traits::Dimensions::Two

staticconstexpr

Definition at line 158 of file primitives/Point.h.

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

primitives/Point.h

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ BasicPoint

◆ Category

◆ ConstType

◆ MutableType

◆ ThreeDType

◆ TwoDType

Constructor & Destructor Documentation

◆ ConstPoint2d() [1/2]

◆ ConstPoint2d() [2/2]

Member Function Documentation

◆ basicPoint()

◆ basicPoint2d()

◆ ConstPrimitive() [1/3]

◆ ConstPrimitive() [2/3]

◆ ConstPrimitive() [3/3]

◆ operator BasicPoint2d()

◆ point()

◆ point2d()

◆ x()

◆ y()

Member Data Documentation

◆ Dimension