maliput_multilane
StartLane Class Reference

Detailed Description

Provides methods to build an StartLane::Spec.

#include <include/maliput_multilane/builder.h>

Classes

class  Spec
 Defines how a Connection's lane curve starts. More...
 

Public Member Functions

 StartLane ()=delete
 
 StartLane (int start_lane)
 Constructs a StartLane::Spec factory to hold start_lane lane-curve start point. More...
 
Spec at (const Endpoint &endpoint, Direction direction) const
 Builds a Spec at endpoint with direction direction. More...
 
Spec at (const Connection &connection, int lane_id, api::LaneEnd::Which end, Direction direction) const
 Builds a Spec at connection's lane_id lane at end side with direction direction. More...
 

Constructor & Destructor Documentation

◆ StartLane() [1/2]

StartLane ( )
delete

◆ StartLane() [2/2]

StartLane ( int  start_lane)
explicit

Constructs a StartLane::Spec factory to hold start_lane lane-curve start point.

start_lane must be non-negative.

Member Function Documentation

◆ at() [1/2]

Spec at ( const Connection connection,
int  lane_id,
api::LaneEnd::Which  end,
Direction  direction 
) const

Builds a Spec at connection's lane_id lane at end side with direction direction.

connection's theta_dot at the given end will be ignored by the new Spec so that the Builder can adjust it to match road continuity constraints.

lane_id must be non-negative and smaller than connection's number of lanes.

◆ at() [2/2]

Spec at ( const Endpoint endpoint,
Direction  direction 
) const

Builds a Spec at endpoint with direction direction.

When direction == Direction::kReverse, endpoint is reversed. Additionally, endpoint's theta_dot must be std::nullopt. Otherwise the Builder is unable to match road continuity constraints.


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