Add Identifiable::removeProperty() (#416)

Signed-off-by: Sébastien LAIGRE <[email protected]>
powsybl · May 24, 2022 · 7c21172 · 7c21172
1 parent 61bb7f4
commit 7c21172
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 10 deletions.
diff --git a/include/powsybl/iidm/Identifiable.hpp b/include/powsybl/iidm/Identifiable.hpp
@@ -85,6 +85,8 @@ class Identifiable : public virtual Validable, public Extendable, public MultiVa
 
     void removeAlias(const std::string& alias);
 
+    bool removeProperty(const std::string& key);
+
     virtual void setFictitious(bool fictitious);
 
     stdcxx::optional<std::string> setProperty(const std::string& key, const std::string& value);

diff --git a/include/powsybl/stdcxx/Properties.hpp b/include/powsybl/stdcxx/Properties.hpp
@@ -60,7 +60,7 @@ class Properties {
 
     bool isEmpty() const;
 
-    Properties& remove(const std::string& key);
+    stdcxx::optional<std::string> remove(const std::string& key);
 
     stdcxx::optional<std::string> set(const std::string& key, const std::string& value);
 

diff --git a/src/iidm/Identifiable.cpp b/src/iidm/Identifiable.cpp
@@ -182,6 +182,10 @@ void Identifiable::removeAlias(const std::string& alias) {
     }
 }
 
+bool Identifiable::removeProperty(const std::string& key) {
+    return static_cast<bool>(m_properties.remove(key));
+}
+
 void Identifiable::setFictitious(bool fictitious) {
     m_fictitious = fictitious;
 }

diff --git a/src/stdcxx/Properties.cpp b/src/stdcxx/Properties.cpp
@@ -69,9 +69,14 @@ bool Properties::isEmpty() const {
     return m_properties.empty();
 }
 
-Properties& Properties::remove(const std::string& key) {
-    m_properties.erase(key);
-    return *this;
+stdcxx::optional<std::string> Properties::remove(const std::string& key) {
+    auto it = m_properties.find(key);
+    if (it != m_properties.end()) {
+        std::string oldValue = it->second;
+        m_properties.erase(it);
+        return oldValue;
+    }
+    return {};
 }
 
 stdcxx::optional<std::string> Properties::set(const std::string& key, const std::string& value) {

diff --git a/test/iidm/NetworkTest.cpp b/test/iidm/NetworkTest.cpp
@@ -537,9 +537,16 @@ BOOST_AUTO_TEST_CASE(Properties) {
 
     BOOST_CHECK_EQUAL("value1", n.getProperty("key1"));
 
-    POWSYBL_ASSERT_THROW(n.getProperty("key3"),
-                         stdcxx::PropertyNotFoundException, "Property key3 does not exist");
+    POWSYBL_ASSERT_THROW(n.getProperty("key3"), stdcxx::PropertyNotFoundException, "Property key3 does not exist");
     BOOST_CHECK_EQUAL("value3", n.getProperty("key3", "value3"));
+
+    BOOST_CHECK_EQUAL(2, boost::size(n.getPropertyNames()));
+    BOOST_CHECK(n.removeProperty("key2"));
+    BOOST_CHECK_EQUAL(1, boost::size(n.getPropertyNames()));
+
+    BOOST_CHECK(!n.hasProperty("key2"));
+
+    BOOST_CHECK(!n.removeProperty("badKey"));
 }
 
 BOOST_AUTO_TEST_CASE(MultiVariant) {

diff --git a/test/stdcxx/PropertiesTest.cpp b/test/stdcxx/PropertiesTest.cpp
@@ -57,14 +57,14 @@ BOOST_AUTO_TEST_CASE(RemoveProperty) {
     props.set("key4", "value4");
     BOOST_CHECK_EQUAL(4UL, props.size());
 
-    props.remove("key3");
+    BOOST_CHECK_EQUAL("value3", *props.remove("key3"));
     BOOST_CHECK_EQUAL(3UL, props.size());
 
-    props.remove("key4");
+    BOOST_CHECK_EQUAL("value4", *props.remove("key4"));
     BOOST_CHECK_EQUAL(2UL, props.size());
 
-    // removing a key that does not exists does nothing
-    props.remove("key5");
+    // removing a key that does not exists does nothing but returning an invalid stdcxx::optional
+    BOOST_CHECK(!props.remove("key5"));
     BOOST_CHECK_EQUAL(2UL, props.size());
 
     char suffix = '1';