Drake
TrivialRightOfWayStateProvider Class Referencefinal

A trivial implementation of an api::rules::RightOfWayStateProvider. More...

#include <automotive/trivial_right_of_way_state_provider.h>

Inheritance diagram for TrivialRightOfWayStateProvider:
[legend]
Collaboration diagram for TrivialRightOfWayStateProvider:
[legend]

Public Member Functions

 TrivialRightOfWayStateProvider ()
 Default constructor. More...
 
 ~TrivialRightOfWayStateProvider () final=default
 
void AddState (const maliput::api::rules::RightOfWayRule::Id &id, const maliput::api::rules::RightOfWayRule::DynamicState &initial_state)
 Adds a dynamic state to this provider. More...
 
void SetState (const maliput::api::rules::RightOfWayRule::Id &id, const maliput::api::rules::RightOfWayRule::DynamicState &state)
 Sets the dynamic state of a RightOfWayRule within this provider. More...
 
Does not allow copy, move, or assignment
 TrivialRightOfWayStateProvider (const TrivialRightOfWayStateProvider &)=delete
 
TrivialRightOfWayStateProvideroperator= (const TrivialRightOfWayStateProvider &)=delete
 
 TrivialRightOfWayStateProvider (TrivialRightOfWayStateProvider &&)=delete
 
TrivialRightOfWayStateProvideroperator= (TrivialRightOfWayStateProvider &&)=delete
 
- Public Member Functions inherited from RightOfWayStateProvider
virtual ~RightOfWayStateProvider ()=default
 
RightOfWayRule::DynamicState GetState (const RightOfWayRule::Id &id) const
 Returns the current state of the RightOfWayRule identified by id. More...
 
 RightOfWayStateProvider (const RightOfWayStateProvider &)=delete
 
RightOfWayStateProvideroperator= (const RightOfWayStateProvider &)=delete
 
 RightOfWayStateProvider (RightOfWayStateProvider &&)=delete
 
RightOfWayStateProvideroperator= (RightOfWayStateProvider &&)=delete
 

Additional Inherited Members

- Protected Member Functions inherited from RightOfWayStateProvider
 RightOfWayStateProvider ()=default
 

Detailed Description

A trivial implementation of an api::rules::RightOfWayStateProvider.

Constructor & Destructor Documentation

Default constructor.

Here is the call graph for this function:

~TrivialRightOfWayStateProvider ( )
finaldefault

Here is the caller graph for this function:

Member Function Documentation

void AddState ( const maliput::api::rules::RightOfWayRule::Id id,
const maliput::api::rules::RightOfWayRule::DynamicState initial_state 
)

Adds a dynamic state to this provider.

Throws std::logic_error if a RightOfWayRule with an ID of id already exists in this provider.

Throws std::runtime_error if the dynamic state failed to be added.

Here is the caller graph for this function:

Sets the dynamic state of a RightOfWayRule within this provider.

Throws std::out_of_range if no dynamic state with id exists in this provider.

Here is the caller graph for this function:


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