maliput
IntersectionBook Class Reference

Detailed Description

A concrete implementation of the api::IntersectionBook abstract interface.

#include <include/maliput/base/intersection_book.h>

Inheritance diagram for IntersectionBook:
[legend]

Public Member Functions

 MALIPUT_NO_COPY_NO_MOVE_NO_ASSIGN (IntersectionBook)
 
 IntersectionBook (const api::RoadGeometry *road_geometry)
 Constructs an IntersectionBook. More...
 
 ~IntersectionBook () override
 
void AddIntersection (std::unique_ptr< api::Intersection > intersection)
 Adds intersection to this IntersectionBook. More...
 
std::vector< api::Intersection * > FindIntersections (const std::vector< api::LaneSRange > &region, double tolerance)
 Returns a vector of Intersection pointers whose regions intersect region. More...
 
- Public Member Functions inherited from IntersectionBook
 MALIPUT_NO_COPY_NO_MOVE_NO_ASSIGN (IntersectionBook)
 
std::vector< Intersection * > GetIntersections ()
 Gets a list of all Intersections within this book. More...
 
IntersectionGetIntersection (const Intersection::Id &id)
 Gets the specified Intersection. More...
 
IntersectionFindIntersection (const rules::TrafficLight::Id &id)
 Find the intersection which contains api::rules::TrafficLight::Id. More...
 
IntersectionFindIntersection (const rules::DiscreteValueRule::Id &id)
 Find the intersection which contains api::rules::DiscreteValueRule::Id. More...
 
IntersectionFindIntersection (const InertialPosition &inertial_pos)
 Find the intersection which contains api::rules::DiscreteValueRule::Id. More...
 
IntersectionFindIntersection (const rules::RightOfWayRule::Id &id)
 Find the intersection which contains api::rules::RightOfWayRule::Id. More...
 

Additional Inherited Members

- Protected Member Functions inherited from IntersectionBook
 IntersectionBook ()=default
 

Constructor & Destructor Documentation

◆ IntersectionBook()

IntersectionBook ( const api::RoadGeometry road_geometry)
explicit

Constructs an IntersectionBook.

Parameters
road_geometryThe api::RoadGeometry used when computing GetFindIntersection(inertial_pose)
Precondition
road_geometry must not be null.
Exceptions
maliput::common::assertion_errorwhen preconditions are unmet.

◆ ~IntersectionBook()

~IntersectionBook ( )
overridevirtualdefault

Reimplemented from IntersectionBook.

Member Function Documentation

◆ AddIntersection()

void AddIntersection ( std::unique_ptr< api::Intersection intersection)

Adds intersection to this IntersectionBook.

Exceptions
std::exceptionif an api::Intersection with the same ID already exists, or if intersection is nullptr.

◆ FindIntersections()

std::vector< Intersection * > FindIntersections ( const std::vector< api::LaneSRange > &  region,
double  tolerance 
)

Returns a vector of Intersection pointers whose regions intersect region.

Parameters
regionA vector of api::LaneSRanges.
toleranceTolerance to compare api::LaneSRange intersections.

◆ MALIPUT_NO_COPY_NO_MOVE_NO_ASSIGN()

MALIPUT_NO_COPY_NO_MOVE_NO_ASSIGN ( IntersectionBook  )

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