Struct AggregatedMetrics

#[non_exhaustive]
pub struct AggregatedMetrics {
    pub performed_shipment_count: i32,
    pub travel_duration: Option<Duration>,
    pub wait_duration: Option<Duration>,
    pub delay_duration: Option<Duration>,
    pub break_duration: Option<Duration>,
    pub visit_duration: Option<Duration>,
    pub total_duration: Option<Duration>,
    pub travel_distance_meters: f64,
    pub max_loads: HashMap<String, VehicleLoad>,
    pub costs: HashMap<String, f64>,
    pub total_cost: f64,
}

Aggregated metrics for ShipmentRoute (resp. for OptimizeToursResponse over all Transition and/or Visit (resp. over all ShipmentRoute) elements.

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.

performed_shipment_count: i32

Number of shipments performed. Note that a pickup and delivery pair only counts once.

travel_duration: Option<Duration>

Total travel duration for a route or a solution.

wait_duration: Option<Duration>

Total wait duration for a route or a solution.

delay_duration: Option<Duration>

Total delay duration for a route or a solution.

break_duration: Option<Duration>

Total break duration for a route or a solution.

visit_duration: Option<Duration>

Total visit duration for a route or a solution.

total_duration: Option<Duration>

The total duration should be equal to the sum of all durations above. For routes, it also corresponds to: ShipmentRoute.vehicle_end_time - ShipmentRoute.vehicle_start_time

travel_distance_meters: f64

Total travel distance for a route or a solution.

max_loads: HashMap<String, VehicleLoad>

Maximum load achieved over the entire route (resp. solution), for each of the quantities on this route (resp. solution), computed as the maximum over all Transition.vehicle_loads (resp. ShipmentRoute.metrics.max_loads.

costs: HashMap<String, f64>

Deprecated: Use ShipmentRoute.route_costs and OptimizeToursResponse.Metrics.costs instead.

total_cost: f64

Deprecated: Use ShipmentRoute.route_total_cost and OptimizeToursResponse.Metrics.total_cost instead.

Implementations

impl AggregatedMetrics

pub fn new() -> Self

pub fn set_performed_shipment_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of performed_shipment_count.

pub fn set_travel_duration<T: Into<Option<Duration>>>(self, v: T) -> Self

Sets the value of travel_duration.

pub fn set_wait_duration<T: Into<Option<Duration>>>(self, v: T) -> Self

Sets the value of wait_duration.

pub fn set_delay_duration<T: Into<Option<Duration>>>(self, v: T) -> Self

Sets the value of delay_duration.

pub fn set_break_duration<T: Into<Option<Duration>>>(self, v: T) -> Self

Sets the value of break_duration.

pub fn set_visit_duration<T: Into<Option<Duration>>>(self, v: T) -> Self

Sets the value of visit_duration.

pub fn set_total_duration<T: Into<Option<Duration>>>(self, v: T) -> Self

Sets the value of total_duration.

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

Sets the value of travel_distance_meters.

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

Sets the value of total_cost.

pub fn set_max_loads<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<VehicleLoad>,

Sets the value of max_loads.

pub fn set_costs<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<f64>,

Sets the value of costs.

Trait Implementations

impl Clone for AggregatedMetrics

fn clone(&self) -> AggregatedMetrics

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AggregatedMetrics

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

Formats the value using the given formatter.

impl Default for AggregatedMetrics

fn default() -> AggregatedMetrics

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AggregatedMetrics

where AggregatedMetrics: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for AggregatedMetrics

fn typename() -> &'static str

The typename of this message.

fn to_map(&self) -> Result<Map<String, Value>, AnyError>

where Self: Sized + Serialize,

Store the value into a JSON object.

fn from_map(map: &Map<String, Value>) -> Result<Self, AnyError>

where Self: DeserializeOwned,

Extract the value from a JSON object.

impl PartialEq for AggregatedMetrics

fn eq(&self, other: &AggregatedMetrics) -> 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 Serialize for AggregatedMetrics

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AggregatedMetrics