Added support for DECK41_V2 database data format (#34)

Author: MetalKnight

examples/woss-aloha-example.cc

@@ -79,15 +79,16 @@ Experiment::InitWossHelper (Ptr<WossHelper> wossHelper, Ptr<WossPropModel> wossP
   if (m_databasePath != "")
     {
 #if defined (WOSS_NETCDF_SUPPORT)
-      wossHelper->SetAttribute ("SedimDbCoordFilePath", StringValue (m_databasePath + "/seafloor_sediment/DECK41_coordinates.nc"));
-      wossHelper->SetAttribute ("SedimDbMarsdenFilePath", StringValue (m_databasePath + "/seafloor_sediment/DECK41_mardsen_square.nc"));
-      wossHelper->SetAttribute ("SedimDbMarsdenOneFilePath", StringValue (m_databasePath + "/seafloor_sediment/DECK41_mardsen_one_degree.nc"));
+      wossHelper->SetAttribute ("SedimDbCoordFilePath", StringValue (m_databasePath + "/seafloor_sediment/DECK41_V2_coordinates.nc"));
+      wossHelper->SetAttribute ("SedimDbMarsdenFilePath", StringValue (m_databasePath + "/seafloor_sediment/DECK41_V2_marsden_square.nc"));
+      wossHelper->SetAttribute ("SedimDbMarsdenOneFilePath", StringValue (m_databasePath + "/seafloor_sediment/DECK41_V2_marsden_one_degree.nc"));
       wossHelper->SetAttribute ("BathyDbDebug", BooleanValue (false));
 #if defined (WOSS_NETCDF4_SUPPORT)
       wossHelper->SetAttribute ("BathyDbGebcoFormat", IntegerValue (4)); // 15 seconds, 2D netcdf format
       wossHelper->SetAttribute ("BathyDbCoordFilePath", StringValue (m_databasePath + "/bathymetry/GEBCO_2020.nc"));
       wossHelper->SetAttribute ("SspDbWoaDbType", IntegerValue (1)); // 2013 WOA DB Format
       wossHelper->SetAttribute ("SspDbCoordFilePath", StringValue (m_databasePath + "/ssp/WOA2018/WOA2018_SSP_April.nc"));
+      wossHelper->SetAttribute ("SedimentDbDeck41DbType", IntegerValue (1)); // DECK41 V2 database data format
 #else
       wossHelper->SetAttribute ("BathyDbGebcoFormat", IntegerValue (3)); // 30 seconds, 2D netcdf format
       wossHelper->SetAttribute ("BathyDbCoordFilePath", StringValue (m_databasePath + "/bathymetry/GEBCO_2014_2D.nc"));

helper/woss-helper.cc

@@ -72,6 +72,9 @@
 #define WH_WOA_DB_TYPE_DEFAULT (1)
 #define WH_WOA_DB_TYPE_MIN (0)
 #define WH_WOA_DB_TYPE_MAX (1)
+#define WH_SEDIMENT_DECK41_FORMAT_DEFAULT (1)
+#define WH_SEDIMENT_DECK41_FORMAT_MIN (0)
+#define WH_SEDIMENT_DECK41_FORMAT_MAX (1)
 #endif // defined (WOSS_NETCDF_SUPPORT)
 
 namespace ns3 {
@@ -191,6 +194,9 @@ WossHelper::WossHelper ()
 #if defined (WOSS_NETCDF_SUPPORT)
     m_sedimDbCreatorDebug (WH_DEBUG_DEFAULT),
     m_sedimDbDebug (WH_DEBUG_DEFAULT),
+#if defined (WOSS_NETCDF4_SUPPORT)
+    m_sedimDbDeck41DbType(WH_SEDIMENT_DECK41_FORMAT_DEFAULT),
+#endif // defined (WOSS_NETCDF4_SUPPORT)
     m_sedimDbCoordFilePath (WH_STRING_DEFAULT),
     m_sedimDbMarsdenFilePath (WH_STRING_DEFAULT),
     m_sedimDbMarsdenOneFilePath (WH_STRING_DEFAULT),
@@ -409,6 +415,9 @@ WossHelper::Initialize (Ptr<WossPropModel> wossPropModel)
       m_sedimDbCreator->setDeck41MarsdenOnePathName (m_sedimDbMarsdenOneFilePath);
       m_sedimDbCreator->setDebug (m_sedimDbCreatorDebug);
       m_sedimDbCreator->setWossDebug (m_sedimDbDebug);
+#if defined (WOSS_NETCDF4_SUPPORT)
+      m_sedimDbCreator->setDeck41DbType ((woss::DECK41DbType)m_sedimDbDeck41DbType);
+#endif // defined (WOSS_NETCDF4_SUPPORT)
 
       m_wossController->setSedimentDbCreator (m_sedimDbCreator);
     }
@@ -1339,6 +1348,13 @@ WossHelper::GetTypeId ()
                    BooleanValue (WH_DEBUG_DEFAULT),
                    MakeBooleanAccessor (&WossHelper::m_sedimDbDebug),
                    MakeBooleanChecker () )
+#if defined (WOSS_NETCDF4_SUPPORT)
+    .AddAttribute ("SedimentDbDeck41DbType",
+                   "SSP WOA Db Type: 0 = V1 Format Db, 1 = V2 Format Db",
+                   IntegerValue (WH_SEDIMENT_DECK41_FORMAT_DEFAULT),
+                   MakeIntegerAccessor (&WossHelper::m_sedimDbDeck41DbType),
+                   MakeIntegerChecker<int> (WH_SEDIMENT_DECK41_FORMAT_MIN, WH_SEDIMENT_DECK41_FORMAT_MAX ) )
+#endif // defined (WOSS_NETCDF4_SUPPORT)
     .AddAttribute ("SedimDbCoordFilePath",
                    "Sediment Db will read the coordinates database from this file (full path required)",
                    StringValue (WH_STRING_DEFAULT),

helper/woss-helper.h

@@ -486,6 +486,9 @@ class WossHelper : public Object
 #if defined (WOSS_NETCDF_SUPPORT)
   bool m_sedimDbCreatorDebug; //!< enable/disable the debug prints of the woss sediment database creator.
   bool m_sedimDbDebug; //!< enable/disable the debug prints of the woss sediment database.
+#if defined (WOSS_NETCDF4_SUPPORT)
+  int m_sedimDbDeck41DbType; //!< set the DECK41 database data format type. 0 = V1 data format, 1 = V2 data format
+#endif // defined (WOSS_NETCDF4_SUPPORT)
   ::std::string m_sedimDbCoordFilePath; //!< setup the path of the sediment database indexed by geographical coordinates with decimal degrees resolution
   ::std::string m_sedimDbMarsdenFilePath; //!< setup the path of the sediment database indexed by geographical coordinates with marsden square resolution
   ::std::string m_sedimDbMarsdenOneFilePath; //!< setup the path of the sediment database indexed by geographical coordinates with marsden one square resolution