Drake
RightOfWayStateProvider Class Referenceabstract

Abstract interface for the provider of the state of a dynamic (multiple state) RightOfWayRule. More...

#include <drake/automotive/maliput/api/rules/right_of_way_rule.h>

Inheritance diagram for RightOfWayStateProvider:
[legend]

Classes

struct  Result
 Result returned by GetState(). More...
 

Public Member Functions

virtual ~RightOfWayStateProvider ()=default
 
drake::optional< ResultGetState (const RightOfWayRule::Id &id) const
 Gets the state of the RightOfWayRule identified by id. More...
 
Does not allow copy, move, or assignment
 RightOfWayStateProvider (const RightOfWayStateProvider &)=delete
 
RightOfWayStateProvideroperator= (const RightOfWayStateProvider &)=delete
 
 RightOfWayStateProvider (RightOfWayStateProvider &&)=delete
 
RightOfWayStateProvideroperator= (RightOfWayStateProvider &&)=delete
 

Protected Member Functions

 RightOfWayStateProvider ()=default
 

Detailed Description

Abstract interface for the provider of the state of a dynamic (multiple state) RightOfWayRule.

Constructor & Destructor Documentation

virtual ~RightOfWayStateProvider ( )
virtualdefault
RightOfWayStateProvider ( )
protecteddefault

Member Function Documentation

drake::optional<Result> GetState ( const RightOfWayRule::Id id) const
inline

Gets the state of the RightOfWayRule identified by id.

Returns a Result struct bearing the State::Id of the rule's current state. If a transition to a new state is anticipated, Result::next will be populated and bear the State::Id of the next state. If the time until the transition is known, then Result::next.duration_until will be populated with that duration.

Returns nullopt if id is unrecognized, which would be the case if no such rule exists or if the rule has only static semantics.

RightOfWayStateProvider& operator= ( const RightOfWayStateProvider )
delete

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