Skip to content

Output module

Reference to the schema.output.py module.

output

Defines the output class.

Version

Bases: BaseModel

A version used for solving.

sdk instance-attribute 

sdk: str

Nextmv SDK.

StopOutput

Bases: BaseModel

Basic structure for the output of a stop.

id instance-attribute 

id: str

ID of the stop.

location instance-attribute 

location: Location

Location of the stop.

custom_data class-attribute instance-attribute 

custom_data: Any | None = None

Custom data of the stop.

PlannedStopOutput

Bases: BaseModel

Output of a stop planned in the solution.

stop instance-attribute 

stop: StopOutput

Basic information on the stop.

arrival_time class-attribute instance-attribute 

arrival_time: datetime | None = None

Actual arrival time at this stop.

cumulative_travel_distance class-attribute instance-attribute 

cumulative_travel_distance: float | None = None

Cumulative distance to travel from the first stop to this one, in meters.

cumulative_travel_duration class-attribute instance-attribute 

cumulative_travel_duration: float | None = None

Cumulative duration to travel from the first stop to this one, in seconds.

custom_data class-attribute instance-attribute 

custom_data: Any | None = None

Custom data of the stop.

duration class-attribute instance-attribute 

duration: float | None = None

Duration of the service at the stop, in seconds.

early_arrival_duration class-attribute instance-attribute 

early_arrival_duration: float | None = None

Duration of early arrival at the stop, in seconds.

end_time class-attribute instance-attribute 

end_time: datetime | None = None

End time of the service at the stop.

late_arrival_duration class-attribute instance-attribute 

late_arrival_duration: float | None = None

Duration of late arrival at the stop, in seconds.

mix_items class-attribute instance-attribute 

mix_items: Any | None = None

Mix items at the stop.

start_time class-attribute instance-attribute 

start_time: datetime | None = None

Start time of the service at the stop.

target_arrival_time class-attribute instance-attribute 

target_arrival_time: datetime | None = None

Target arrival time at this stop.

travel_distance class-attribute instance-attribute 

travel_distance: float | None = None

Distance to travel from the previous stop to this one, in meters.

travel_duration class-attribute instance-attribute 

travel_duration: float | None = None

Duration to travel from the previous stop to this one, in seconds.

waiting_duration class-attribute instance-attribute 

waiting_duration: float | None = None

Waiting duratino at the stop, in seconds.

VehicleOutput

Bases: BaseModel

Output of a vehicle in the solution.

id instance-attribute 

id: str

ID of the vehicle.

alternate_stops class-attribute instance-attribute 

alternate_stops: list[str] | None = None

List of alternate stops that were planned on the vehicle.

custom_data class-attribute instance-attribute 

custom_data: Any | None = None

Custom data of the vehicle.

route class-attribute instance-attribute 

route: list[PlannedStopOutput] | None = None

Route of the vehicle, which is a list of stops that were planned on it.

route_duration class-attribute instance-attribute 

route_duration: float | None = None

Total duration of the vehicle's route, in seconds.

route_stops_duration class-attribute instance-attribute 

route_stops_duration: float | None = None

Total duration of the stops of the vehicle, in seconds.

route_travel_distance class-attribute instance-attribute 

route_travel_distance: float | None = None

Total travel distance of the vehicle, in meters.

route_travel_duration class-attribute instance-attribute 

route_travel_duration: float | None = None

Total travel duration of the vehicle, in seconds.

route_waiting_duration class-attribute instance-attribute 

route_waiting_duration: float | None = None

Total waiting duration of the vehicle, in seconds.

ObjectiveOutput

Bases: BaseModel

Information of the objective (value function).

name instance-attribute 

name: str

Name of the objective.

base class-attribute instance-attribute 

base: float | None = None

Base of the objective.

custom_data class-attribute instance-attribute 

custom_data: Any | None = None

Custom data of the objective.

factor class-attribute instance-attribute 

factor: float | None = None

Factor of the objective.

objectives class-attribute instance-attribute 

objectives: list[dict[str, Any]] | None = None

List of objectives. Each list is actually of the same class ObjectiveOutput, but we avoid a recursive definition here.

value class-attribute instance-attribute 

value: float | None = None

Value of the objective, which is equivalent to self.base * self.factor.

Solution

Bases: BaseModel

Solution to a Vehicle Routing Problem (VRP).

unplanned class-attribute instance-attribute 

unplanned: list[StopOutput] | None = None

List of stops that were not planned in the solution.

vehicles class-attribute instance-attribute 

vehicles: list[VehicleOutput] | None = None

List of vehicles in the solution.

objective class-attribute instance-attribute 

objective: ObjectiveOutput | None = None

Information of the objective (value function).

check class-attribute instance-attribute 

check: Output | None = None

Check of the solution, if enabled.

Output

Bases: BaseModel

Output schema for Nextroute.

options instance-attribute 

options: dict[str, Any]

Options used to obtain this output.

version instance-attribute 

version: Version

Versions used for the solution.

solutions class-attribute instance-attribute 

solutions: list[Solution] | None = None

Solutions to the problem.

statistics class-attribute instance-attribute 

statistics: Statistics | None = None

Statistics of the solution.