PhaseProvider Class Reference

Detailed Description

Abstract interface for providing the dynamic states (Phase::Id) of a collection of PhaseRings.

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

Inheritance diagram for PhaseProvider:

Public Types
using	Result = StateProviderResult< Phase::Id >
	Result returned by GetPhase(). More...

Public Member Functions
	MALIPUT_NO_COPY_NO_MOVE_NO_ASSIGN (PhaseProvider)
virtual	~PhaseProvider ()=default
std::optional< Result >	GetPhase (const PhaseRing::Id &id) const
	Gets the phase within a specified PhaseRing. More...

Protected Member Functions
	PhaseProvider ()=default

Member Typedef Documentation

Result

using Result = StateProviderResult<Phase::Id>

Result returned by GetPhase().

Constructor & Destructor Documentation

~PhaseProvider()

virtual ~PhaseProvider ( )

virtualdefault

PhaseProvider()

PhaseProvider ( )

protecteddefault

Member Function Documentation

GetPhase()

std::optional<Result> GetPhase

(

const PhaseRing::Id &

id

)

const

Gets the phase within a specified PhaseRing.

Returns std::nullopt if id is unrecognized.

MALIPUT_NO_COPY_NO_MOVE_NO_ASSIGN()

MALIPUT_NO_COPY_NO_MOVE_NO_ASSIGN

(

PhaseProvider

)

---

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

• phase_provider.h