Add EntityId getters and delete Endpoint kind prefixes (#254)

* Refs #21817: Remove EndpointName_ prefix Signed-off-by: Carlosespicur <[email protected]> * Refs #21817: Add new EntityId getters Signed-off-by: Carlosespicur <[email protected]> * Refs #21817: Uncrustify Signed-off-by: Carlosespicur <[email protected]> * Refs #21817: Fix database queue broken tests Signed-off-by: Carlosespicur <[email protected]> * Refs #21817: Fix documentation tests errors Signed-off-by: Carlosespicur <[email protected]> * Refs #21817: Add suggested changes & uncrustify Signed-off-by: Carlosespicur <[email protected]> --------- Signed-off-by: Carlosespicur <[email protected]>
eProsima · Nov 20, 2024 · 74c6c1f · 74c6c1f
1 parent 28e3062
commit 74c6c1f
Show file tree

Hide file tree

Showing 9 changed files with 136 additions and 43 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -348,7 +348,9 @@ def configure_doxyfile(
 
 suppress_warnings = [
     'cpp.duplicate_declaration',
-    'cpp.parse_function_declaration'
+    'cpp.parse_function_declaration',
+    'config.cache'
+
 ]
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.

diff --git a/include/fastdds_statistics_backend/StatisticsBackend.hpp b/include/fastdds_statistics_backend/StatisticsBackend.hpp
@@ -273,6 +273,28 @@ class StatisticsBackend
     static std::string get_type_idl(
             EntityId entity_id);
 
+    /**
+     * @brief Returns the id of the topic associated to an endpoint.
+     *
+     * @param endpoint_id The ID of a given endpoint.
+     *
+     * @return EntityId of the topic on which the endpoint publishes/receives messages.
+     */
+    FASTDDS_STATISTICS_BACKEND_DllAPI
+    static EntityId get_endpoint_topic_id(
+            EntityId endpoint_id);
+
+    /**
+     * @brief Returns the id of the domain to which a given entity (Domain, DomainParticipant, Topic, endpoints) belongs.
+     *
+     * @param entity_id The ID of a given entity.
+     *
+     * @return EntityId of the domain.
+     */
+    FASTDDS_STATISTICS_BACKEND_DllAPI
+    static EntityId get_domain_id(
+            EntityId entity_id);
+
     /**
      * @brief Provides access to the data measured during the monitoring.
      *

diff --git a/src/cpp/StatisticsBackend.cpp b/src/cpp/StatisticsBackend.cpp
@@ -549,6 +549,18 @@ std::string StatisticsBackend::get_type_idl(
     return StatisticsBackendData::get_instance()->database_->get_type_idl(topic_info[DATA_TYPE_TAG]);
 }
 
+EntityId StatisticsBackend::get_endpoint_topic_id(
+        EntityId endpoint_id)
+{
+    return StatisticsBackendData::get_instance()->database_->get_endpoint_topic_id(endpoint_id);
+}
+
+EntityId StatisticsBackend::get_domain_id(
+        EntityId entity_id)
+{
+    return StatisticsBackendData::get_instance()->database_->get_domain_id(entity_id);
+}
+
 std::vector<StatisticsData> StatisticsBackend::get_data(
         DataKind data_type,
         const std::vector<EntityId>& entity_ids_source,

diff --git a/src/cpp/database/database.cpp b/src/cpp/database/database.cpp
@@ -5343,6 +5343,54 @@ Info Database::get_info(
     return info;
 }
 
+EntityId Database::get_endpoint_topic_id(
+        const EntityId& endpoint_id)
+{
+    std::shared_lock<std::shared_timed_mutex> lock(mutex_);
+    std::shared_ptr<const Entity> endpoint = get_entity_nts(endpoint_id);
+
+    // Check if the entity is a valid endpoint
+    if (endpoint->kind != EntityKind::DATAWRITER && endpoint->kind != EntityKind::DATAREADER)
+    {
+        throw BadParameter("Error: Entity is not a valid endpoint");
+    }
+
+    return std::dynamic_pointer_cast<const DDSEndpoint>(endpoint)->topic->id;
+}
+
+EntityId Database::get_domain_id(
+        const EntityId& entity_id)
+{
+    std::shared_lock<std::shared_timed_mutex> lock(mutex_);
+    std::shared_ptr<const Entity> entity = get_entity_nts(entity_id);
+
+    switch (entity->kind)
+    {
+        case EntityKind::DOMAIN:
+        {
+            return entity_id;
+        }
+        case EntityKind::PARTICIPANT:
+        {
+            return std::dynamic_pointer_cast<const DomainParticipant>(entity)->domain->id;
+        }
+        case EntityKind::TOPIC:
+        {
+            return std::dynamic_pointer_cast<const Topic>(entity)->domain->id;
+        }
+        case EntityKind::DATAWRITER:
+        case EntityKind::DATAREADER:
+        {
+            return std::dynamic_pointer_cast<const DDSEndpoint>(entity)->participant->domain->id;
+        }
+        default:
+        {
+            return EntityId::invalid();
+        }
+    }
+
+}
+
 void Database::check_entity_kinds(
         EntityKind kind,
         const std::vector<EntityId>& entity_ids,

diff --git a/src/cpp/database/database.hpp b/src/cpp/database/database.hpp
@@ -694,6 +694,26 @@ class Database
     Info get_info(
             const EntityId& entity_id);
 
+    /**
+     * @brief Returns the id of the topic associated to an endpoint.
+     *
+     * @param endpoint_id The ID of a given endpoint.
+     *
+     * @return EntityId of the topic on which the endpoint publishes/receives messages.
+     */
+    EntityId get_endpoint_topic_id(
+            const EntityId& endpoint_id);
+
+    /**
+     * @brief Returns the id of the domain associated to a given entity (Domain, Participant, topic and endpoint).
+     *
+     * @param entity_id The ID of an entity.
+     *
+     * @return EntityId of the domain which the entity belongs.
+     */
+    EntityId get_domain_id(
+            const EntityId& entity_id);
+
     /**
      * @brief Check if the entities passed correspond to the specified entity kind.
      *

diff --git a/src/cpp/database/database_queue.cpp b/src/cpp/database/database_queue.cpp
@@ -190,7 +190,7 @@ EntityId DatabaseEntityQueue::process_datareader(
             if (participant_id.first != info.domain_id)
             {
                 throw BadParameter("Participant " + to_string(participant_guid)
-                          +  " found in the database but it is not in the current domain");
+                              +  " found in the database but it is not in the current domain");
             }
         }
         catch (const Exception&)
@@ -265,7 +265,7 @@ EntityId DatabaseEntityQueue::process_datawriter(
             if (participant_id.first != info.domain_id)
             {
                 throw BadParameter("Participant " + to_string(participant_guid)
-                          +  " found in the database but it is not in the current domain");
+                              +  " found in the database but it is not in the current domain");
             }
         }
         catch (const Exception&)
@@ -328,7 +328,7 @@ EntityId DatabaseEntityQueue::process_endpoint_discovery(
         if (participant_id.first != info.domain_id)
         {
             throw BadParameter("Participant " + to_string(participant_guid)
-                        +  " found in the database but it is not in the current domain");
+                          +  " found in the database but it is not in the current domain");
         }
     }
     catch (const Exception&)
@@ -377,15 +377,7 @@ EntityId DatabaseEntityQueue::process_endpoint_discovery(
     // Create the endpoint
     EntityId endpoint_id;
     std::stringstream name;
-
-    if (info.kind() == EntityKind::DATAREADER)
-    {
-        name << "DataReader_" << info.topic_name << "_" << info.guid.entityId;
-    }
-    else
-    {
-        name << "DataWriter_" << info.topic_name << "_" << info.guid.entityId;
-    }
+    name << info.topic_name << "_" << info.guid.entityId;
 
     // Endpoint AppId and metadata
     // TODO: get app data from info (parameters), not from participant

diff --git a/test/dds/communication/Communication.hpp b/test/dds/communication/Communication.hpp
@@ -80,9 +80,9 @@ class Communication
     eProsima_user_DllExport Communication(
             const Communication& x)
     {
-                    m_index = x.m_index;
+        m_index = x.m_index;
 
-                    m_message = x.m_message;
+        m_message = x.m_message;
 
     }
 
@@ -105,9 +105,9 @@ class Communication
             const Communication& x)
     {
 
-                    m_index = x.m_index;
+        m_index = x.m_index;
 
-                    m_message = x.m_message;
+        m_message = x.m_message;
 
         return *this;
     }
@@ -133,7 +133,7 @@ class Communication
             const Communication& x) const
     {
         return (m_index == x.m_index &&
-           m_message == x.m_message);
+               m_message == x.m_message);
     }
 
     /*!
@@ -174,7 +174,6 @@ class Communication
         return m_index;
     }
 
-
     /*!
      * @brief This function copies the value in member message
      * @param _message New value to be copied in member message
@@ -213,8 +212,6 @@ class Communication
         return m_message;
     }
 
-
-
 private:
 
     uint32_t m_index{0};

diff --git a/test/unittest/DatabaseQueue/DatabaseQueueTests.cpp b/test/unittest/DatabaseQueue/DatabaseQueueTests.cpp
@@ -1356,7 +1356,7 @@ TEST_F(database_queue_tests, push_datawriter)
     std::chrono::system_clock::time_point timestamp = std::chrono::system_clock::now();
 
     // Create the writer info
-    std::string datawriter_name = "DataWriter_topic_name_0.0.0.1";  //< Name constructed from the topic and entity_id
+    std::string datawriter_name = "topic_name_0.0.0.1";  //< Name constructed from the topic and entity_id
     Qos datawriter_qos;
     std::string datawriter_guid_str = "01.02.03.04.05.06.07.08.09.0a.0b.0c|0.0.0.1";
     std::string topic_name = "topic_name";
@@ -1594,7 +1594,7 @@ TEST_F(database_queue_tests, push_datawriter_topic_does_not_exist)
     std::chrono::system_clock::time_point timestamp = std::chrono::system_clock::now();
 
     // Create the writer info
-    std::string datawriter_name = "DataWriter_topic_name_0.0.0.1";  //< Name constructed from the topic and entity_id
+    std::string datawriter_name = "topic_name_0.0.0.1";  //< Name constructed from the topic and entity_id
     Qos datawriter_qos;
     std::string datawriter_guid_str = "01.02.03.04.05.06.07.08.09.0a.0b.0c|0.0.0.1";
     std::string topic_name = "topic_name";
@@ -1720,7 +1720,7 @@ TEST_F(database_queue_tests, push_datareader)
     std::chrono::system_clock::time_point timestamp = std::chrono::system_clock::now();
 
     // Create the reader info
-    std::string datareader_name = "DataReader_topic_name_0.0.0.2";  //< Name constructed from the topic and entity_id
+    std::string datareader_name = "topic_name_0.0.0.2";  //< Name constructed from the topic and entity_id
     Qos datareader_qos;
     std::string datareader_guid_str = "01.02.03.04.05.06.07.08.09.0a.0b.0c|0.0.0.2";
     std::string topic_name = "topic_name";
@@ -1958,7 +1958,7 @@ TEST_F(database_queue_tests, push_datareader_topic_does_not_exist)
     std::chrono::system_clock::time_point timestamp = std::chrono::system_clock::now();
 
     // Create the reader info
-    std::string datareader_name = "DataReader_topic_name_0.0.0.2";  //< Name constructed from the topic and entity_id
+    std::string datareader_name = "topic_name_0.0.0.2";  //< Name constructed from the topic and entity_id
     Qos datareader_qos;
     std::string datareader_guid_str = "01.02.03.04.05.06.07.08.09.0a.0b.0c|0.0.0.2";
     std::string topic_name = "topic_name";