Skip to main content

PhaseRing

maliput::api::rules

Struct PhaseRing 

Source 
pub struct PhaseRing { /* private fields */ }
Expand description

Defines a ring of phases in a traffic rule system.

A phase ring represents a sequence of phases that a traffic control system cycles through.

Implementations§

Source§

impl PhaseRing

Source

pub fn id(&self) -> String

Gets the id of the PhaseRing.

§Returns

The id of the PhaseRing.

Source

pub fn get_phase(&self, id: &String) -> Option<Phase>

Gets a Phase by its id

§Arguments
  • id - The id of the Phase.
§Returns

The Phase with the given id. If no Phase is found with the given id, return None.

Source

pub fn phases(&self) -> Vec<String>

Returns the ids of all Phases in the PhaseRing.

§Returns

A vector of strings representing the ids of all Phases in the PhaseRing.

Source

pub fn get_next_phases( &self, id: &String, ) -> Result<Vec<NextPhase>, MaliputError>

Returns the next phases for a given phase id.

§Arguments
  • id - The id of the phase to get the next phases from.
§Returns

A Result containing a vector of NextPhases.

§Errors

Returns a MaliputError if the provided id is not found in the PhaseRing.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.