maliput::api::rules

Struct DiscreteValueRule

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

§Rule

A Rule may have multiple states that affect agent behavior while it is driving through the rule’s zone. The possible states of a Rule must be semantically coherent. The current state of a Rule is given by a [RuleStateProvider]. States can be:

§DiscreteValueRule

DiscreteValues are defined by a string value. Semantics of this rule are based on all possible values that this DiscreteValueRule::type_id could have (as specified by RuleRegistry::FindRuleByType()), not only the subset of values that a specific instance of this rule can be in.

Implementations§

Source§

impl DiscreteValueRule

Source

pub fn id(&self) -> String

Returns the Id of the rule as a string.

Source

pub fn type_id(&self) -> String

Returns the type of the rule as a string. Example: “right-of-way-rule-type-id”, “direction-usage-rule-type-id”

Source

pub fn zone(&self) -> LaneSRoute

Returns a [LaneSRoute] that represents the zone that the rule applies to.

Source

pub fn states(&self) -> Vec<DiscreteValue>

Returns the states of the rule.

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.