more consistent error handling

Author: frs69wq

ChangeLog

@@ -23,6 +23,8 @@ DTLMod (0.2) November 11, 2025
     - Make metadata export configurable at stream level.
     - Have a simpler version of Engine::put() that automatically uses the
       local size of the Variable.
+    - Stream::remove_variable now throws an UnknownVariableException rather
+      than returning a bool
 
 ----------------------------------------------------------------------------
 

include/dtlmod/Stream.hpp

@@ -166,8 +166,7 @@ class Stream : public std::enable_shared_from_this<Stream> {
 
   /// @brief Remove a Variable of the list of variables known by the Stream.
   /// @param name The name of the variable to remove.
-  /// @return A boolean indicating if the Variable has been successfully removed or not.
-  bool remove_variable(const std::string& name);
+  void remove_variable(const std::string& name);
 };
 
 } // namespace dtlmod

src/Stream.cpp

@@ -294,14 +294,13 @@ std::shared_ptr<Variable> Stream::inquire_variable(const std::string& name) cons
   }
 }
 
-bool Stream::remove_variable(const std::string& name)
+void Stream::remove_variable(const std::string& name)
 {
   auto var = variables_.find(name);
-  if (var != variables_.end()) {
+  if (var != variables_.end())
     variables_.erase(var);
-    return true;
-  } else
-    return false;
+  else
+    throw UnknownVariableException(XBT_THROW_POINT, name);
 }
 
 } // namespace dtlmod

test/dtl_variable.cpp

@@ -57,10 +57,10 @@ TEST_F(DTLVariableTest, DefineVariable)
       ASSERT_TRUE(var3D->get_name() == "var3D");
       XBT_INFO("Check size: should be 64^3 times 8 as elements are double");
       ASSERT_DOUBLE_EQ(var3D->get_global_size(), 64 * 64 * 64 * 8);
-      XBT_INFO("Remove variable named 'var3D'. It is known, should be true");
-      ASSERT_DOUBLE_EQ(stream->remove_variable("var3D"), true);
-      XBT_INFO("Remove variable named 'var2D'. It is unknown, should be false");
-      ASSERT_DOUBLE_EQ(stream->remove_variable("var2D"), false);
+      XBT_INFO("Remove variable named 'var3D'. It is known, should be fine");
+      ASSERT_NO_THROW(stream->remove_variable("var3D"));
+      XBT_INFO("Remove variable named 'var2D'. It is unknown, should fail");
+      ASSERT_THROW(stream->remove_variable("var2D"), dtlmod::UnknownVariableException);
       XBT_INFO("Disconnect the actor from the DTL");
       ASSERT_NO_THROW(dtlmod::DTL::disconnect());
     });
@@ -200,10 +200,10 @@ TEST_F(DTLVariableTest, RemoveVariable)
       ASSERT_NO_THROW(stream = dtl->add_stream("Stream"));
       XBT_INFO("Create a scalar int variable");
       ASSERT_NO_THROW(var = stream->define_variable("var", sizeof(int)));
-      XBT_INFO("Remove variable named 'var'. It is known, should be true");
-      ASSERT_TRUE(stream->remove_variable("var"));
-      XBT_INFO("Remove an unknown variable, which should return false");
-      ASSERT_FALSE(stream->remove_variable("unknow_var"));
+      XBT_INFO("Remove variable named 'var'. It is known, should be fine");
+      ASSERT_NO_THROW(stream->remove_variable("var"));
+      XBT_INFO("Remove an unknown variable, which should throw");
+      ASSERT_THROW(stream->remove_variable("unknow_var"), dtlmod::UnknownVariableException);
       XBT_INFO("Disconnect the actor from the DTL");
       ASSERT_NO_THROW(dtlmod::DTL::disconnect());
     });

test/python/dtl_variable.py

@@ -39,10 +39,13 @@ def define_variable():
         assert var3d.name == "var3d"
         this_actor.info("Check size: should be 64^3 times 8 as elements are double")
         assert var3d.global_size == (64 * 64 * 64 * 8)
-        this_actor.info("Remove variable named 'var3d'. It is known, should be true")
-        assert stream.remove_variable("var3d") == True
+        this_actor.info("Remove variable named 'var3d'. It is known, should be fine")
+        stream.remove_variable("var3d")
         this_actor.info("Remove variable named 'var2D'. It is unknown, should be false")
-        assert stream.remove_variable("var2D") == False
+        try:
+            stream.remove_variable("var2D")
+        except UnknownVariableException:
+            pass
 
         this_actor.info("Disconnect from the DTL")
         DTL.disconnect()
@@ -177,10 +180,13 @@ def remove_variable():
         stream = dtl.add_stream("Stream")
         this_actor.info("Create a scalar int variable")
         stream.define_variable("var", ctypes.sizeof(ctypes.c_int))
-        this_actor.info("Remove variable named 'var'. It is known, should be true")
-        assert stream.remove_variable("var") == True
+        this_actor.info("Remove variable named 'var'. It is known, should be fine")
+        stream.remove_variable("var")
         this_actor.info("Remove an unknown variable, which should return false")
-        assert stream.remove_variable("unknow_var") == False
+        try:
+            stream.remove_variable("unknow_var")
+        except UnknownVariableException:
+            pass
         this_actor.info("Disconnect the actor from the DTL")
         DTL.disconnect()