Drake
Lane Class Reference

Base class for the multilane implementation of api::Lane. More...

#include <drake/automotive/maliput/multilane/lane.h>

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

Public Member Functions

 Lane (const api::LaneId &id, const api::Segment *segment, int index, const api::RBounds &lane_bounds, const api::RBounds &driveable_bounds, const api::HBounds &elevation_bounds, const RoadCurve *road_curve, double r0)
 Constructs a Lane. More...
 
const CubicPolynomialelevation () const
 
const CubicPolynomialsuperelevation () const
 
double r0 () const
 
void SetStartBp (BranchPoint *bp)
 
void SetEndBp (BranchPoint *bp)
 
BranchPointstart_bp ()
 
BranchPointend_bp ()
 
 ~Lane () override=default
 
Does not allow copy, move, or assignment
 Lane (const Lane &)=delete
 
Laneoperator= (const Lane &)=delete
 
 Lane (Lane &&)=delete
 
Laneoperator= (Lane &&)=delete
 
- Public Member Functions inherited from Lane
const LaneId id () const
 Returns the persistent identifier. More...
 
const Segmentsegment () const
 Returns the Segment to which this Lane belongs. More...
 
int index () const
 Returns the index of this Lane within the Segment which owns it. More...
 
const Laneto_left () const
 Returns a pointer to the adjacent Lane to the left of this Lane. More...
 
const Laneto_right () const
 Returns a pointer to the adjacent Lane to the right of this Lane. More...
 
double length () const
 Returns the arc-length of the Lane along its reference curve. More...
 
RBounds lane_bounds (double s) const
 Returns the nominal lateral (r) bounds for the lane as a function of s. More...
 
RBounds driveable_bounds (double s) const
 Returns the driveable lateral (r) bounds of the lane as a function of s. More...
 
HBounds elevation_bounds (double s, double r) const
 Returns the elevation (h) bounds of the lane as a function of (s, r). More...
 
GeoPosition ToGeoPosition (const LanePosition &lane_pos) const
 Returns the GeoPosition corresponding to the given LanePosition. More...
 
template<typename T >
GeoPositionT< T > ToGeoPositionT (const LanePositionT< T > &lane_pos) const
 Generalization of ToGeoPosition to arbitrary scalar types, where the structures LanePositionT<T> and GeoPositionT<T> are used in place of LanePosition and GeoPosition, respectively. More...
 
LanePosition ToLanePosition (const GeoPosition &geo_pos, GeoPosition *nearest_point, double *distance) const
 Determines the LanePosition corresponding to GeoPosition geo_pos. More...
 
template<typename T >
LanePositionT< T > ToLanePositionT (const GeoPositionT< T > &geo_pos, GeoPositionT< T > *nearest_point, T *distance) const
 Generalization of ToLanePosition to arbitrary scalar types, where the structures LanePositionT<T> and GeoPositionT<T> are used in place of LanePosition and GeoPosition, respectively. More...
 
Rotation GetOrientation (const LanePosition &lane_pos) const
 Returns the rotation which expresses the orientation of the Lane-frame basis at lane_pos with respect to the world frame basis. More...
 
LanePosition EvalMotionDerivatives (const LanePosition &position, const IsoLaneVelocity &velocity) const
 Computes derivatives of LanePosition given a velocity vector velocity. More...
 
const BranchPointGetBranchPoint (const LaneEnd::Which which_end) const
 Returns the lane's BranchPoint for the end specified by which_end. More...
 
const LaneEndSetGetConfluentBranches (const LaneEnd::Which which_end) const
 Returns the set of LaneEnd's which connect with this lane on the same side of the BranchPoint at which_end. More...
 
const LaneEndSetGetOngoingBranches (const LaneEnd::Which which_end) const
 Returns the set of LaneEnd's which continue onward from this lane at the BranchPoint at which_end. More...
 
optional< LaneEndGetDefaultBranch (const LaneEnd::Which which_end) const
 Returns the default ongoing LaneEnd connected at which_end, or nullopt if no default branch has been established at which_end. More...
 
template<>
GeoPositionT< doubleToGeoPositionT (const LanePositionT< double > &lane_pos) const
 
template<>
GeoPositionT< AutoDiffXdToGeoPositionT (const LanePositionT< AutoDiffXd > &lane_pos) const
 
template<>
LanePositionT< doubleToLanePositionT (const GeoPositionT< double > &geo_pos, GeoPositionT< double > *nearest_point, double *distance) const
 
template<>
LanePositionT< AutoDiffXdToLanePositionT (const GeoPositionT< AutoDiffXd > &geo_pos, GeoPositionT< AutoDiffXd > *nearest_point, AutoDiffXd *distance) const
 
 Lane (const Lane &)=delete
 
Laneoperator= (const Lane &)=delete
 
 Lane (Lane &&)=delete
 
Laneoperator= (Lane &&)=delete
 

Additional Inherited Members

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

Detailed Description

Base class for the multilane implementation of api::Lane.

Constructor & Destructor Documentation

Lane ( const Lane )
delete
Lane ( Lane &&  )
delete
Lane ( const api::LaneId id,
const api::Segment segment,
int  index,
const api::RBounds lane_bounds,
const api::RBounds driveable_bounds,
const api::HBounds elevation_bounds,
const RoadCurve road_curve,
double  r0 
)
inline

Constructs a Lane.

Parameters
idthe ID
segmentthe Segment to which this Lane will belong, which must remain valid for the lifetime of this class
indexLane's index to identify it when querying parent segment. It must be positive.
lane_boundsnominal bounds of the lane, uniform along the entire reference path, which must be a subset of driveable_bounds
driveable_boundsdriveable bounds of the lane, uniform along the entire reference path
elevation_boundselevation bounds of the lane, uniform along the entire driveable surface
road_curveThe trajectory of the Lane over parent segment's surface.
r0The lateral displacement with respect to the road_curve's reference curve.

N.B. The override Lane::ToLanePosition() is currently restricted to lanes in which superelevation and elevation change are both zero.

Here is the call graph for this function:

~Lane ( )
overridevirtualdefault

Reimplemented from Lane.

Here is the caller graph for this function:

Member Function Documentation

const CubicPolynomial& elevation ( ) const
inline

Here is the call graph for this function:

BranchPoint* end_bp ( )
inline

Here is the call graph for this function:

Here is the caller graph for this function:

Lane& operator= ( Lane &&  )
delete
Lane& operator= ( const Lane )
delete
double r0 ( ) const
inline

Here is the caller graph for this function:

void SetEndBp ( BranchPoint bp)
inline

Here is the caller graph for this function:

void SetStartBp ( BranchPoint bp)
inline

Here is the caller graph for this function:

BranchPoint* start_bp ( )
inline

Here is the caller graph for this function:

const CubicPolynomial& superelevation ( ) const
inline

Here is the call graph for this function:


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