maliput_multilane
EndLane Class Reference

Detailed Description

Provides methods to build an EndLane::Spec.

#include <include/maliput_multilane/builder.h>

Classes

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

Public Member Functions

 EndLane ()=delete
 
 EndLane (int end_lane)
 Constructs a EndLane::Spec factory to hold end_lane lane-curve end point. More...
 
Spec z_at (const Connection &connection, int lane_id, api::LaneEnd::Which end, Direction direction) const
 Builds a Spec at connection's end side with direction direction. More...
 
Spec z_at (const EndpointZ &endpoint_z, Direction direction) const
 Builds an Spec at endpoint_z with direction direction. More...
 

Constructor & Destructor Documentation

◆ EndLane() [1/2]

EndLane ( )
delete

◆ EndLane() [2/2]

EndLane ( int  end_lane)
explicit

Constructs a EndLane::Spec factory to hold end_lane lane-curve end point.

end_lane must be non-negative.

Member Function Documentation

◆ z_at() [1/2]

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

Builds a Spec at connection's 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.

◆ z_at() [2/2]

Spec z_at ( const EndpointZ endpoint_z,
Direction  direction 
) const

Builds an Spec at endpoint_z with direction direction.

When direction == Direction::kReverse, endpoint_z 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: