@veeroute/lss-universal-angular/model/generalStatistics.d.ts

OpenAPI client for @veeroute/lss-universal-angular

/**
 * VRt.Universal [UV]
 *
 * The version of the OpenAPI document: 7.23.2926
 * Contact: servicedesk@veeroute.com
 *
 * NOTE: This class is auto generated by OpenAPI Generator.
 * Do not edit the class manually.
 */
import { CapacityStatisticsSumUniversal } from './capacityStatisticsSum';
import { AttributeUniversal } from './attribute';
import { CapacityStatisticsRatioUniversal } from './capacityStatisticsRatio';
import { MeasurementsUniversal } from './measurements';
import { CapacityStatisticsLoadUniversal } from './capacityStatisticsLoad';
/**
 * Summary statistics for one or a set of trips.
 */
export interface GeneralStatisticsUniversal {
    [key: string]: any | any;
    /**
     * Total cost calculated based on the performer\'s and transport tariffs.
     */
    cost: number;
    /**
     * The total reward for orders fulfillment.
     */
    reward: number;
    /**
     * The total profit is equal to the difference between the total reward (`reward`) and cost (`cost`).
     */
    profit: number;
    /**
     * Measurements of times and distances for aggregate and individual trips:    * `time_window` - the start time of the first trip and the end time of the last, if there are no trips, the time of the left border of the planning horizon is returned, while the from \\ to fields have the same value   * `driving_time` - duration of driving time   * `waiting_time` - total waiting time for all locations   * `working_time` - total time of work execution at all locations included in the trip   * `break_time` - total break time for all locations   * `rest_time` - total rest time for all locations   * `arriving_time` - total time to drive / park at locations   * `departure_time` - total time for departure from locations   * `total_time` - total time, composed of `driving_time` + `waiting_time` + `working_time` + `break_time` + `rest_time` + `arriving_time` + `departure_time`   * `distance` - the total length of the roundtrip/trip/set of trips, in meters
     */
    measurements: MeasurementsUniversal;
    /**
     * The total number of planned trips.
     */
    trips_count: number;
    /**
     * The total number of performers involved in orders fulfillment.
     */
    performers_count: number;
    /**
     * The total number of planned and assigned orders.
     */
    orders_count: number;
    /**
     * The total number of planned orders.
     */
    plan_orders_count: number;
    /**
     * The total number of assigned orders.
     */
    waitlist_orders_count: number;
    /**
     * The total number of stops (non-unique locations).
     */
    stops_count: number;
    /**
     * The total number of unique locations within one trip. For general statistics - the sum of unique locations within each trip.
     */
    locations_count: number;
    /**
     * Total additive measures of the transported cargo.
     */
    cargo_capacity_sum: CapacityStatisticsSumUniversal;
    /**
     * The ratio of the total additive measures of the transported cargo to the total capacity of the boxes. In fractions of a unit. It may be more than one.
     */
    cargo_capacity_ratio: CapacityStatisticsRatioUniversal;
    /**
     * The ratio of the maximum load of boxes to the total capacity of boxes. In fractions of a unit. Cannot be greater than one.
     */
    max_transport_load: CapacityStatisticsLoadUniversal;
    /**
     * Average speed is the ratio of the total distance to the total time of movement, km/h.
     */
    average_speed: number;
    /**
     * Number of [roundtrips](#section/Description/Roundtrips) within a trip.
     */
    round_trips_count: number;
    /**
     * Average mileage per roundtrip is the ratio of the total mileage per trip to the number of roundtrips, in meters.
     */
    average_roundtrip_distance: number;
    /**
     * Time duration according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations).
     */
    average_roundtrip_time: string;
    /**
     * Attributes. Used to add service information.
     */
    attributes?: Array<AttributeUniversal>;
}