Skip to content

Commit

Permalink
Add variant implementation instructions
Browse files Browse the repository at this point in the history
Signed-off-by: Nahuel Espinosa <nespinosa@ekumenlabs.com>
  • Loading branch information
nahueespinosa committed Jan 19, 2024
1 parent ae8a1bf commit 21219f9
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions beluga_system_tests/test/test_system_new.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,14 @@ struct StandardAMCLParams {
};

// All possible particle filter configuration variants to test against.
/**
* New particle filter implementation variants can be added by following these steps:
*
* - Create a new struct with the necessary configuration parameters (could be empty).
* - Add the new struct type to this variant declaration.
* - Add one or more instances of that struct to the `get_particle_filter_params` function.
* - Implement a new `particle_filter_test` overload taking that struct as a first parameter.
*/
using ParticleFilterParams = std::variant<StandardAMCLParams>;

auto get_particle_filter_params() {
Expand Down

0 comments on commit 21219f9

Please sign in to comment.