Detailed Description

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

This follows the same pattern as TrafficLightBook. Backend implementations are responsible for populating the book with the signs present in their road network data sources.

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

Inheritance diagram for TrafficSignBook:

[legend]

Public Member Functions
virtual	~TrafficSignBook ()=default

std::vector< const TrafficSign * >	TrafficSigns () const
	Returns all TrafficSigns in this book. More...

const TrafficSign *	GetTrafficSign (const TrafficSign::Id &id) const
	Gets the specified TrafficSign. Returns nullptr if `id` is unrecognized. More...

std::vector< const TrafficSign * >	FindByLane (const LaneId &lane_id) const
	Returns all TrafficSigns whose related_lanes() includes `lane_id`. More...

std::vector< const TrafficSign * >	FindByType (const TrafficSignType &type) const
	Returns all TrafficSigns whose type matches `type`. More...

Protected Member Functions
	TrafficSignBook ()=default

Constructor & Destructor Documentation

◆ ~TrafficSignBook()

virtual ~TrafficSignBook ( )

virtualdefault

Reimplemented in TrafficSignBook.

◆ TrafficSignBook()

TrafficSignBook ( )

protecteddefault

Member Function Documentation

◆ FindByLane()

std::vector<const TrafficSign*> FindByLane ( const LaneId & lane_id ) const

Returns all TrafficSigns whose related_lanes() includes lane_id.

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

◆ FindByType()

std::vector<const TrafficSign*> FindByType ( const TrafficSignType & type ) const

Returns all TrafficSigns whose type matches type.

For example, FindByType(TrafficSignType::kStop) returns all stop signs. Returns an empty vector if no signs match.

◆ GetTrafficSign()

const TrafficSign* GetTrafficSign ( const TrafficSign::Id & id ) const

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

◆ TrafficSigns()

std::vector<const TrafficSign*> TrafficSigns ( ) const

Returns all TrafficSigns in this book.

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

api/rules/traffic_sign_book.h