Skip to content
Snippets Groups Projects
Commit 8b60bd14 authored by Romain BERNARD's avatar Romain BERNARD
Browse files

add practical usage comment to the add/remove weight functions

parent 97c00655
No related branches found
No related tags found
1 merge request!2Route manipulation API with automatic constraint propagation
Pipeline #7402 passed with warnings
......@@ -48,11 +48,13 @@ public:
/**
* Updates weight in-between request's Origin/Destination (both included) to account for the given request's weight
* ⚠️ Execute this function *after* adding the request to the route, as it assumes the request is part of the route
* @param requestId ID of the request that serves as basis for iteration and weight to add
*/
void addRequestWeightToRoute(size_t requestId);
/**
* Resets current weight to 0 on the request Origin/Destination key points and decreases weight on the nodes in-between by the request's weight
* ⚠️ Execute this function *before* removing the request from the route, as it assumes the request is still part of the route
* @param requestId ID of the request that serves as basis for iteration and weight to remove
*/
void removeRequestWeightFromRoute(size_t requestId);
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment