Drake
RoadGeometry Class Referencefinal

Dragway's implementation of api::RoadGeometry. More...

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

Inheritance diagram for RoadGeometry:
[legend]
Collaboration diagram for RoadGeometry:
[legend]

Public Member Functions

 RoadGeometry (const api::RoadGeometryId &id, int num_lanes, double length, double lane_width, double shoulder_width, double maximum_height, double linear_tolerance, double angular_tolerance)
 Constructs a dragway RoadGeometry. More...
 
 ~RoadGeometry () final=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

Dragway's implementation of api::RoadGeometry.

To understand the characteristics of the geometry, consult the dragway::Segment and dragway::Lane detailed class overview docs.

Constructor & Destructor Documentation

RoadGeometry ( const RoadGeometry )
delete
RoadGeometry ( RoadGeometry &&  )
delete
RoadGeometry ( const api::RoadGeometryId id,
int  num_lanes,
double  length,
double  lane_width,
double  shoulder_width,
double  maximum_height,
double  linear_tolerance,
double  angular_tolerance 
)

Constructs a dragway RoadGeometry.

Parameters
[in]idThe ID of this RoadGeometry. This can be any user-selectable value.
[in]num_lanesThe number of lanes. This must be greater than zero.
[in]lengthThe length of the dragway.
[in]lane_widthThe width of each lane.
[in]shoulder_widthThe width of the shoulders on each side of the road.
[in]maximum_heightThe maximum height above the road surface modelled by the RoadGeometry.
[in]linear_toleranceThe tolerance guaranteed for linear measurements (positions).
[in]angular_toleranceThe tolerance guaranteed for angular measurements (orientations).

Here is the call graph for this function:

~RoadGeometry ( )
finalvirtualdefault

Reimplemented from RoadGeometry.

Member Function Documentation

RoadGeometry& operator= ( const RoadGeometry )
delete
RoadGeometry& operator= ( RoadGeometry &&  )
delete

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