maliput_sparse
BranchPointBuilder Class Referencefinal

#include <include/maliput_sparse/builder/builder.h>

Inheritance diagram for BranchPointBuilder:
[legend]

Public Types

using LaneEndsMultimap = std::multimap< LaneEnd, LaneEnd >
 

Public Member Functions

 BranchPointBuilder (RoadGeometryBuilder *parent)
 Construct a new BranchPoint Builder object. More...
 
BranchPointBuilderConnect (const maliput::api::LaneId &lane_id_a, const maliput::api::LaneEnd::Which which_a, const maliput::api::LaneId &lane_id_b, const maliput::api::LaneEnd::Which which_b)
 Creates a connection between lane_id_a at which_a end with lane_id_b at which_b end. More...
 
RoadGeometryBuilderEndBranchPoints ()
 Finalizes the construction process of all the BranchPoints. More...
 

Member Typedef Documentation

◆ LaneEndsMultimap

using LaneEndsMultimap = std::multimap<LaneEnd, LaneEnd>

Constructor & Destructor Documentation

◆ BranchPointBuilder()

BranchPointBuilder ( RoadGeometryBuilder parent)
explicit

Construct a new BranchPoint Builder object.

Parameters
parentThe parent RoadGeometryBuilder. It must not be nullptr.

Member Function Documentation

◆ Connect()

BranchPointBuilder & Connect ( const maliput::api::LaneId &  lane_id_a,
const maliput::api::LaneEnd::Which  which_a,
const maliput::api::LaneId &  lane_id_b,
const maliput::api::LaneEnd::Which  which_b 
)

Creates a connection between lane_id_a at which_a end with lane_id_b at which_b end.

Parameters
lane_id_aThe maliput::api::LaneId of Lane A.
which_aThe maliput::api::LaneEnd::Which end of Lane A.
lane_id_bThe maliput::api::LaneId of Lane B.
which_bThe maliput::api::LaneEnd::Which end of Lane B.
Exceptions
maliput::common::assertion_errorWhen lane_id_a or lane_id_b do not exist.
Returns
A reference to this builder.

◆ EndBranchPoints()

RoadGeometryBuilder & EndBranchPoints ( )

Finalizes the construction process of all the BranchPoints.

Exceptions
maliput::common::assertion_errorWhen there are no BranchPoints to be created.
Returns
A reference to the RoadGeometryBuilder.

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