Create methods and documentation

source/armarx/navigation/components/dynamic_scene_provider/HumanGrouper.cpp

@@ -6,4 +6,16 @@ namespace armarx::navigation::components::dynamic_scene_provider
     {
 
     }
+
+    void HumanGrouper::updateHumans(std::vector<human::Human> &newHumans)
+    {
+
+    }
+
+    std::vector<human::HumanGroup> HumanGrouper::getCurrentGroups()
+    {
+
+    }
+
+
 }

source/armarx/navigation/components/dynamic_scene_provider/HumanGrouper.h

@@ -26,10 +26,36 @@
 
 namespace armarx::navigation::components::dynamic_scene_provider
 {
+    /**
+     * Can identify social interaction groups in a collection of humans. The currently detected
+     * humans can be set by calling updateHumans.
+     *
+     * @brief Identifies social interaction groups in a collection of detected humans.
+     */
     class HumanGrouper
     {
     public:
+        /**
+         * @brief Creates a new HumanGrouper
+         */
         HumanGrouper();
+
+        /**
+         * Sets the currently detected humans. Only these humans will be assumed to currently exist
+         * when getCurrentGroups() is called the next time.
+         *
+         * @brief Sets the currently detected humans.
+         * @param newHumans a vector containing the most recently detected humans
+         */
+        void updateHumans(std::vector<human::Human>& newHumans);
+
+        /**
+         * Identifies and returns social groups in the humans given to this instance by the last
+         * call to updateHumans.
+         *
+         * @brief Recognizes groups in the current humans.
+         * @return a vector containing the recognized human groups
+         */
+        std::vector<human::HumanGroup> getCurrentGroups();
     };
 } // namespace armarx::navigation::components::dynamic_scene_provider
-