Skip to content

Stop module

Reference to the schema.stop.py module.

stop

Defines the stop class.

StopDefaults

Bases: BaseModel

Default values for a stop.

compatibility_attributes class-attribute instance-attribute 

compatibility_attributes: list[str] | None = None

Attributes that the stop is compatible with.

duration class-attribute instance-attribute 

duration: int | None = None

Duration of the stop in seconds.

early_arrival_time_penalty class-attribute instance-attribute 

early_arrival_time_penalty: float | None = None

Penalty per second for arriving at the stop before the target arrival time.

late_arrival_time_penalty class-attribute instance-attribute 

late_arrival_time_penalty: float | None = None

Penalty per second for arriving at the stop after the target arrival time.

max_wait class-attribute instance-attribute 

max_wait: int | None = None

Maximum waiting duration in seconds at the stop.

quantity class-attribute instance-attribute 

quantity: Any | None = None

Quantity of the stop.

start_time_window class-attribute instance-attribute 

start_time_window: Any | None = None

Time window in which the stop can start service.

target_arrival_time class-attribute instance-attribute 

target_arrival_time: datetime | None = None

Target arrival time at the stop.

unplanned_penalty class-attribute instance-attribute 

unplanned_penalty: int | None = None

Penalty for not planning a stop.

Stop

Bases: StopDefaults

Stop is a location that must be visited by a vehicle in a Vehicle Routing Problem (VRP.)

id instance-attribute 

id: str

Unique identifier for the stop.

location instance-attribute 

location: Location

Location of the stop.

custom_data class-attribute instance-attribute 

custom_data: Any | None = None

Arbitrary data associated with the stop.

mixing_items class-attribute instance-attribute 

mixing_items: Any | None = None

Defines the items that are inserted or removed from the vehicle when visiting the stop.

precedes class-attribute instance-attribute 

precedes: Any | None = None

Stops that must be visited after this one on the same route.

succeeds class-attribute instance-attribute 

succeeds: Any | None = None

Stops that must be visited before this one on the same route.

compatibility_attributes class-attribute instance-attribute 

compatibility_attributes: list[str] | None = None

Attributes that the stop is compatible with.

duration class-attribute instance-attribute 

duration: int | None = None

Duration of the stop in seconds.

early_arrival_time_penalty class-attribute instance-attribute 

early_arrival_time_penalty: float | None = None

Penalty per second for arriving at the stop before the target arrival time.

late_arrival_time_penalty class-attribute instance-attribute 

late_arrival_time_penalty: float | None = None

Penalty per second for arriving at the stop after the target arrival time.

max_wait class-attribute instance-attribute 

max_wait: int | None = None

Maximum waiting duration in seconds at the stop.

quantity class-attribute instance-attribute 

quantity: Any | None = None

Quantity of the stop.

start_time_window class-attribute instance-attribute 

start_time_window: Any | None = None

Time window in which the stop can start service.

target_arrival_time class-attribute instance-attribute 

target_arrival_time: datetime | None = None

Target arrival time at the stop.

unplanned_penalty class-attribute instance-attribute 

unplanned_penalty: int | None = None

Penalty for not planning a stop.

AlternateStop

Bases: StopDefaults

An alternate stop can be serviced instead of another stop.

id instance-attribute 

id: str

Unique identifier for the stop.

location instance-attribute 

location: Location

Location of the stop.

custom_data class-attribute instance-attribute 

custom_data: Any | None = None

Arbitrary data associated with the stop.

compatibility_attributes class-attribute instance-attribute 

compatibility_attributes: list[str] | None = None

Attributes that the stop is compatible with.

duration class-attribute instance-attribute 

duration: int | None = None

Duration of the stop in seconds.

early_arrival_time_penalty class-attribute instance-attribute 

early_arrival_time_penalty: float | None = None

Penalty per second for arriving at the stop before the target arrival time.

late_arrival_time_penalty class-attribute instance-attribute 

late_arrival_time_penalty: float | None = None

Penalty per second for arriving at the stop after the target arrival time.

max_wait class-attribute instance-attribute 

max_wait: int | None = None

Maximum waiting duration in seconds at the stop.

quantity class-attribute instance-attribute 

quantity: Any | None = None

Quantity of the stop.

start_time_window class-attribute instance-attribute 

start_time_window: Any | None = None

Time window in which the stop can start service.

target_arrival_time class-attribute instance-attribute 

target_arrival_time: datetime | None = None

Target arrival time at the stop.

unplanned_penalty class-attribute instance-attribute 

unplanned_penalty: int | None = None

Penalty for not planning a stop.