Detailed Description

Directed longitudinal range of a specific Lane, identified by a LaneId.

#include <include/maliput/api/regions.h>

Public Member Functions
	MALIPUT_DEFAULT_COPY_AND_MOVE_AND_ASSIGN (LaneSRange)

	LaneSRange (const LaneId &lane_id, const SRange &s_range)
	Constructs a LaneSRange as `s_range` on Lane `lane_id`. More...

const LaneId &	lane_id () const
	Gets the LaneId. More...

SRange	s_range () const
	Gets the SRange. More...

double	length () const

bool	Intersects (const LaneSRange &lane_s_range, double tolerance) const
	Determines whether this LaneSRange intersects with `lane_s_range`. More...

std::optional< LaneSRange >	GetIntersection (const LaneSRange &lane_s_range, double tolerance) const
	Returns a std::optional<LaneSRange> bearing the intersected LaneSRange that results overlapping this LaneSRange with `lane_s_range`. More...

Constructor & Destructor Documentation

◆ LaneSRange()

LaneSRange	(	const LaneId &	lane_id,
		const SRange &	s_range
	)

Constructs a LaneSRange as s_range on Lane lane_id.

Member Function Documentation

◆ GetIntersection()

std::optional< LaneSRange > GetIntersection	(	const LaneSRange &	lane_s_range,
		double	tolerance
	)		const

Returns a std::optional<LaneSRange> bearing the intersected LaneSRange that results overlapping this LaneSRange with lane_s_range.

When there is no common area, std::nullopt is returned.

◆ Intersects()

bool Intersects	(	const LaneSRange &	lane_s_range,
		double	tolerance
	)		const

Determines whether this LaneSRange intersects with lane_s_range.

LaneIds are evaluated prior calling SRange::Intersects() method.

tolerance will modify this LaneSRanges's ranges and lane_s_range's ranges by increasing the maximum tolerance and reducing the minimum each range. When tolerance is negative, it shrinks both ranges.

◆ lane_id()

const LaneId& lane_id ( ) const

Gets the LaneId.

◆ length()

double length ( ) const

◆ MALIPUT_DEFAULT_COPY_AND_MOVE_AND_ASSIGN()

MALIPUT_DEFAULT_COPY_AND_MOVE_AND_ASSIGN ( LaneSRange )

◆ s_range()

SRange s_range ( ) const

Gets the SRange.

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