Struct TransitionAttributes 

#[non_exhaustive]
pub struct TransitionAttributes {
    pub src_tag: String,
    pub excluded_src_tag: String,
    pub dst_tag: String,
    pub excluded_dst_tag: String,
    pub cost: f64,
    pub cost_per_kilometer: f64,
    pub distance_limit: Option<DistanceLimit>,
    pub delay: Option<Duration>,
    /* private fields */
}

Specifies attributes of transitions between two consecutive visits on a route. Several TransitionAttributes may apply to the same transition: in that case, all extra costs add up and the strictest constraint or limit applies (following natural “AND” semantics).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

src_tag: String

Tags defining the set of (src->dst) transitions these attributes apply to.

A source visit or vehicle start matches iff its VisitRequest.tags or Vehicle.start_tags either contains src_tag or does not contain excluded_src_tag (depending on which of these two fields is non-empty).

excluded_src_tag: String

See src_tag. Exactly one of src_tag and excluded_src_tag must be non-empty.

dst_tag: String

A destination visit or vehicle end matches iff its VisitRequest.tags or Vehicle.end_tags either contains dst_tag or does not contain excluded_dst_tag (depending on which of these two fields is non-empty).

excluded_dst_tag: String

See dst_tag. Exactly one of dst_tag and excluded_dst_tag must be non-empty.

cost: f64

Specifies a cost for performing this transition. This is in the same unit as all other costs in the model and must not be negative. It is applied on top of all other existing costs.

cost_per_kilometer: f64

Specifies a cost per kilometer applied to the distance traveled while performing this transition. It adds up to any Vehicle.cost_per_kilometer specified on vehicles.

distance_limit: Option<DistanceLimit>

Specifies a limit on the distance traveled while performing this transition.

As of 2021/06, only soft limits are supported.

delay: Option<Duration>

Specifies a delay incurred when performing this transition.

This delay always occurs after finishing the source visit and before starting the destination visit.

Implementations

impl TransitionAttributes

pub fn new() -> Self

pub fn set_src_tag<T: Into<String>>(self, v: T) -> Self

Sets the value of src_tag.

pub fn set_excluded_src_tag<T: Into<String>>(self, v: T) -> Self

Sets the value of excluded_src_tag.

pub fn set_dst_tag<T: Into<String>>(self, v: T) -> Self

Sets the value of dst_tag.

pub fn set_excluded_dst_tag<T: Into<String>>(self, v: T) -> Self

Sets the value of excluded_dst_tag.

pub fn set_cost<T: Into<f64>>(self, v: T) -> Self

Sets the value of cost.

pub fn set_cost_per_kilometer<T: Into<f64>>(self, v: T) -> Self

Sets the value of cost_per_kilometer.

pub fn set_distance_limit<T>(self, v: T) -> Self

where T: Into<DistanceLimit>,

Sets the value of distance_limit.

pub fn set_or_clear_distance_limit<T>(self, v: Option<T>) -> Self

where T: Into<DistanceLimit>,

Sets or clears the value of distance_limit.

pub fn set_delay<T>(self, v: T) -> Self

where T: Into<Duration>,

Sets the value of delay.

pub fn set_or_clear_delay<T>(self, v: Option<T>) -> Self

where T: Into<Duration>,

Sets or clears the value of delay.

Trait Implementations

impl Clone for TransitionAttributes

fn clone(&self) -> TransitionAttributes

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TransitionAttributes

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TransitionAttributes

fn default() -> TransitionAttributes

Returns the “default value” for a type.

impl Message for TransitionAttributes

fn typename() -> &'static str

The typename of this message.

impl PartialEq for TransitionAttributes

fn eq(&self, other: &TransitionAttributes) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TransitionAttributes