From bbc5adcd075c57ee0217ffee7e7840e66e0c8447 Mon Sep 17 00:00:00 2001
From: Meixner <andre.meixner@kit.edu>
Date: Mon, 12 Aug 2024 14:06:55 +0200
Subject: [PATCH] Standardized class name and visualized name of example skills

---
 .../components/skills/SkillProviderExample/BusyWaiting.cpp | 6 +++---
 .../components/skills/SkillProviderExample/BusyWaiting.h   | 4 ++--
 .../components/skills/SkillProviderExample/Chaining.cpp    | 2 +-
 .../components/skills/SkillProviderExample/Incomplete.cpp  | 2 +-
 .../components/skills/SkillProviderExample/InstantKill.cpp | 4 ++--
 .../skills/SkillProviderExample/RandomChaining.cpp         | 7 +++++--
 .../components/skills/SkillProviderExample/Recursive.cpp   | 7 ++++---
 .../components/skills/SkillProviderExample/Recursive.h     | 4 ++--
 .../skills/SkillProviderExample/SkillProviderExample.cpp   | 4 ++--
 9 files changed, 22 insertions(+), 18 deletions(-)

diff --git a/source/RobotAPI/components/skills/SkillProviderExample/BusyWaiting.cpp b/source/RobotAPI/components/skills/SkillProviderExample/BusyWaiting.cpp
index cf93b5f6e..209c73778 100644
--- a/source/RobotAPI/components/skills/SkillProviderExample/BusyWaiting.cpp
+++ b/source/RobotAPI/components/skills/SkillProviderExample/BusyWaiting.cpp
@@ -6,12 +6,12 @@
 namespace armarx::skills::provider
 {
 
-    BusyWaiting::BusyWaiting() : SimpleSkill(GetSkillDescription())
+    BusyWaitingSkill::BusyWaitingSkill() : SimpleSkill(GetSkillDescription())
     {
     }
 
     SkillDescription
-    BusyWaiting::GetSkillDescription()
+    BusyWaitingSkill::GetSkillDescription()
     {
         return SkillDescription{.skillId = SkillID{.skillName = "BusyWaiting"},
                                 .description = "This skill takes two seconds",
@@ -19,7 +19,7 @@ namespace armarx::skills::provider
     }
 
     Skill::MainResult
-    BusyWaiting::main(const MainInput& in)
+    BusyWaitingSkill::main(const MainInput& in)
     {
         for (unsigned int i = 0; i < 10; i++)
         {
diff --git a/source/RobotAPI/components/skills/SkillProviderExample/BusyWaiting.h b/source/RobotAPI/components/skills/SkillProviderExample/BusyWaiting.h
index 5a8094e5b..87d00c69f 100644
--- a/source/RobotAPI/components/skills/SkillProviderExample/BusyWaiting.h
+++ b/source/RobotAPI/components/skills/SkillProviderExample/BusyWaiting.h
@@ -29,10 +29,10 @@
 namespace armarx::skills::provider
 {
 
-    class BusyWaiting : public SimpleSkill
+    class BusyWaitingSkill : public SimpleSkill
     {
     public:
-        BusyWaiting();
+        BusyWaitingSkill();
 
         static SkillDescription GetSkillDescription();
 
diff --git a/source/RobotAPI/components/skills/SkillProviderExample/Chaining.cpp b/source/RobotAPI/components/skills/SkillProviderExample/Chaining.cpp
index 983902512..843f1a84d 100644
--- a/source/RobotAPI/components/skills/SkillProviderExample/Chaining.cpp
+++ b/source/RobotAPI/components/skills/SkillProviderExample/Chaining.cpp
@@ -12,7 +12,7 @@ namespace armarx::skills::provider
     SkillDescription
     ChainingSkill::GetSkillDescription()
     {
-        return SkillDescription{.skillId = armarx::skills::SkillID{.skillName = "ChainingSkill"},
+        return SkillDescription{.skillId = armarx::skills::SkillID{.skillName = "Chaining"},
                                 .description =
                                     "This skill calls the Timeout skill three times. The last "
                                     "execution is aborted due to a timeout of this skill.",
diff --git a/source/RobotAPI/components/skills/SkillProviderExample/Incomplete.cpp b/source/RobotAPI/components/skills/SkillProviderExample/Incomplete.cpp
index 8d6b4f277..b5afe130d 100644
--- a/source/RobotAPI/components/skills/SkillProviderExample/Incomplete.cpp
+++ b/source/RobotAPI/components/skills/SkillProviderExample/Incomplete.cpp
@@ -17,7 +17,7 @@ namespace armarx::skills::provider
     IncompleteSkill::GetSkillDescription()
     {
         auto d = HelloWorldSkill::GetSkillDescription();
-        return SkillDescription{.skillId = {.skillName = "IncompleteSkill"},
+        return SkillDescription{.skillId = {.skillName = "Incomplete"},
                                 .description = d.description,
                                 .timeout = d.timeout + armarx::core::time::Duration::Seconds(2),
                                 .parametersType = d.parametersType};
diff --git a/source/RobotAPI/components/skills/SkillProviderExample/InstantKill.cpp b/source/RobotAPI/components/skills/SkillProviderExample/InstantKill.cpp
index 840d95309..fa81224c1 100644
--- a/source/RobotAPI/components/skills/SkillProviderExample/InstantKill.cpp
+++ b/source/RobotAPI/components/skills/SkillProviderExample/InstantKill.cpp
@@ -15,7 +15,7 @@ namespace armarx::skills::provider
     SkillDescription
     InstantKillSkill::GetSkillDescription()
     {
-        return SkillDescription{.skillId = armarx::skills::SkillID{.skillName = "InstantKillSkill"},
+        return SkillDescription{.skillId = armarx::skills::SkillID{.skillName = "InstantKill"},
                                 .description =
                                     "This skill calls Timeout and instantly aboirts it.",
                                 .timeout = armarx::core::time::Duration::MilliSeconds(50000)};
@@ -29,7 +29,7 @@ namespace armarx::skills::provider
 
       SkillProxy prx(
           manager,
-          skills::SkillID{.providerId = *getSkillId().providerId, .skillName = "ChainingSkill"});
+          skills::SkillID{.providerId = *getSkillId().providerId, .skillName = "Chaining"});
 
       for (unsigned int i = 0; i < 10; ++i)
       {
diff --git a/source/RobotAPI/components/skills/SkillProviderExample/RandomChaining.cpp b/source/RobotAPI/components/skills/SkillProviderExample/RandomChaining.cpp
index 28d1f23ed..f1649880c 100644
--- a/source/RobotAPI/components/skills/SkillProviderExample/RandomChaining.cpp
+++ b/source/RobotAPI/components/skills/SkillProviderExample/RandomChaining.cpp
@@ -24,7 +24,7 @@ namespace armarx::skills::provider
     SkillDescription
     RandomChainingSkill::GetSkillDescription()
     {
-        return SkillDescription{.skillId = armarx::skills::SkillID{.skillName = "RandomChainingSkill"},
+        return SkillDescription{.skillId = armarx::skills::SkillID{.skillName = "RandomChaining"},
                                 .description =
                                     "This skill calls 100 random subskills from the skillProviderExample excluding the segfault skill.",
                                 .timeout = armarx::core::time::Duration::MilliSeconds(50000)};
@@ -33,7 +33,10 @@ namespace armarx::skills::provider
     Skill::MainResult
     RandomChainingSkill::main(const MainInput& in)
     {
-      std::vector<std::string> subskillNames = {"Timeout", "ChainingSkill", "Foo", "HelloWorld", "IncompleteSkill", "ShowMeCallbacks", "BusyWaiting", "Recursive"};
+      std::vector<std::string> subskillNames = {
+        "Timeout", "Chaining", "Foo", "HelloWorld",
+        "Incomplete", "ShowMeCallbacks", "BusyWaiting", "Recursive"
+      };
 
       ARMARX_CHECK(subskillNames.size() > 0);
 
diff --git a/source/RobotAPI/components/skills/SkillProviderExample/Recursive.cpp b/source/RobotAPI/components/skills/SkillProviderExample/Recursive.cpp
index f2266cc40..7ad3c457a 100644
--- a/source/RobotAPI/components/skills/SkillProviderExample/Recursive.cpp
+++ b/source/RobotAPI/components/skills/SkillProviderExample/Recursive.cpp
@@ -1,15 +1,16 @@
 #include "Recursive.h"
+
 #include "RobotAPI/libraries/skills/core/SkillDescription.h"
 
 namespace armarx::skills::provider
 {
 
-    Recursive::Recursive() : SimpleSpecializedSkill<skills::Example::RecursiveSkillParams>(GetSkillDescription())
+    RecursiveSkill::RecursiveSkill() : SimpleSpecializedSkill<skills::Example::RecursiveSkillParams>(GetSkillDescription())
     {
     }
 
     SkillDescription
-    Recursive::GetSkillDescription()
+    RecursiveSkill::GetSkillDescription()
     {
         armarx::skills::Example::RecursiveSkillParams root_profile_params;
         root_profile_params.n = 10;
@@ -24,7 +25,7 @@ namespace armarx::skills::provider
     }
 
     Skill::MainResult
-    Recursive::main(const SpecializedMainInput& in)
+    RecursiveSkill::main(const SpecializedMainInput& in)
     {
         const int n = in.parameters.n;
 
diff --git a/source/RobotAPI/components/skills/SkillProviderExample/Recursive.h b/source/RobotAPI/components/skills/SkillProviderExample/Recursive.h
index a6c03497a..ac96cce58 100644
--- a/source/RobotAPI/components/skills/SkillProviderExample/Recursive.h
+++ b/source/RobotAPI/components/skills/SkillProviderExample/Recursive.h
@@ -29,10 +29,10 @@
 
 namespace armarx::skills::provider
 {
-    class Recursive : public SimpleSpecializedSkill<skills::Example::RecursiveSkillParams>
+    class RecursiveSkill : public SimpleSpecializedSkill<skills::Example::RecursiveSkillParams>
     {
     public:
-        Recursive();
+        RecursiveSkill();
 
         static SkillDescription GetSkillDescription();
 
diff --git a/source/RobotAPI/components/skills/SkillProviderExample/SkillProviderExample.cpp b/source/RobotAPI/components/skills/SkillProviderExample/SkillProviderExample.cpp
index 3d324e7dd..fe98dc157 100644
--- a/source/RobotAPI/components/skills/SkillProviderExample/SkillProviderExample.cpp
+++ b/source/RobotAPI/components/skills/SkillProviderExample/SkillProviderExample.cpp
@@ -71,10 +71,10 @@ namespace armarx::skills::provider
         addSkillFactory<InstantKillSkill>();
 
         ARMARX_INFO << "Adding skill BusyWaiting";
-        addSkillFactory<BusyWaiting>();
+        addSkillFactory<BusyWaitingSkill>();
 
         ARMARX_INFO << "Adding skill Recursive";
-        addSkillFactory<Recursive>();
+        addSkillFactory<RecursiveSkill>();
     }
 
     void
-- 
GitLab