add __str__ method to Gather class

Author: dpgraham4401

src/core/bindings.cpp

@@ -42,5 +42,6 @@ PYBIND11_MODULE(_gather, m) {
       .def_readwrite("id", &Gather::id)
       .def_readwrite("dt", &Gather::dt)
       .def_readwrite("nt", &Gather::nt)
-      .def_readwrite("nx", &Gather::nx);
+      .def_readwrite("nx", &Gather::nx)
+      .def("__str__", &Gather::display);
 }

src/core/gather/gather.hpp

@@ -4,13 +4,18 @@
 
 #ifndef GATHER_H
 #define GATHER_H
+#include <iostream>
+#include <vector>
 
 class Gather {
 public:
   int id;
   int nt;
   int nx;
   double dt;
+  [[nodiscard]] std::string display() const {
+    return "Gather id: " + std::to_string(id);
+  }
 };
 
 #endif // GATHER_H

tests/libseis/test_gather.py

@@ -21,3 +21,9 @@ def test_public_int_attributes(self, gather, attr):
         val = 42
         setattr(gather, attr, val)
         assert getattr(gather, attr) == val
+
+    def test_gather_has_str_method(self, gather, capfd):
+        """Test the Gather class __str__."""
+        print(gather)  # noqa: T201
+        out, _ = capfd.readouterr()
+        assert "Gather" in out