apply suggestions from code review

NeurodataWithoutBorders · Aug 29, 2024 · 5b6b5c0 · 5b6b5c0
1 parent 84f5597
commit 5b6b5c0
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 12 deletions.
diff --git a/docs/pages/devdocs/nwb_schema.dox b/docs/pages/devdocs/nwb_schema.dox
@@ -16,7 +16,10 @@
  * \section dev_docs_updating_nwb_schema_section Updating the schema
  *
  * Currently, the version of the schema being used for development is fixed and stored in the `/resources/schema` folder. 
- * At a later date, these folders will be updated to git submodules, and we will add further instructions on coordinating schema updates with AqNWB API updates.
+ * Updating to a newer version of the schema requires:
+ * - Regeneration of the `spec` header files via `resources/generate_spec_files.py`
+ * - Update of existing `Container` classes and unit tests in AqNWB to match changes in the  new schema compared to the previous schema
+ * - Successful completion of all unit-test and round-trip testing with PyNWB and MatNWB
  *
  */
 
diff --git a/resources/generate_spec_files.py b/resources/generate_spec_files.py
@@ -23,7 +23,7 @@
         with open(header_file, 'w') as fo:
             fo.write('#pragma once\n\n')
             fo.write('#include <string>\n#include <string_view>\n#include <array>\n\n')
-            fo.write(f'namespace AQNWB::spec::{ns['name'].replace('-', '_')}\n{{\n\n')
+            fo.write(f'namespace AQNWB::SPEC::{ns['name'].upper().replace('-', '_')}\n{{\n\n')
             fo.write(f'const std::string version = "{ns["version"]}";\n\n')
 
         # load and convert schema files

diff --git a/src/nwb/NWBFile.cpp b/src/nwb/NWBFile.cpp
@@ -56,7 +56,7 @@ Status NWBFile::createFileStructure()
   }
 
   io->createCommonNWBAttributes("/", "core", "NWBFile", "");
-  io->createAttribute(AQNWB::spec::core::version, "/", "nwb_version");
+  io->createAttribute(AQNWB::SPEC::CORE::version, "/", "nwb_version");
 
   io->createGroup("/acquisition");
   io->createGroup("/analysis");
@@ -71,13 +71,13 @@ Status NWBFile::createFileStructure()
   io->createGroup("/specifications");
   io->createReferenceAttribute("/specifications", "/", ".specloc");
 
-  cacheSpecifications("core", spec::core::version, spec::core::specVariables);
+  cacheSpecifications("core", AQNWB::SPEC::CORE::version, AQNWB::SPEC::CORE::specVariables);
   cacheSpecifications("hdmf-common",
-                      spec::hdmf_common::version,
-                      spec::hdmf_common::specVariables);
+                      AQNWB::SPEC::HDMF_COMMON::version,
+                      AQNWB::SPEC::HDMF_COMMON::specVariables);
   cacheSpecifications("hdmf-experimental",
-                      spec::hdmf_experimental::version,
-                      spec::hdmf_experimental::specVariables);
+                      AQNWB::SPEC::HDMF_EXPERIMENTAL::version,
+                      AQNWB::SPEC::HDMF_EXPERIMENTAL::specVariables);
 
   std::string time = getCurrentTime();
   std::vector<std::string> timeVec = {time};

diff --git a/src/nwb/NWBFile.hpp b/src/nwb/NWBFile.hpp
@@ -1,8 +1,10 @@
 #pragma once
 
+#include <array>
 #include <cstdint>
-#include <map>
 #include <memory>
+#include <string>
+#include <string_view>
 #include <vector>
 
 #include "BaseIO.hpp"

diff --git a/src/spec/core.hpp b/src/spec/core.hpp
@@ -4,7 +4,7 @@
 #include <string>
 #include <string_view>
 
-namespace AQNWB::spec::core
+namespace AQNWB::SPEC::CORE
 {
 
 const std::string version = "2.7.0";

diff --git a/src/spec/hdmf_common.hpp b/src/spec/hdmf_common.hpp
@@ -4,7 +4,7 @@
 #include <string>
 #include <string_view>
 
-namespace AQNWB::spec::hdmf_common
+namespace AQNWB::SPEC::HDMF_COMMON
 {
 
 const std::string version = "1.8.0";

diff --git a/src/spec/hdmf_experimental.hpp b/src/spec/hdmf_experimental.hpp
@@ -4,7 +4,7 @@
 #include <string>
 #include <string_view>
 
-namespace AQNWB::spec::hdmf_experimental
+namespace AQNWB::SPEC::HDMF_EXPERIMENTAL
 {
 
 const std::string version = "0.5.0";