Drake
RoadGeometry Class Reference

An api::RoadGeometry implementation for RNDF specification. More...

#include <drake/automotive/maliput/rndf/road_geometry.h>

Public Member Functions

 RoadGeometry (const api::RoadGeometryId &id, double linear_tolerance, double angular_tolerance)
 Constructs an empty RoadGeometry with the specified tolerances. More...
 
JunctionNewJunction (api::JunctionId id)
 Creates and adds a new Junction with the specified id. More...
 
BranchPointNewBranchPoint (api::BranchPointId id)
 Creates and adds a new BranchPoint with the specified id. More...
 
 ~RoadGeometry () override=default
 
Does not allow copy, move, or assignment
 RoadGeometry (const RoadGeometry &)=delete
 
RoadGeometryoperator= (const RoadGeometry &)=delete
 
 RoadGeometry (RoadGeometry &&)=delete
 
RoadGeometryoperator= (RoadGeometry &&)=delete
 
- Public Member Functions inherited from RoadGeometry
const RoadGeometryId id () const
 Returns the persistent identifier. More...
 
int num_junctions () const
 Returns the number of Junctions in the RoadGeometry. More...
 
const Junctionjunction (int index) const
 Returns the Junction indexed by index. More...
 
int num_branch_points () const
 Returns the number of BranchPoints in the RoadGeometry. More...
 
const BranchPointbranch_point (int index) const
 Returns the BranchPoint indexed by index. More...
 
const IdIndexById () const
 Accesses the IdIndex interface, which allows getting elements of the RoadGeometry's object graph by their unique id's. More...
 
RoadPosition ToRoadPosition (const GeoPosition &geo_position, const RoadPosition *hint, GeoPosition *nearest_position, double *distance) const
 Determines the RoadPosition corresponding to GeoPosition geo_position. More...
 
double linear_tolerance () const
 Returns the tolerance guaranteed for linear measurements (positions). More...
 
double angular_tolerance () const
 Returns the tolerance guaranteed for angular measurements (orientations). More...
 
double scale_length () const
 Returns the characteristic scale length expressed by this RoadGeometry. More...
 
std::vector< std::string > CheckInvariants () const
 Verifies certain invariants guaranteed by the API. More...
 
 RoadGeometry (const RoadGeometry &)=delete
 
RoadGeometryoperator= (const RoadGeometry &)=delete
 
 RoadGeometry (RoadGeometry &&)=delete
 
RoadGeometryoperator= (RoadGeometry &&)=delete
 

Additional Inherited Members

- Protected Member Functions inherited from RoadGeometry
 RoadGeometry ()=default
 

Detailed Description

An api::RoadGeometry implementation for RNDF specification.

Use the Builder interface to actually assemble a sensible road network. Further information on RNDF specification can be found: https://www.grandchallenge.org/grandchallenge/docs/RNDF_MDF_Formats_031407.pdf

api::RoadGeometry::ToRoadPosition should not be called as DoToRoadPosition is not implemented.

Constructor & Destructor Documentation

◆ RoadGeometry() [1/3]

RoadGeometry ( const RoadGeometry )
delete

◆ RoadGeometry() [2/3]

RoadGeometry ( RoadGeometry &&  )
delete

◆ RoadGeometry() [3/3]

RoadGeometry ( const api::RoadGeometryId id,
double  linear_tolerance,
double  angular_tolerance 
)
inline

Constructs an empty RoadGeometry with the specified tolerances.

Parameters
idto set a name to the object.
linear_toleranceis the tolerance in the linear sense for the api::RoadGeometry::CheckInvariants constraints checks.
angular_toleranceis the tolerance in the angular sense for the api::RoadGeometry::CheckInvariants constraints checks.

◆ ~RoadGeometry()

~RoadGeometry ( )
overridevirtualdefault

Reimplemented from RoadGeometry.

Member Function Documentation

◆ NewBranchPoint()

BranchPoint * NewBranchPoint ( api::BranchPointId  id)

Creates and adds a new BranchPoint with the specified id.

Parameters
idis the ID of the branch point.
Returns
A pointer to a BranchPoint

◆ NewJunction()

Junction * NewJunction ( api::JunctionId  id)

Creates and adds a new Junction with the specified id.

Parameters
idis the ID of the junction.
Returns
A pointer to a Junction

◆ operator=() [1/2]

RoadGeometry& operator= ( const RoadGeometry )
delete

◆ operator=() [2/2]

RoadGeometry& operator= ( RoadGeometry &&  )
delete

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