Detailed Description

Abstract interface for the state provider of RangeValueRules.

#include <include/maliput/api/rules/range_value_rule_state_provider.h>

Inheritance diagram for RangeValueRuleStateProvider:

Public Types
using	StateResult = StateProviderResult< RangeValueRule::Range >
	The state of a RangeValueRule, returned by RangeValueRuleStateProvider::GetState(const Rule::Id&). More...

Public Member Functions
virtual	~RangeValueRuleStateProvider ()=default

std::optional< StateResult >	GetState (const Rule::Id &id) const
	Gets the state of the RangeValueRule identified by `id`. More...

std::optional< StateResult >	GetState (const RoadPosition &road_position, const Rule::TypeId &rule_type, double tolerance) const
	Gets the state of the RangeValueRule that matches provided `road_position` and `rule_type` values according to certain `tolerance`. More...

Protected Member Functions
	RangeValueRuleStateProvider ()=default

Member Typedef Documentation

◆ StateResult

using StateResult = StateProviderResult<RangeValueRule::Range>

The state of a RangeValueRule, returned by RangeValueRuleStateProvider::GetState(const Rule::Id&).

Constructor & Destructor Documentation

◆ ~RangeValueRuleStateProvider()

virtual ~RangeValueRuleStateProvider ( )

virtualdefault

◆ RangeValueRuleStateProvider()

RangeValueRuleStateProvider ( )

protecteddefault

Member Function Documentation

◆ GetState() [1/2]

std::optional<StateResult> GetState	(	const RoadPosition &	road_position,
		const Rule::TypeId &	rule_type,
		double	tolerance
	)		const

Gets the state of the RangeValueRule that matches provided road_position and rule_type values according to certain tolerance.

Returns a StateResult struct bearing the state of the rule. If no rule is obtained out of the road_position and rule_type combination, std::nullopt is returned.

◆ GetState() [2/2]

std::optional<StateResult> GetState ( const Rule::Id & id ) const

Gets the state of the RangeValueRule identified by id.

Returns a StateResult struct bearing the state of the rule with the specified id. If id is unrecognized, std::nullopt is returned.

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

range_value_rule_state_provider.h