Skip to content

Vehicle module

Reference to the schema.vehicle.py module.

vehicle

Defines the vehicle class.

InitialStop

Bases: BaseModel

Represents a stop that is already planned on a vehicle.

id instance-attribute 

id: str

Unique identifier of the stop.

fixed class-attribute instance-attribute 

fixed: bool | None = None

Whether the stop is fixed on the route.

VehicleDefaults

Bases: BaseModel

Default values for vehicles.

activation_penalty class-attribute instance-attribute 

activation_penalty: int | None = None

Penalty of using the vehicle.

alternate_stops class-attribute instance-attribute 

alternate_stops: list[str] | None = None

A set of alternate stops for which only one should be serviced.

capacity class-attribute instance-attribute 

capacity: Any | None = None

Capacity of the vehicle.

compatibility_attributes class-attribute instance-attribute 

compatibility_attributes: list[str] | None = None

Attributes that the vehicle is compatible with.

end_location class-attribute instance-attribute 

end_location: Location | None = None

Location where the vehicle ends.

end_time class-attribute instance-attribute 

end_time: datetime | None = None

Latest time at which the vehicle ends its route.

max_distance class-attribute instance-attribute 

max_distance: int | None = None

Maximum distance in meters that the vehicle can travel.

max_duration class-attribute instance-attribute 

max_duration: int | None = None

Maximum duration in seconds that the vehicle can travel.

max_stops class-attribute instance-attribute 

max_stops: int | None = None

Maximum number of stops that the vehicle can visit.

max_wait class-attribute instance-attribute 

max_wait: int | None = None

Maximum aggregated waiting time that the vehicle can wait across route stops.

min_stops class-attribute instance-attribute 

min_stops: int | None = None

Minimum stops that a vehicle should visit.

min_stops_penalty class-attribute instance-attribute 

min_stops_penalty: float | None = None

Penalty for not visiting the minimum number of stops.

speed class-attribute instance-attribute 

speed: float | None = None

Speed of the vehicle in meters per second.

start_level class-attribute instance-attribute 

start_level: Any | None = None

Initial level of the vehicle.

start_location class-attribute instance-attribute 

start_location: Location | None = None

Location where the vehicle starts.

start_time class-attribute instance-attribute 

start_time: datetime | None = None

Time when the vehicle starts its route.

Vehicle

Bases: VehicleDefaults

A vehicle services stops in a Vehicle Routing Problem (VRP).

id instance-attribute 

id: str

Unique identifier of the vehicle.

custom_data class-attribute instance-attribute 

custom_data: Any | None = None

Arbitrary custom data.

initial_stops class-attribute instance-attribute 

initial_stops: list[InitialStop] | None = None

Initial stops planned on the vehicle.

stop_duration_multiplier class-attribute instance-attribute 

stop_duration_multiplier: float | None = None

Multiplier for the duration of stops.

activation_penalty class-attribute instance-attribute 

activation_penalty: int | None = None

Penalty of using the vehicle.

alternate_stops class-attribute instance-attribute 

alternate_stops: list[str] | None = None

A set of alternate stops for which only one should be serviced.

capacity class-attribute instance-attribute 

capacity: Any | None = None

Capacity of the vehicle.

compatibility_attributes class-attribute instance-attribute 

compatibility_attributes: list[str] | None = None

Attributes that the vehicle is compatible with.

end_location class-attribute instance-attribute 

end_location: Location | None = None

Location where the vehicle ends.

end_time class-attribute instance-attribute 

end_time: datetime | None = None

Latest time at which the vehicle ends its route.

max_distance class-attribute instance-attribute 

max_distance: int | None = None

Maximum distance in meters that the vehicle can travel.

max_duration class-attribute instance-attribute 

max_duration: int | None = None

Maximum duration in seconds that the vehicle can travel.

max_stops class-attribute instance-attribute 

max_stops: int | None = None

Maximum number of stops that the vehicle can visit.

max_wait class-attribute instance-attribute 

max_wait: int | None = None

Maximum aggregated waiting time that the vehicle can wait across route stops.

min_stops class-attribute instance-attribute 

min_stops: int | None = None

Minimum stops that a vehicle should visit.

min_stops_penalty class-attribute instance-attribute 

min_stops_penalty: float | None = None

Penalty for not visiting the minimum number of stops.

speed class-attribute instance-attribute 

speed: float | None = None

Speed of the vehicle in meters per second.

start_level class-attribute instance-attribute 

start_level: Any | None = None

Initial level of the vehicle.

start_location class-attribute instance-attribute 

start_location: Location | None = None

Location where the vehicle starts.

start_time class-attribute instance-attribute 

start_time: datetime | None = None

Time when the vehicle starts its route.