Detailed Description

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

This follows the same pattern as RoadObjectBook and TrafficSignBook. Backend implementations are responsible for populating the book with the road markings present in their road network data sources.

#include <include/maliput/api/objects/road_marking_book.h>

Inheritance diagram for RoadMarkingBook:

[legend]

Public Member Functions
virtual	~RoadMarkingBook ()=default

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

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

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

std::vector< const RoadMarking * >	FindByType (RoadMarkingType type) const
	Returns all RoadMarkings whose type matches `type`. More...

Protected Member Functions
	RoadMarkingBook ()=default

Constructor & Destructor Documentation

◆ ~RoadMarkingBook()

virtual ~RoadMarkingBook ( )

virtualdefault

Reimplemented in RoadMarkingBook.

◆ RoadMarkingBook()

RoadMarkingBook ( )

protecteddefault

Member Function Documentation

◆ FindByLane()

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

Returns all RoadMarkings whose related_lanes() includes lane_id.

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

◆ FindByType()

std::vector<const RoadMarking*> FindByType ( RoadMarkingType type ) const

Returns all RoadMarkings whose type matches type.

Returns an empty vector if no markings match.

◆ GetRoadMarking()

const RoadMarking* GetRoadMarking ( const RoadMarking::Id & id ) const

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

◆ RoadMarkings()

std::vector<const RoadMarking*> RoadMarkings ( ) const

Returns all RoadMarkings in this book.

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

api/objects/road_marking_book.h