maliput_sparse
JunctionBuilder Class Referencefinal

Detailed Description

Builder class for maliput::api::Junctions.

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

Inheritance diagram for JunctionBuilder:
[legend]

Public Member Functions

 JunctionBuilder (RoadGeometryBuilder *parent)
 Construct a new Junction Builder object. More...
 
JunctionBuilderId (const maliput::api::JunctionId &junction_id)
 Sets the maliput::api::JunctionId of the maliput::api::Junction. More...
 
SegmentBuilder StartSegment ()
 Starts the Segment builder for this Junction. More...
 
RoadGeometryBuilderEndJunction ()
 Finalizes the construction process of this Junction by inserting the Junction into the parent RoadGeometryBuilder. More...
 
void SetSegment (maliput::common::Passkey< SegmentBuilder >, std::unique_ptr< maliput::geometry_base::Segment > segment)
 Sets a maliput::geometry_base::Segment into this builder to fill in the Junction. More...
 
- Public Member Functions inherited from NestedBuilder< RoadGeometryBuilder >
virtual ~NestedBuilder ()=default
 
 NestedBuilder (RoadGeometryBuilder *parent)
 Construct a new nested builder object. More...
 
RoadGeometryBuilderEnd ()
 
RoadGeometryBuilderParent ()
 

Constructor & Destructor Documentation

◆ JunctionBuilder()

JunctionBuilder ( RoadGeometryBuilder parent)
explicit

Construct a new Junction Builder object.

Parameters
parentThe parent RoadGeometryBuilder. It must not be nullptr.

Member Function Documentation

◆ EndJunction()

RoadGeometryBuilder & EndJunction ( )

Finalizes the construction process of this Junction by inserting the Junction into the parent RoadGeometryBuilder.

Exceptions
maliput::common::assertion_errorWhen there is no segment to be set into the Junction.
Returns
A reference to the RoadGeometryBuilder.

◆ Id()

JunctionBuilder & Id ( const maliput::api::JunctionId &  junction_id)

Sets the maliput::api::JunctionId of the maliput::api::Junction.

Parameters
junction_idThe maliput::api::JunctionId.
Returns
A reference to this JunctionBuilder.

◆ SetSegment()

void SetSegment ( maliput::common::Passkey< SegmentBuilder ,
std::unique_ptr< maliput::geometry_base::Segment >  segment 
)

Sets a maliput::geometry_base::Segment into this builder to fill in the Junction.

This method is only intended to be called by SegmentBuilder instances.

See also
maliput::common::Passkey class description for further details.
Parameters
segmentA segment to be stored into the Junction. It must not be nullptr.
Exceptions
maliput::common::assertion_errorWhen segment is nullptr.

◆ StartSegment()

SegmentBuilder StartSegment ( )

Starts the Segment builder for this Junction.

Returns
A JunctionBuilder.

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