adding getter and setter for AeroMode::name (#198)

Author: slayoo

src/aero_mode.F90

@@ -218,4 +218,30 @@ subroutine f_aero_mode_get_type(ptr_c, type) bind(C)
 
   end subroutine
 
+  subroutine f_aero_mode_set_name(ptr_c, name_data, name_size) bind(C)
+    type(c_ptr), intent(inout) :: ptr_c
+    type(aero_mode_t), pointer :: aero_mode => null()
+    character(kind=c_char), dimension(*), intent(in) :: name_data
+    integer(c_int), intent(in) :: name_size
+    integer :: i
+
+    call c_f_pointer(ptr_c, aero_mode)    
+    do i=1, name_size
+      aero_mode%name(i:i) = name_data(i)
+    end do
+    do i=name_size+1, len(aero_mode%name)
+      aero_mode%name(i:i) = " " 
+    end do
+  end subroutine
+
+  subroutine f_aero_mode_get_name(ptr_c, name_data, name_size) bind(C)
+    type(c_ptr), intent(inout) :: ptr_c
+    type(aero_mode_t), pointer :: aero_mode => null()
+    type(c_ptr), intent(out) :: name_data
+    integer(c_int), intent(out) :: name_size
+
+    call c_f_pointer(ptr_c, aero_mode)
+    name_data = c_loc(aero_mode%name)
+    name_size = len_trim(aero_mode%name)
+  end subroutine
 end module

src/aero_mode.hpp

@@ -96,6 +96,16 @@ extern "C" void f_aero_mode_get_type(
     int *val
 ) noexcept;
 
+extern "C" void f_aero_mode_set_name(
+    void *ptr,
+    const char *name_data, const int *name_size
+) noexcept;
+
+extern "C" void f_aero_mode_get_name(
+    const void *ptr,
+    char **name_data, int *name_size
+) noexcept;
+
 extern "C" void f_aero_mode_set_sampled(
     void *ptr,
     const void *rad_data,
@@ -272,4 +282,20 @@ struct AeroMode {
 
         return AeroMode::types()[type - 1];
     }
+
+    static void set_name(AeroMode &self, const std::string &name) {
+        int size = name.size();
+        f_aero_mode_set_name(self.ptr.f_arg_non_const(), name.c_str(), &size);
+    }
+
+    static auto get_name(const AeroMode &self) {
+        std::string name;
+        char* f_ptr = NULL;
+        int size = 0;
+        f_aero_mode_get_name(self.ptr.f_arg(), &f_ptr, &size);
+        name.resize(size);
+        for (int i = 0; i < size; ++i)
+          name[i] = f_ptr[i];
+        return name;
+    }
 };

src/pypartmc.cpp

@@ -323,6 +323,7 @@ PYBIND11_MODULE(_PyPartMC, m) {
              &AeroMode::set_gsd)
         .def("set_sample", &AeroMode::set_sampled)
         .def_property("type", &AeroMode::get_type, &AeroMode::set_type)
+        .def_property("name", &AeroMode::get_name, &AeroMode::set_name)
     ;
 
     py::class_<AeroDist>(m,"AeroDist")

tests/test_aero_dist.py

@@ -66,6 +66,7 @@ def test_ctor_multimode(n_modes):
         for i in range(sut.n_mode):
             assert sut.mode(i).type == modes[i]["mode_type"]
             assert sut.mode(i).num_conc == modes[i]["num_conc"]
+            assert sut.mode(i).name == f"mode_{i}"
 
     @staticmethod
     @pytest.mark.parametrize("idx", (-1, 500))

tests/test_aero_mode.py

@@ -189,3 +189,29 @@ def test_from_json_mono(modes, diam_type):
         mode = modes[tuple(modes.keys())[0]]
         assert sut.num_conc == mode["num_conc"]
         assert sut.type == mode["mode_type"]
+
+    @staticmethod
+    def test_get_name():
+        # arrange
+        aero_data = ppmc.AeroData(AERO_DATA_CTOR_ARG_MINIMAL)
+        sut = ppmc.AeroMode(aero_data, AERO_MODE_CTOR_LOG_NORMAL)
+
+        # act
+        name = sut.name
+
+        # assert
+        assert tuple(AERO_MODE_CTOR_LOG_NORMAL.keys())[0] == name
+
+    @staticmethod
+    def test_set_name():
+        # arrange
+        aero_data = ppmc.AeroData(AERO_DATA_CTOR_ARG_MINIMAL)
+        sut = ppmc.AeroMode(aero_data, AERO_MODE_CTOR_LOG_NORMAL)
+        val = "abc"
+        assert sut.name != val
+
+        # act
+        sut.name = val
+
+        # assert
+        assert sut.name == val