maliput
Public Member Functions | Protected Member Functions | List of all members
IntersectionBook Class Referenceabstract

Detailed Description

An abstract interface for providing the mapping from Intersection::Id to Intersection.

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

Inheritance diagram for IntersectionBook:
[legend]

Public Member Functions

 MALIPUT_NO_COPY_NO_MOVE_NO_ASSIGN (IntersectionBook)
 
virtual ~IntersectionBook ()=default
 
std::vector< Intersection * > GetIntersections ()
 Gets a list of all Intersections within this book. More...
 
Intersection * GetIntersection (const Intersection::Id &id)
 Gets the specified Intersection. More...
 
Intersection * FindIntersection (const rules::TrafficLight::Id &id)
 Find the intersection which contains api::rules::TrafficLight::Id. More...
 
Intersection * FindIntersection (const rules::DiscreteValueRule::Id &id)
 Find the intersection which contains api::rules::DiscreteValueRule::Id. More...
 
Intersection * FindIntersection (const InertialPosition &inertial_pos)
 Find the intersection which contains api::rules::DiscreteValueRule::Id. More...
 
Intersection * FindIntersection (const rules::RightOfWayRule::Id &id)
 Find the intersection which contains api::rules::RightOfWayRule::Id. More...
 

Protected Member Functions

 IntersectionBook ()=default
 

Constructor & Destructor Documentation

◆ ~IntersectionBook()

virtual ~IntersectionBook ( )
virtualdefault

Reimplemented in IntersectionBook.

◆ IntersectionBook()

IntersectionBook ( )
protecteddefault

Member Function Documentation

◆ FindIntersection() [1/4]

Intersection* FindIntersection ( const InertialPosition &  inertial_pos)

Find the intersection which contains api::rules::DiscreteValueRule::Id.

Parameters
inertial_posA position in Inertial-Frame.
Returns
The Intersection that contains inertial_pose. When none of the Intersections have overlap with inertial_pose, nullptr is returned.

◆ FindIntersection() [2/4]

Intersection* FindIntersection ( const rules::DiscreteValueRule::Id &  id)

Find the intersection which contains api::rules::DiscreteValueRule::Id.

Parameters
idA rules::DiscreteValueRule::Id.
Returns
The Intersection that contains id. When none of the Intersections have a rules::DiscreteValueRule with id, nullptr is returned.

◆ FindIntersection() [3/4]

Intersection* FindIntersection ( const rules::RightOfWayRule::Id &  id)

Find the intersection which contains api::rules::RightOfWayRule::Id.

Parameters
idA rules::RightOfWayRule::Id.
Returns
The Intersection that contains id. When none of the Intersections have a rules::RightOfWayRule with id, nullptr is returned.

◆ FindIntersection() [4/4]

Intersection* FindIntersection ( const rules::TrafficLight::Id &  id)

Find the intersection which contains api::rules::TrafficLight::Id.

Parameters
idA rules::TrafficLight::Id.
Returns
The Intersection that contains id. When none of the Intersections have a rules::TrafficLight with id, nullptr is returned.

◆ GetIntersection()

Intersection* GetIntersection ( const Intersection::Id &  id)

Gets the specified Intersection.

Returns nullptr if id is unrecognized. Otherwise, the returned pointer is guaranteed to remain valid throughout the lifetime of this IntersectionBook's instance.

◆ GetIntersections()

std::vector<Intersection*> GetIntersections ( )

Gets a list of all Intersections within this book.

◆ 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 file: