TrafficLightBook Class Reference

Detailed Description

Abstract interface for providing the mapping from TrafficLight::Id to TrafficLight.

#include <include/maliput/api/rules/traffic_light_book.h>

Inheritance diagram for TrafficLightBook:

Public Member Functions
	MALIPUT_NO_COPY_NO_MOVE_NO_ASSIGN (TrafficLightBook)
virtual	~TrafficLightBook ()=default
std::vector< const TrafficLight * >	TrafficLights () const
	Returns all TrafficLights in this book. More...
const TrafficLight *	GetTrafficLight (const TrafficLight::Id &id) const
	Gets the specified TrafficLight. Returns nullptr if id is unrecognized. More...
std::vector< const TrafficLight * >	FindByLane (const LaneId &lane_id) const
	Returns all TrafficLights whose related_lanes() includes lane_id. More...

Protected Member Functions
	TrafficLightBook ()=default

Constructor & Destructor Documentation

~TrafficLightBook()

virtual ~TrafficLightBook ( )

virtualdefault

Reimplemented in TrafficLightBook.

TrafficLightBook()

TrafficLightBook ( )

protecteddefault

Member Function Documentation

FindByLane()

std::vector<const TrafficLight*> FindByLane

(

const LaneId &

lane_id

)

const

Returns all TrafficLights whose related_lanes() includes lane_id.

Returns an empty vector if no traffic lights are associated with the given lane.

GetTrafficLight()

const TrafficLight* GetTrafficLight

(

const TrafficLight::Id &

id

)

const

Gets the specified TrafficLight. Returns nullptr if id is unrecognized.

MALIPUT_NO_COPY_NO_MOVE_NO_ASSIGN()

MALIPUT_NO_COPY_NO_MOVE_NO_ASSIGN

(

TrafficLightBook

)

TrafficLights()

std::vector<const TrafficLight*> TrafficLights

(

)

const

Returns all TrafficLights in this book.

---

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

• api/rules/traffic_light_book.h