rename home box sorter

Author: Gin

SerialPrograms/Source/PokemonHome/PokemonHome_Panels.cpp

@@ -9,7 +9,7 @@
 #include "PokemonHome_Panels.h"
 
 #include "Programs/PokemonHome_PageSwap.h"
-#include "Programs/PokemonHome_BoxSorting.h"
+#include "Programs/PokemonHome_BoxSorter.h"
 
 #include "Programs/PokemonHome_GenerateNameOCR.h"
 
@@ -30,7 +30,7 @@ std::vector<PanelEntry> PanelListFactory::make_panels() const{
 //    ret.emplace_back(make_settings<GameSettings_Descriptor, GameSettingsPanel>());
     ret.emplace_back("---- General ----");
     ret.emplace_back(make_single_switch_program<PokemonHome::PageSwap_Descriptor, PokemonHome::PageSwap>());
-    ret.emplace_back(make_single_switch_program<PokemonHome::BoxSorting_Descriptor, PokemonHome::BoxSorting>());
+    ret.emplace_back(make_single_switch_program<PokemonHome::BoxSorter_Descriptor, PokemonHome::BoxSorter>());
 
 //    ret.emplace_back("---- Trading ----");
 

…Home/Programs/PokemonHome_BoxSorting.cpp …nHome/Programs/PokemonHome_BoxSorter.cppSerialPrograms/Source/PokemonHome/Programs/PokemonHome_BoxSorting.cpp renamed to SerialPrograms/Source/PokemonHome/Programs/PokemonHome_BoxSorter.cpp SerialPrograms/Source/PokemonHome/Programs/PokemonHome_BoxSorting.cpp renamed to SerialPrograms/Source/PokemonHome/Programs/PokemonHome_BoxSorter.cpp

@@ -1,11 +1,10 @@
-/*  Home Box Sorting
+/*  Home Box Sorter
  *
  *  From: https://github.com/PokemonAutomation/
  *
  */
 
 /* TODO ideas
-break into smaller functions
 read pokemon name and store the slug (easier to detect missread than reading a number)
 Optimise the swapping algo
 Add enum for ball ? Also, BDSP is reading from swsh data. Worth refactoring ?
@@ -49,7 +48,7 @@ language
 #include "Pokemon/Pokemon_CollectedPokemonInfo.h"
 #include "PokemonHome/Inference/PokemonHome_BoxGenderDetector.h"
 #include "PokemonHome/Inference/PokemonHome_BallReader.h"
-#include "PokemonHome_BoxSorting.h"
+#include "PokemonHome_BoxSorter.h"
 
 namespace PokemonAutomation{
 namespace NintendoSwitch{
@@ -60,7 +59,7 @@ using namespace Pokemon;
 const size_t MAX_BOXES = 200;
 
 
-BoxSorting_Descriptor::BoxSorting_Descriptor()
+BoxSorter_Descriptor::BoxSorter_Descriptor()
     : SingleSwitchProgramDescriptor(
         "PokemonHome:BoxSorter",
         STRING_POKEMON + " Home", "Box Sorter",
@@ -72,7 +71,7 @@ BoxSorting_Descriptor::BoxSorting_Descriptor()
         {}
     )
 {}
-struct BoxSorting_Descriptor::Stats : public StatsTracker{
+struct BoxSorter_Descriptor::Stats : public StatsTracker{
     Stats()
         : pkmn(m_stats["Pokemon"])
         , empty(m_stats["Empty Slots"])
@@ -89,11 +88,11 @@ struct BoxSorting_Descriptor::Stats : public StatsTracker{
     std::atomic<uint64_t>& compare;
     std::atomic<uint64_t>& swaps;
 };
-std::unique_ptr<StatsTracker> BoxSorting_Descriptor::make_stats() const{
+std::unique_ptr<StatsTracker> BoxSorter_Descriptor::make_stats() const{
     return std::unique_ptr<StatsTracker>(new Stats());
 }
 
-BoxSorting::BoxSorting()
+BoxSorter::BoxSorter()
     : BOX_NUMBER(
         "<b>Number of Boxes to Sort:</b>",
         LockMode::LOCK_WHILE_RUNNING,
@@ -262,7 +261,7 @@ void sort(
     ProControllerContext& context,
     std::vector<std::optional<CollectedPokemonInfo>> boxes_data,
     std::vector<std::optional<CollectedPokemonInfo>> boxes_sorted,
-    BoxSorting_Descriptor::Stats& stats,
+    BoxSorter_Descriptor::Stats& stats,
     BoxCursor& cur_cursor,
     uint16_t GAME_DELAY
 ){
@@ -316,15 +315,15 @@ void sort(
     }
 }
 
-void BoxSorting::program(SingleSwitchProgramEnvironment& env, ProControllerContext& context){
+void BoxSorter::program(SingleSwitchProgramEnvironment& env, ProControllerContext& context){
     StartProgramChecks::check_performance_class_wired_or_wireless(context);
 
     std::vector<SortingRule> sort_preferences = SORT_TABLE.preferences();
     if (sort_preferences.empty()){
         throw UserSetupError(env.console, "At least one sorting method selection needs to be made!");
     }
 
-    BoxSorting_Descriptor::Stats& stats = env.current_stats< BoxSorting_Descriptor::Stats>();
+    BoxSorter_Descriptor::Stats& stats = env.current_stats< BoxSorter_Descriptor::Stats>();
 
     ImageFloatBox select_check(0.495, 0.0045, 0.01, 0.005); // square color to check which mode is active
     ImageFloatBox national_dex_number_box(0.448, 0.245, 0.049, 0.04); //pokemon national dex number pos
@@ -503,7 +502,7 @@ void BoxSorting::program(SingleSwitchProgramEnvironment& env, ProControllerConte
                     if (dex_number <= 0 || dex_number > static_cast<int>(NATIONAL_DEX_SLUGS().size())) {
                         OperationFailedException::fire(
                             ErrorReport::SEND_ERROR_REPORT,
-                            "BoxSorting Check Summary: Unable to read a correct dex number, found: " + std::to_string(dex_number),
+                            "BoxSorter Check Summary: Unable to read a correct dex number, found: " + std::to_string(dex_number),
                             env.console
                         );
                     }

…onHome/Programs/PokemonHome_BoxSorting.h …monHome/Programs/PokemonHome_BoxSorter.hSerialPrograms/Source/PokemonHome/Programs/PokemonHome_BoxSorting.h renamed to SerialPrograms/Source/PokemonHome/Programs/PokemonHome_BoxSorter.h SerialPrograms/Source/PokemonHome/Programs/PokemonHome_BoxSorting.h renamed to SerialPrograms/Source/PokemonHome/Programs/PokemonHome_BoxSorter.h

@@ -4,8 +4,8 @@
  *
  */
 
-#ifndef BOXSORTING_H
-#define BOXSORTING_H
+#ifndef PokemonAutomation_PokemonHome_BoxSorter_H
+#define PokemonAutomation_PokemonHome_BoxSorter_H
 
 #include "Common/Cpp/Options/BooleanCheckBoxOption.h"
 #include "Common/Cpp/Options/SimpleIntegerOption.h"
@@ -20,17 +20,17 @@ namespace PokemonAutomation{
 namespace NintendoSwitch{
 namespace PokemonHome{
 
-class BoxSorting_Descriptor : public SingleSwitchProgramDescriptor{
+class BoxSorter_Descriptor : public SingleSwitchProgramDescriptor{
 public:
-    BoxSorting_Descriptor();
+    BoxSorter_Descriptor();
 
     struct Stats;
     virtual std::unique_ptr<StatsTracker> make_stats() const override;
 };
 
-class BoxSorting : public SingleSwitchProgramInstance{
+class BoxSorter : public SingleSwitchProgramInstance{
 public:
-    BoxSorting();
+    BoxSorter();
 
     virtual void program(SingleSwitchProgramEnvironment& env, ProControllerContext& context) override;
 

SerialPrograms/SourceFiles.cmake

@@ -1346,8 +1346,8 @@ file(GLOB LIBRARY_SOURCES
     Source/PokemonHome/PokemonHome_Panels.h
     Source/PokemonHome/PokemonHome_Settings.cpp
     Source/PokemonHome/PokemonHome_Settings.h
-    Source/PokemonHome/Programs/PokemonHome_BoxSorting.cpp
-    Source/PokemonHome/Programs/PokemonHome_BoxSorting.h
+    Source/PokemonHome/Programs/PokemonHome_BoxSorter.cpp
+    Source/PokemonHome/Programs/PokemonHome_BoxSorter.h
     Source/PokemonHome/Programs/PokemonHome_GenerateNameOCR.cpp
     Source/PokemonHome/Programs/PokemonHome_GenerateNameOCR.h
     Source/PokemonHome/Programs/PokemonHome_PageSwap.cpp