Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update vroom function signatures optionals as last named parameters #65

Open
krashish8 opened this issue Sep 15, 2024 · 0 comments
Open
Labels
enhancement New feature or request
Milestone

Comments

@krashish8
Copy link
Member

Ref: Topic on Discourse https://discourse.osgeo.org/t/confused-with-vroom-functions-on-vrprouting/50928/1

Some of the parameters of vroomX functions are optional, hence the signatures need to change to have the optionals as last named parameters, just like we do it on pgRouting.

This signature change can be done as part of 0.5.0

For all the vroom functions:

  • Breaks SQL is optional.
  • All the time windows are optional, if present (Jobs Time Windows SQL, Shipments Time Windows SQL, Breaks Time Windows SQL).

For vrp_vroom and vrp_vroomPlain:

  • Either of Jobs SQL or Shipments SQL can be NULL, but both Jobs SQL and Shipments SQL cannot be NULL.
  • @cvvergara We can maybe make both Jobs SQL and Shipments SQL required for this function - what do you say? We have other functions where Jobs SQL is not present (vrp_vroomShipments, vrp_vroomShipmentsPlain) or Shipments SQL is not present (vrp_vroomJobs, vrp_vroomJobsPlain).

Vehicles SQL and Matrix SQL are always required.

@krashish8 krashish8 added the enhancement New feature or request label Sep 15, 2024
@krashish8 krashish8 added this to the Release 0.5.0 milestone Sep 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant