maliput
RoadNetwork Class Reference

Detailed Description

A container that aggregates everything pertaining to Maliput.

#include <include/maliput/api/road_network.h>

Public Member Functions

 RoadNetwork (std::unique_ptr< const RoadGeometry > road_geometry, std::unique_ptr< const rules::RoadRulebook > rulebook, std::unique_ptr< const rules::TrafficLightBook > traffic_light_book, std::unique_ptr< IntersectionBook > intersection_book, std::unique_ptr< rules::PhaseRingBook > phase_ring_book, std::unique_ptr< rules::RightOfWayRuleStateProvider > right_of_way_rule_state_provider, std::unique_ptr< rules::PhaseProvider > phase_provider, std::unique_ptr< rules::RuleRegistry > rule_registry, std::unique_ptr< rules::DiscreteValueRuleStateProvider > discrete_value_rule_state_provider, std::unique_ptr< rules::RangeValueRuleStateProvider > range_value_rule_state_provider)
 Constructs a RoadNetwork instance. More...
 
 RoadNetwork (std::unique_ptr< const RoadGeometry > road_geometry, std::unique_ptr< const rules::RoadRulebook > rulebook, std::unique_ptr< const rules::TrafficLightBook > traffic_light_book, std::unique_ptr< IntersectionBook > intersection_book, std::unique_ptr< rules::PhaseRingBook > phase_ring_book, std::unique_ptr< rules::PhaseProvider > phase_provider, std::unique_ptr< rules::RuleRegistry > rule_registry, std::unique_ptr< rules::DiscreteValueRuleStateProvider > discrete_value_rule_state_provider, std::unique_ptr< rules::RangeValueRuleStateProvider > range_value_rule_state_provider)
 Constructs a RoadNetwork instance. More...
 
virtual ~RoadNetwork ()=default
 
bool Contains (const RoadPosition &road_position) const
 Determines if the road network contains road_position. More...
 
bool Contains (const LaneId &lane_id) const
 Determines if the road networks contains lane_id. More...
 
const RoadGeometryroad_geometry () const
 
const rules::RoadRulebookrulebook () const
 
const rules::TrafficLightBooktraffic_light_book () const
 
IntersectionBookintersection_book ()
 
const rules::PhaseRingBookphase_ring_book () const
 
rules::RightOfWayRuleStateProvider * right_of_way_rule_state_provider ()
 
rules::PhaseProviderphase_provider ()
 
const rules::RuleRegistryrule_registry () const
 
rules::DiscreteValueRuleStateProviderdiscrete_value_rule_state_provider ()
 
rules::RangeValueRuleStateProviderrange_value_rule_state_provider ()
 

Constructor & Destructor Documentation

◆ RoadNetwork() [1/2]

RoadNetwork ( std::unique_ptr< const RoadGeometry road_geometry,
std::unique_ptr< const rules::RoadRulebook rulebook,
std::unique_ptr< const rules::TrafficLightBook traffic_light_book,
std::unique_ptr< IntersectionBook intersection_book,
std::unique_ptr< rules::PhaseRingBook phase_ring_book,
std::unique_ptr< rules::RightOfWayRuleStateProvider >  right_of_way_rule_state_provider,
std::unique_ptr< rules::PhaseProvider phase_provider,
std::unique_ptr< rules::RuleRegistry rule_registry,
std::unique_ptr< rules::DiscreteValueRuleStateProvider discrete_value_rule_state_provider,
std::unique_ptr< rules::RangeValueRuleStateProvider range_value_rule_state_provider 
)

Constructs a RoadNetwork instance.

After creation, you are encouraged to validate it using ValidateRoadNetwork(), which is defined in maliput/api/road_network_validator.h. TODO(#108): Remove this constructor once old rule api is removed.

◆ RoadNetwork() [2/2]

RoadNetwork ( std::unique_ptr< const RoadGeometry road_geometry,
std::unique_ptr< const rules::RoadRulebook rulebook,
std::unique_ptr< const rules::TrafficLightBook traffic_light_book,
std::unique_ptr< IntersectionBook intersection_book,
std::unique_ptr< rules::PhaseRingBook phase_ring_book,
std::unique_ptr< rules::PhaseProvider phase_provider,
std::unique_ptr< rules::RuleRegistry rule_registry,
std::unique_ptr< rules::DiscreteValueRuleStateProvider discrete_value_rule_state_provider,
std::unique_ptr< rules::RangeValueRuleStateProvider range_value_rule_state_provider 
)

Constructs a RoadNetwork instance.

After creation, you are encouraged to validate it using ValidateRoadNetwork(), which is defined in maliput/api/road_network_validator.h.

◆ ~RoadNetwork()

virtual ~RoadNetwork ( )
virtualdefault

Member Function Documentation

◆ Contains() [1/2]

bool Contains ( const LaneId lane_id) const

Determines if the road networks contains lane_id.

◆ Contains() [2/2]

bool Contains ( const RoadPosition road_position) const

Determines if the road network contains road_position.

◆ discrete_value_rule_state_provider()

rules::DiscreteValueRuleStateProvider* discrete_value_rule_state_provider ( )

◆ intersection_book()

IntersectionBook* intersection_book ( )

◆ phase_provider()

rules::PhaseProvider* phase_provider ( )

◆ phase_ring_book()

const rules::PhaseRingBook* phase_ring_book ( ) const

◆ range_value_rule_state_provider()

rules::RangeValueRuleStateProvider* range_value_rule_state_provider ( )

◆ right_of_way_rule_state_provider()

rules::RightOfWayRuleStateProvider* right_of_way_rule_state_provider ( )

◆ road_geometry()

const RoadGeometry* road_geometry ( ) const

◆ rule_registry()

const rules::RuleRegistry* rule_registry ( ) const

◆ rulebook()

const rules::RoadRulebook* rulebook ( ) const

◆ traffic_light_book()

const rules::TrafficLightBook* traffic_light_book ( ) const

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