Public Types | Public Member Functions | List of all members
lanelet::ConstLineString3d Class Reference

A normal 3d linestring with immutable data. More...

#include <LineString.h>

Inheritance diagram for lanelet::ConstLineString3d:
Inheritance graph
[legend]

Public Types

using ConstType = ConstLineString3d
 
using HybridType = ConstHybridLineString3d
 
using MutableType = LineString3d
 
using ThreeDType = ConstLineString3d
 
using TwoDType = ConstLineString2d
 
- Public Types inherited from lanelet::ConstLineStringImpl< Point3d >
using BasicIterator = internal::TransformIterator< const_iterator, const BasicPointType >
 
using BasicLineString = internal::SelectBasicLineStringT< BasicPointType >
 
using BasicPointType = traits::BasicPointT< Point3d >
 
using Category = traits::LineStringTag
 
using const_iterator = internal::SelectLsIteratorT< const ConstPointType >
 
using ConstPointType = traits::ConstPointT< Point3d >
 
using ConstSegmentType = traits::ConstPrimitiveType< SegmentType >
 
using difference_type = typename iterator::difference_type
 
using iterator = const_iterator
 
using MutablePointType = traits::MutablePointT< Point3d >
 linestring will return this point type More...
 
using PointType = ConstPointType
 
using SegmentType = Segment< Point3d >
 
using size_type = size_t
 
using value_type = ConstPointType
 
- Public Types inherited from lanelet::ConstPrimitive< LineStringData >
using DataType = LineStringData
 

Public Member Functions

 ConstLineString3d ()=default
 
 ConstLineStringImpl (const ConstLineStringImpl &rhs)=default
 
template<typename OtherT >
 ConstLineStringImpl (const ConstLineStringImpl< OtherT > &other)
 construct from other ConstLineStrings More...
 
 ConstLineStringImpl (const std::shared_ptr< const LineStringData > &data, bool inverted=false)
 Constructs a linestring from the data object of another linestring. More...
 
 ConstLineStringImpl (ConstLineStringImpl &&rhs) noexcept=default
 
 ConstLineStringImpl (Id id=InvalId, Points3d points=Points3d(), const AttributeMap &attributes=AttributeMap())
 Constructs a LineString or similar from an Id and a list of points. More...
 
ConstLineString3d invert () const noexcept
 create a new, inverted linestring from this one More...
 
- Public Member Functions inherited from lanelet::ConstLineStringImpl< Point3d >
const ConstPointTypeback () const noexcept
 returns the last point (if it exist) More...
 
BasicIterator basicBegin () const noexcept
 returns a normal iterator to the internal point type at begin More...
 
BasicIterator basicEnd () const noexcept
 returns a normal iterator for the internal point type at end More...
 
BasicLineString basicLineString () const noexcept
 Create a basic linestring (ie a vector of Eigen Points) More...
 
const_iterator begin () const noexcept
 Returns an iterator to the start of the points. More...
 
 ConstLineStringImpl (const ConstLineStringImpl< OtherT > &other)
 construct from other ConstLineStrings More...
 
 ConstLineStringImpl (const std::shared_ptr< const LineStringData > &data, bool inverted=false)
 Constructs a linestring from the data object of another linestring. More...
 
 ConstLineStringImpl (Id id=InvalId, Points3d points=Points3d(), const AttributeMap &attributes=AttributeMap())
 Constructs a LineString or similar from an Id and a list of points. More...
 
bool empty () const noexcept
 return if there are any points in this object More...
 
const_iterator end () const noexcept
 Returns an iterator to end of the points. More...
 
const ConstPointTypefront () const noexcept
 returns the first point (if it exist) More...
 
bool inverted () const noexcept
 Returns whether this is an inverted linestring. More...
 
size_t numSegments () const noexcept
 Returns the number of (geometrically valid) segments. More...
 
const ConstPointTypeoperator[] (size_t idx) const noexcept
 returns the point at this position More...
 
ConstSegmentType segment (size_t idx) const noexcept
 returns the n-th segment. If n equals size() -1, the segment from back() to front() is returned. More...
 
size_t size () const noexcept
 Return the number of points in this linestring. More...
 
- Public Member Functions inherited from lanelet::ConstPrimitive< LineStringData >
const Attributeattribute (AttributeName name) const
 retrieve an attribute (enum version) More...
 
const Attributeattribute (const std::string &name) const
 retrieve an attribute More...
 
attributeOr (AttributeName name, T defaultVal) const
 retrieve an attribute (enum version) More...
 
attributeOr (const std::string &name, T defaultVal) const noexcept
 retrieve an attribute (string version) More...
 
const AttributeMapattributes () const
 get the attributes of this primitive More...
 
const std::shared_ptr< const LineStringData > & constData () const
 get the internal data of this primitive More...
 
 ConstPrimitive (const std::shared_ptr< const LineStringData > &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
 

Additional Inherited Members

- Static Public Attributes inherited from lanelet::ConstLineStringImpl< Point3d >
static constexpr traits::Dimensions Dimension
 
- Static Public Attributes inherited from lanelet::ConstPrimitive< LineStringData >
static constexpr bool IsConst
 
- Protected Member Functions inherited from lanelet::ConstLineStringImpl< Point3d >
 ConstLineStringImpl (const ConstLineStringImpl &rhs)=default
 
 ConstLineStringImpl (ConstLineStringImpl &&rhs) noexcept=default
 
ConstLineStringImploperator= (const ConstLineStringImpl &rhs)=default
 
ConstLineStringImploperator= (ConstLineStringImpl &&rhs) noexcept=default
 
 ~ConstLineStringImpl () noexcept=default
 
- Protected Member Functions inherited from lanelet::ConstPrimitive< LineStringData >
 ConstPrimitive (const ConstPrimitive &rhs)=default
 
 ConstPrimitive (ConstPrimitive &&rhs) noexcept=default
 
ConstPrimitiveoperator= (const ConstPrimitive &rhs)=default
 
ConstPrimitiveoperator= (ConstPrimitive &&rhs) noexcept=default
 
 ~ConstPrimitive () noexcept=default
 

Detailed Description

A normal 3d linestring with immutable data.

Definition at line 521 of file primitives/LineString.h.

Member Typedef Documentation

◆ ConstType

Definition at line 524 of file primitives/LineString.h.

◆ HybridType

Definition at line 528 of file primitives/LineString.h.

◆ MutableType

Definition at line 525 of file primitives/LineString.h.

◆ ThreeDType

Definition at line 527 of file primitives/LineString.h.

◆ TwoDType

Definition at line 526 of file primitives/LineString.h.

Constructor & Destructor Documentation

◆ ConstLineString3d()

lanelet::ConstLineString3d::ConstLineString3d ( )
default

Member Function Documentation

◆ ConstLineStringImpl() [1/5]

◆ ConstLineStringImpl() [2/5]

template<typename OtherT >
lanelet::ConstLineStringImpl< PointT >::ConstLineStringImpl ( typename OtherT  )
inlineexplicit

construct from other ConstLineStrings

Definition at line 253 of file primitives/LineString.h.

◆ ConstLineStringImpl() [3/5]

Constructs a linestring from the data object of another linestring.

Definition at line 248 of file primitives/LineString.h.

◆ ConstLineStringImpl() [4/5]

◆ ConstLineStringImpl() [5/5]

Constructs a LineString or similar from an Id and a list of points.

Definition at line 243 of file primitives/LineString.h.

◆ invert()

ConstLineString3d lanelet::ConstLineString3d::invert ( ) const
inlinenoexcept

create a new, inverted linestring from this one

Definition at line 532 of file primitives/LineString.h.


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


lanelet2_core
Author(s): Fabian Poggenhans
autogenerated on Thu Mar 6 2025 03:25:52