rename startRecording to createElectricalSeries

NeurodataWithoutBorders · Jul 26, 2024 · c71ec22 · c71ec22
1 parent 4f928aa
commit c71ec22
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 9 deletions.
diff --git a/src/nwb/NWBFile.cpp b/src/nwb/NWBFile.cpp
@@ -77,7 +77,7 @@ Status NWBFile::createFileStructure()
   return Status::Success;
 }
 
-Status NWBFile::startElectricalSeriesRecording(
+Status NWBFile::createElectricalSeries(
     std::vector<Types::ChannelVector> recordingArrays,
     const BaseDataType& dataType)
 {

diff --git a/src/nwb/NWBFile.hpp b/src/nwb/NWBFile.hpp
@@ -54,11 +54,12 @@ class NWBFile
   void finalize();
 
   /**
-   * @brief Starts a recording.
+   * @brief Create ElectricalSeries objects to record data into.
+   * Created objects are stored in recordingContainers.
    * @param dataType The data type of the elements in the data block.
-   * @return Status The status of the recording operation.
+   * @return Status The status of the object creation operation.
    */
-  Status startElectricalSeriesRecording(
+  Status createElectricalSeries(
       std::vector<Types::ChannelVector> recordingArrays,
       const BaseDataType& dataType = BaseDataType::I16);
 

diff --git a/src/nwb/NWBRecording.cpp b/src/nwb/NWBRecording.cpp
@@ -31,7 +31,7 @@ Status NWBRecording::openFile(const std::string& rootFolder,
   nwbfile->initialize();
 
   // start the new recording
-  return nwbfile->startElectricalSeriesRecording(recordingArrays);
+  return nwbfile->createElectricalSeries(recordingArrays);
 }
 
 void NWBRecording::closeFile()

diff --git a/tests/testNWBFile.cpp b/tests/testNWBFile.cpp
@@ -20,9 +20,9 @@ TEST_CASE("saveNWBFile", "[nwb]")
   nwbfile.finalize();
 }
 
-TEST_CASE("startElectricalSeriesRecording", "[nwb]")
+TEST_CASE("createElectricalSeries", "[nwb]")
 {
-  std::string filename = getTestFilePath("startElectricalSeriesRecording.nwb");
+  std::string filename = getTestFilePath("createElectricalSeries.nwb");
 
   // initialize nwbfile object and create base structure
   NWB::NWBFile nwbfile(generateUuid(),
@@ -31,8 +31,7 @@ TEST_CASE("startElectricalSeriesRecording", "[nwb]")
 
   // start recording
   std::vector<Types::ChannelVector> mockArrays = getMockChannelArrays(1, 2);
-  Status result =
-      nwbfile.startElectricalSeriesRecording(mockArrays, BaseDataType::F32);
+  Status result = nwbfile.createElectricalSeries(mockArrays, BaseDataType::F32);
 
   // write timeseries data
   std::vector<float> mockData = {1.0f, 2.0f, 3.0f, 4.0f, 5.0f};