maliput_multilane
BranchPoint Class Reference

Detailed Description

An implementation of api::BranchPoint.

#include <src/maliput_multilane/branch_point.h>

Inheritance diagram for BranchPoint:
[legend]

Public Member Functions

 BranchPoint (const api::BranchPointId &id, const api::RoadGeometry *road_geometry)
 Constructs an empty BranchPoint. More...
 
const api::LaneEndAddABranch (const api::LaneEnd &lane_end)
 Adds a LaneEnd to the "A side" of the BranchPoint. More...
 
const api::LaneEndAddBBranch (const api::LaneEnd &lane_end)
 Adds a LaneEnd to the "B side" of the BranchPoint. More...
 
void SetDefault (const api::LaneEnd &lane_end, const api::LaneEnd &default_branch)
 Sets the default branch for lane_end to default_branch. More...
 
 ~BranchPoint () override=default
 
- Public Member Functions inherited from BranchPoint
BranchPointId id () const
 
const RoadGeometryroad_geometry () const
 
const LaneEndSetGetConfluentBranches (const LaneEnd &end) const
 
const LaneEndSetGetOngoingBranches (const LaneEnd &end) const
 
std::optional< LaneEndGetDefaultBranch (const LaneEnd &end) const
 
const LaneEndSetGetASide () const
 
const LaneEndSetGetBSide () const
 

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ BranchPoint()

BranchPoint ( const api::BranchPointId id,
const api::RoadGeometry road_geometry 
)

Constructs an empty BranchPoint.

road_geometry must remain valid for the lifetime of this class.

◆ ~BranchPoint()

~BranchPoint ( )
overridevirtualdefault

Reimplemented from BranchPoint.

Member Function Documentation

◆ AddABranch()

const api::LaneEnd & AddABranch ( const api::LaneEnd lane_end)

Adds a LaneEnd to the "A side" of the BranchPoint.

◆ AddBBranch()

const api::LaneEnd & AddBBranch ( const api::LaneEnd lane_end)

Adds a LaneEnd to the "B side" of the BranchPoint.

◆ SetDefault()

void SetDefault ( const api::LaneEnd lane_end,
const api::LaneEnd default_branch 
)

Sets the default branch for lane_end to default_branch.

The specified LaneEnds must belong to opposite sides of this BranchPoint.


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