maliput_object
ObjectQuery Class Referenceabstract

Detailed Description

Interface to perform queries on top of Maliput's RoadNetwork about Objects.

To match convention of underlying RoadNetwork, the query interface use maliput::math::Vector3 as the specialization of the Coordinate template argument.

#include <include/maliput_object/api/object_query.h>

Inheritance diagram for ObjectQuery:
[legend]

Public Member Functions

virtual ~ObjectQuery ()=default
 
std::vector< const maliput::api::Lane * > FindOverlappingLanesIn (const Object< maliput::math::Vector3 > *object) const
 Finds all the lanes overlapping with object . More...
 
std::vector< const maliput::api::Lane * > FindOverlappingLanesIn (const Object< maliput::math::Vector3 > *object, const maliput::math::OverlappingType &overlapping_type) const
 Finds all the lanes overlapping according the overlapping_type with object . More...
 
std::optional< const maliput::api::LaneSRoute > Route (const Object< maliput::math::Vector3 > *origin, const Object< maliput::math::Vector3 > *target) const
 Finds the route between origin and target objects. More...
 
const ObjectBook< maliput::math::Vector3 > * object_book () const
 
const maliput::api::RoadNetwork * road_network () const
 

Protected Member Functions

 ObjectQuery ()=default
 

Constructor & Destructor Documentation

◆ ~ObjectQuery()

virtual ~ObjectQuery ( )
virtualdefault

◆ ObjectQuery()

ObjectQuery ( )
protecteddefault

Member Function Documentation

◆ FindOverlappingLanesIn() [1/2]

std::vector<const maliput::api::Lane*> FindOverlappingLanesIn ( const Object< maliput::math::Vector3 > *  object) const

Finds all the lanes overlapping with object .

Parameters
objectObject to find lanes overlapping with.
Returns
A vector of pointers to lanes overlapping with object .

◆ FindOverlappingLanesIn() [2/2]

std::vector<const maliput::api::Lane*> FindOverlappingLanesIn ( const Object< maliput::math::Vector3 > *  object,
const maliput::math::OverlappingType &  overlapping_type 
) const

Finds all the lanes overlapping according the overlapping_type with object .

Parameters
objectObject to find lanes overlapping with.
overlapping_typeType of overlapping to find.
Returns
A vector of pointers to lanes overlapping with object .

◆ object_book()

const ObjectBook<maliput::math::Vector3>* object_book ( ) const
Returns
The ObjectBook.

◆ road_network()

const maliput::api::RoadNetwork* road_network ( ) const
Returns
The maliput::api::RoadNetwork.

◆ Route()

std::optional<const maliput::api::LaneSRoute> Route ( const Object< maliput::math::Vector3 > *  origin,
const Object< maliput::math::Vector3 > *  target 
) const

Finds the route between origin and target objects.

Parameters
originObject to find route from.
targetObject to find route to.

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