maliput
maliput::api::test Namespace Reference

Classes

class  MockBranchPoint
 
class  MockIdIndex
 
class  MockJunction
 
class  MockLane
 
class  MockLaneEndSet
 
class  MockRoadGeometry
 
class  MockSegment
 
struct  PhaseBuildFlags
 Holds Phase build configurations. More...
 
struct  RightOfWayBuildFlags
 Holds RightOfWayRule build configurations. More...
 
struct  RoadGeometryBuildFlags
 Holds RoadGeometry build configuration. More...
 
struct  RoadGeometryContiguityBuildFlags
 Holds RoadGeometry contiguity build configuration. More...
 
struct  RoadGeometryIdIndexBuildFlags
 
struct  RoadNetworkContiguityBuildFlags
 Holds RoadNetwork contiguity build configuration. More...
 
struct  RoadRulebookBuildFlags
 Holds RoadRulebook build configurations. More...
 
struct  RoadRulebookContiguityBuildFlags
 Holds RoadRulebook contiguity build configuration. More...
 
struct  RoadRulebookRelatedRulesBuildFlags
 Holds RoadRulebook build configurations when RelatedRules consitency are under test. More...
 
struct  TrafficLightBookBuildFlags
 Holds TrafficLightBook build configurations. More...
 
struct  TrafficLightBuildFlags
 Holds TrafficLight build configurations. More...
 

Functions

LaneSRoute CreateLaneSRoute ()
 Returns a LaneSRoute containing an arbitrary route. More...
 
LaneSRange CreateLaneSRange ()
 Returns a LaneSRange containing an arbitrary range. More...
 
rules::RightOfWayRule::State::YieldGroup YieldGroup2 ()
 Returns a rules::RightOfWayRule::State::YieldGroup of size two. More...
 
rules::RightOfWayRule::State NoYieldState ()
 Returns a rules::RightOfWayRule::State containing no yield groups. More...
 
rules::RightOfWayRule::State YieldState ()
 Returns a rules::RightOfWayRule::State containing yield groups. More...
 
rules::RightOfWayRule::RelatedBulbGroups RelatedBulbGroups ()
 Returns an arbitrary rules::RightOfWayRule::RelatedBulbGroups. More...
 
rules::RightOfWayRule CreateRightOfWayRule ()
 Returns a rules::RightOfWayRule containing arbitrary state. More...
 
rules::RightOfWayRule CreateRightOfWayRule (const RightOfWayBuildFlags &build_flags)
 Returns a rules::RightOfWayRule containing arbitrary state. More...
 
rules::SpeedLimitRule CreateSpeedLimitRule ()
 Returns a rules::SpeedLimitRule containing an arbitrary state. More...
 
rules::DirectionUsageRule::State CreateDirectionUsageRuleState ()
 Returns an arbitrary rules::DirectionUsageRule::State. More...
 
rules::DirectionUsageRule CreateDirectionUsageRule ()
 Returns a rules::DirectionUsageRule containing an arbitrary state. More...
 
rules::Rule::RelatedRules CreateEmptyRelatedRules ()
 Returns an empty rules::Rule::RelatedRules. More...
 
rules::Rule::RelatedRules CreateNonEmptyRelatedRules ()
 Returns an arbitrary rules::Rule::RelatedRules. More...
 
rules::Rule::RelatedUniqueIds CreateEmptyRelatedUniqueIds ()
 Returns an empty rules::Rule::RelatedUniqueIds. More...
 
rules::Rule::RelatedUniqueIds CreateNonEmptyRelatedUniqueIds ()
 Returns an arbitrary rules::Rule::RelatedUniqueIds. More...
 
rules::DiscreteValueRule CreateDiscreteValueRule ()
 Returns a rules::DiscreteValueRule containing an arbitrary state. More...
 
rules::DiscreteValueRule CreateDiscreteValueRuleForContiguityTest ()
 Returns a rules::DiscreteValueRule containing an arbitrary state. More...
 
rules::RangeValueRule::Range CreateRange ()
 Returns a rules::RangeValueRule::Range. More...
 
rules::RangeValueRule CreateRangeValueRule ()
 Returns a rules::RangeValueRule containing an arbitrary state. More...
 
rules::Phase CreatePhase ()
 Returns an arbitrary rules::Phase. More...
 
rules::Phase CreatePhase (const PhaseBuildFlags &build_flags)
 Returns a rules::Phase based on build_flags configuration. More...
 
rules::PhaseRing CreatePhaseRing ()
 Returns an arbitrary rules::PhaseRing whose rules::Phase is the result of CreatePhase(). More...
 
rules::PhaseRing CreatePhaseRing (const PhaseBuildFlags &build_flags)
 Returns a rules::PhaseRing whose rules::Phase is the result of CreatePhase(build_flags). More...
 
rules::RangeValueRule CreateRangeValueRuleForContiguityTest ()
 Returns a rules::RangeValueRule containing an arbitrary state. More...
 
std::unique_ptr< RoadNetworkCreateRoadNetwork ()
 Returns an arbitrary RoadNetwork. More...
 
std::unique_ptr< RoadGeometryCreateRoadGeometry ()
 Returns an arbitrary RoadGeometry. More...
 
std::unique_ptr< RoadGeometryCreateRoadGeometry (const RoadGeometryBuildFlags &build_flags)
 
std::unique_ptr< RoadGeometryCreateMockContiguousRoadGeometry (const RoadGeometryContiguityBuildFlags &build_flags)
 Builds a RoadGeometry based on build_flags configuration. More...
 
std::unique_ptr< RoadGeometryCreateOneLaneRoadGeometry ()
 Returns an arbitrary one-lane RoadGeometry. More...
 
std::unique_ptr< RoadGeometryCreateTwoLanesRoadGeometry ()
 Returns an arbitrary two-lane RoadGeometry. More...
 
std::unique_ptr< RoadGeometryCreateTwoLanesRoadGeometry (const LanePositionResult &lane_a_pos_result, const LanePositionResult &lane_b_pos_result)
 Returns an arbitrary two-lane RoadGeometry and each lane will return lane_a_pos_result and lane_b_pos_result when calling Lane::ToLanePosition() with any InertialPosition. More...
 
std::unique_ptr< LaneCreateLane (const LaneId &id)
 Returns an aribtrary lane with id . More...
 
std::unique_ptr< rules::RoadRulebookCreateRoadRulebook ()
 Returns an arbitrary rules::RoadRulebook. More...
 
std::unique_ptr< rules::RoadRulebookCreateRoadRulebook (const RoadRulebookBuildFlags &build_flags)
 Returns an arbitrary rules::RoadRulebook. More...
 
std::unique_ptr< rules::RoadRulebookCreateRoadRulebook (const RoadRulebookRelatedRulesBuildFlags &build_flags)
 Returns an arbitrary rules::RoadRulebook. More...
 
std::unique_ptr< rules::RoadRulebookCreateMockContiguousRoadRulebook (const RoadRulebookContiguityBuildFlags &build_flags)
 Returns an arbitrary rules::RoadRulebook. More...
 
std::unique_ptr< rules::BulbGroupCreateBulbGroup (bool add_missing_bulb_group)
 Returns an arbitrary rules::BulbGroup. More...
 
std::unique_ptr< rules::TrafficLightCreateTrafficLight (const TrafficLightBuildFlags &build_flags)
 Returns an arbitrary rules::TrafficLight. More...
 
std::unique_ptr< rules::TrafficLightBookCreateTrafficLightBook ()
 Returns an arbitrary rules::TrafficLightBook. More...
 
std::unique_ptr< rules::TrafficLightBookCreateTrafficLightBook (const TrafficLightBookBuildFlags &build_flags)
 Returns an arbitrary rules::TrafficLightBook. More...
 
std::unique_ptr< rules::PhaseRingBookCreatePhaseRingBook ()
 Returns an arbitrary rules::PhaseRingBook. More...
 
std::unique_ptr< rules::PhaseRingBookCreatePhaseRingBook (const PhaseBuildFlags &build_flags)
 Returns an arbitrary rules::PhaseRingBook based on build_flags. More...
 
std::unique_ptr< rules::RightOfWayRuleStateProvider > CreateRightOfWayRuleStateProvider ()
 Returns an arbitrary rules::RightOfWayRuleStateProvider. More...
 
std::unique_ptr< rules::PhaseProviderCreatePhaseProvider ()
 Returns an arbitrary rules::PhaseProvider. More...
 
std::unique_ptr< IntersectionBookCreateIntersectionBook ()
 Returns an arbitrary IntersectionBook. More...
 
std::unique_ptr< rules::RuleRegistryCreateRuleRegistry ()
 Returns an arbitrary rules::RuleRegistry. More...
 
std::unique_ptr< rules::RuleRegistryCreateBasicRuleRegistry ()
 Returns an arbitrary rules::RuleRegistry populated with discrete and range value rule types. More...
 
std::unique_ptr< rules::DiscreteValueRuleStateProviderCreateDiscreteValueRuleStateProvider ()
 Returns an arbitrary rules::DiscreteValueRuleStateProvider. More...
 
std::unique_ptr< rules::RangeValueRuleStateProviderCreateRangeValueRuleStateProvider ()
 Returns an arbitrary rules::RangeValueRuleStateProvider. More...
 
DiscreteValueRule CreateDiscreteValueRule (bool consistent_related_rule_groups)
 
RangeValueRule CreateRangeValueRule (bool consistent_related_rule_groups)
 
std::unique_ptr< RoadGeometryCreateMultipleLanesRoadGeometry (const std::vector< Lane * > &lanes)
 

Function Documentation

◆ CreateBasicRuleRegistry()

std::unique_ptr< rules::RuleRegistry > CreateBasicRuleRegistry ( )

Returns an arbitrary rules::RuleRegistry populated with discrete and range value rule types.

◆ CreateBulbGroup()

std::unique_ptr< BulbGroup > CreateBulbGroup ( bool  add_missing_bulb_group)

Returns an arbitrary rules::BulbGroup.

When add_missing_bulb_group is true, the rules::BulbGroup's ID is "MissingBulbGroupId". Otherwise, ID is "BulbGroupId". traffic_light_id is the rules::TrafficLight::Id to set to the rules::Bulb's rules::UniqueBulbId.

◆ CreateDirectionUsageRule()

DirectionUsageRule CreateDirectionUsageRule ( )

Returns a rules::DirectionUsageRule containing an arbitrary state.

◆ CreateDirectionUsageRuleState()

DirectionUsageRule::State CreateDirectionUsageRuleState ( )

Returns an arbitrary rules::DirectionUsageRule::State.

◆ CreateDiscreteValueRule() [1/2]

DiscreteValueRule CreateDiscreteValueRule ( )

Returns a rules::DiscreteValueRule containing an arbitrary state.

◆ CreateDiscreteValueRule() [2/2]

DiscreteValueRule maliput::api::test::CreateDiscreteValueRule ( bool  consistent_related_rule_groups)

◆ CreateDiscreteValueRuleForContiguityTest()

DiscreteValueRule CreateDiscreteValueRuleForContiguityTest ( )

Returns a rules::DiscreteValueRule containing an arbitrary state.

◆ CreateDiscreteValueRuleStateProvider()

std::unique_ptr< rules::DiscreteValueRuleStateProvider > CreateDiscreteValueRuleStateProvider ( )

◆ CreateEmptyRelatedRules()

rules::Rule::RelatedRules CreateEmptyRelatedRules ( )

Returns an empty rules::Rule::RelatedRules.

◆ CreateEmptyRelatedUniqueIds()

rules::Rule::RelatedUniqueIds CreateEmptyRelatedUniqueIds ( )

Returns an empty rules::Rule::RelatedUniqueIds.

◆ CreateIntersectionBook()

std::unique_ptr< IntersectionBook > CreateIntersectionBook ( )

Returns an arbitrary IntersectionBook.

◆ CreateLane()

std::unique_ptr< Lane > CreateLane ( const LaneId id)

Returns an aribtrary lane with id .

◆ CreateLaneSRange()

LaneSRange CreateLaneSRange ( )

Returns a LaneSRange containing an arbitrary range.

◆ CreateLaneSRoute()

LaneSRoute CreateLaneSRoute ( )

Returns a LaneSRoute containing an arbitrary route.

◆ CreateMockContiguousRoadGeometry()

std::unique_ptr< RoadGeometry > CreateMockContiguousRoadGeometry ( const RoadGeometryContiguityBuildFlags build_flags)

Builds a RoadGeometry based on build_flags configuration.

When build.flags.add_linear_mismatch is true, end of first lane and start of second lane will be separated by more than linear_tolerance. When build_flags.add_angular_mismatch is true, heading angular distance between the end of the first lane and the start of the second lane will be bigger than angular_tolerance.

Returns
A MockRoadGeometry pointer.

◆ CreateMockContiguousRoadRulebook()

std::unique_ptr< rules::RoadRulebook > CreateMockContiguousRoadRulebook ( const RoadRulebookContiguityBuildFlags build_flags)

Returns an arbitrary rules::RoadRulebook.

When build_flags.add_discrete_value is true, a DiscreteValueRule is created with CreateDiscreteValueRuleForContiguityTest(). When build_flags.add_range_value is true, a RangeValueRule is created with CreateRangeValueRuleForContiguityTest().

◆ CreateMultipleLanesRoadGeometry()

std::unique_ptr<RoadGeometry> maliput::api::test::CreateMultipleLanesRoadGeometry ( const std::vector< Lane * > &  lanes)

◆ CreateNonEmptyRelatedRules()

rules::Rule::RelatedRules CreateNonEmptyRelatedRules ( )

Returns an arbitrary rules::Rule::RelatedRules.

◆ CreateNonEmptyRelatedUniqueIds()

rules::Rule::RelatedUniqueIds CreateNonEmptyRelatedUniqueIds ( )

Returns an arbitrary rules::Rule::RelatedUniqueIds.

◆ CreateOneLaneRoadGeometry()

std::unique_ptr< RoadGeometry > CreateOneLaneRoadGeometry ( )

Returns an arbitrary one-lane RoadGeometry.

◆ CreatePhase() [1/2]

Phase CreatePhase ( )

Returns an arbitrary rules::Phase.

◆ CreatePhase() [2/2]

Phase CreatePhase ( const PhaseBuildFlags build_flags)

Returns a rules::Phase based on build_flags configuration.

When build_flags.add_missing_rule is true, an unknown rule id is added; and if build_flags.add_missing_value is true, an unknown rules::DiscreteValueRule::DiscreteValue is added. Otherwise, it adds a reference to both rules::Rule::Id and rules::DiscreteValueRule::DiscreteValue offered by CreateDiscreteValueRule(). When build_flags.add_missing_bulb is true, an unknown rules::UniqueBulbId is added; and if build_flags.add_missing_bulb_state is true, the rules::Bulb's rules::BulbState will be other than the one set by CreateBulbGroup().

◆ CreatePhaseProvider()

std::unique_ptr< rules::PhaseProvider > CreatePhaseProvider ( )

Returns an arbitrary rules::PhaseProvider.

◆ CreatePhaseRing() [1/2]

PhaseRing CreatePhaseRing ( )

Returns an arbitrary rules::PhaseRing whose rules::Phase is the result of CreatePhase().

◆ CreatePhaseRing() [2/2]

PhaseRing CreatePhaseRing ( const PhaseBuildFlags build_flags)

Returns a rules::PhaseRing whose rules::Phase is the result of CreatePhase(build_flags).

◆ CreatePhaseRingBook() [1/2]

std::unique_ptr< rules::PhaseRingBook > CreatePhaseRingBook ( )

Returns an arbitrary rules::PhaseRingBook.

◆ CreatePhaseRingBook() [2/2]

std::unique_ptr< rules::PhaseRingBook > CreatePhaseRingBook ( const PhaseBuildFlags build_flags)

Returns an arbitrary rules::PhaseRingBook based on build_flags.

◆ CreateRange()

◆ CreateRangeValueRule() [1/2]

RangeValueRule CreateRangeValueRule ( )

Returns a rules::RangeValueRule containing an arbitrary state.

◆ CreateRangeValueRule() [2/2]

RangeValueRule maliput::api::test::CreateRangeValueRule ( bool  consistent_related_rule_groups)

◆ CreateRangeValueRuleForContiguityTest()

RangeValueRule CreateRangeValueRuleForContiguityTest ( )

Returns a rules::RangeValueRule containing an arbitrary state.

◆ CreateRangeValueRuleStateProvider()

std::unique_ptr< rules::RangeValueRuleStateProvider > CreateRangeValueRuleStateProvider ( )

Returns an arbitrary rules::RangeValueRuleStateProvider.

◆ CreateRightOfWayRule() [1/2]

RightOfWayRule CreateRightOfWayRule ( )

Returns a rules::RightOfWayRule containing arbitrary state.

Forwards the call to CreateRightOfWayRule() with a default initialized RightOfWayBuildFlags.

◆ CreateRightOfWayRule() [2/2]

RightOfWayRule CreateRightOfWayRule ( const RightOfWayBuildFlags build_flags)

Returns a rules::RightOfWayRule containing arbitrary state.

When build_flags.add_related_bulb_groups is true, the rule is constructed with RelatedBulbGroups() result. Otherwise, the rule is constructed with an empty collection for the field.

◆ CreateRightOfWayRuleStateProvider()

std::unique_ptr< rules::RightOfWayRuleStateProvider > CreateRightOfWayRuleStateProvider ( )

Returns an arbitrary rules::RightOfWayRuleStateProvider.

◆ CreateRoadGeometry() [1/2]

std::unique_ptr< RoadGeometry > CreateRoadGeometry ( )

Returns an arbitrary RoadGeometry.

◆ CreateRoadGeometry() [2/2]

std::unique_ptr< RoadGeometry > CreateRoadGeometry ( const RoadGeometryBuildFlags build_flags)

◆ CreateRoadNetwork()

std::unique_ptr< RoadNetwork > CreateRoadNetwork ( )

Returns an arbitrary RoadNetwork.

It calls all the Create*() functions in this header file to populate the RoadNetwork.

◆ CreateRoadRulebook() [1/3]

std::unique_ptr< rules::RoadRulebook > CreateRoadRulebook ( )

Returns an arbitrary rules::RoadRulebook.

Forwards the call to CreateRoadRulebook() passing a default-constructed RoadRulebookBuildFlags structure.

◆ CreateRoadRulebook() [2/3]

std::unique_ptr< rules::RoadRulebook > CreateRoadRulebook ( const RoadRulebookBuildFlags build_flags)

Returns an arbitrary rules::RoadRulebook.

When build_flags.add_right_of_way is true, a RightOfWayRule is created with CreateRightOfWayRule() and build_flags.right_of_way_build_flags is used to configure the RightOfWayRule. When build_flags.add_direction_usage is true, a DirectionUsageRule is created with CreateDirectionUsageRule(). When build_flags.add_speed_limit is true, a SpeedLimitRule is created with CreateSpeedLimitRule. When build_flags.add_discrete_value is true, a DiscreteValueRule is created with CreateDiscreteValueRule(). When build_flags.add_range_value is true, a RangeValueRule is created with CreateRangeValueRule().

◆ CreateRoadRulebook() [3/3]

std::unique_ptr< rules::RoadRulebook > CreateRoadRulebook ( const RoadRulebookRelatedRulesBuildFlags build_flags)

Returns an arbitrary rules::RoadRulebook.

See also
CreateRoadRulebook(const RoadRulebookBuildFlags& build_flags) for rule construction logic.

When build_flags.roadrulebook.add_discrete_value, build_flags.consistent_related_rule_in_discrete_value_rule will create a self reference to provide a valid rule::Rule::Id as a RelatedRule. When build_flags.roadrulebook.add_Range_value, build_flags.consistent_related_rule_in_range_value_rule will create a self reference to provide a valid rule::Rule::Id as a RelatedRule.

◆ CreateRuleRegistry()

std::unique_ptr< rules::RuleRegistry > CreateRuleRegistry ( )

Returns an arbitrary rules::RuleRegistry.

◆ CreateSpeedLimitRule()

SpeedLimitRule CreateSpeedLimitRule ( )

Returns a rules::SpeedLimitRule containing an arbitrary state.

◆ CreateTrafficLight()

std::unique_ptr< TrafficLight > CreateTrafficLight ( const TrafficLightBuildFlags build_flags)

Returns an arbitrary rules::TrafficLight.

When build_flags.add_missing_bulb_group is true, the rules::TrafficLight's ID is "MissingTrafficLightId". Otherwise, ID is "TrafficLightId". BulbGroup creation is done via CreateBulbGroup(build_flags.add_missing_bulb_group).

◆ CreateTrafficLightBook() [1/2]

std::unique_ptr< rules::TrafficLightBook > CreateTrafficLightBook ( )

Returns an arbitrary rules::TrafficLightBook.

◆ CreateTrafficLightBook() [2/2]

std::unique_ptr< rules::TrafficLightBook > CreateTrafficLightBook ( const TrafficLightBookBuildFlags build_flags)

Returns an arbitrary rules::TrafficLightBook.

◆ CreateTwoLanesRoadGeometry() [1/2]

std::unique_ptr< RoadGeometry > CreateTwoLanesRoadGeometry ( )

Returns an arbitrary two-lane RoadGeometry.

Forwards the call to CreateTwoLanesRoadGeometry(const LanePositionResult&, const LanePositionResult&) and provides two hardcoded LanePositionResults:

  • "lane_a": {{10., 20., 30.}, {12., 89., 1.}, 0.5}
  • "lane_b": {{40., 50., 60.}, {50., 1., 45.}, 30.}

◆ CreateTwoLanesRoadGeometry() [2/2]

std::unique_ptr< RoadGeometry > CreateTwoLanesRoadGeometry ( const LanePositionResult lane_a_pos_result,
const LanePositionResult lane_b_pos_result 
)

Returns an arbitrary two-lane RoadGeometry and each lane will return lane_a_pos_result and lane_b_pos_result when calling Lane::ToLanePosition() with any InertialPosition.

◆ NoYieldState()

RightOfWayRule::State NoYieldState ( )

Returns a rules::RightOfWayRule::State containing no yield groups.

◆ RelatedBulbGroups()

RightOfWayRule::RelatedBulbGroups RelatedBulbGroups ( )

Returns an arbitrary rules::RightOfWayRule::RelatedBulbGroups.

◆ YieldGroup2()

RightOfWayRule::State::YieldGroup YieldGroup2 ( )

Returns a rules::RightOfWayRule::State::YieldGroup of size two.

◆ YieldState()

RightOfWayRule::State YieldState ( )

Returns a rules::RightOfWayRule::State containing yield groups.