Multi-layer grib.

Add code ccomments.

Author: sebastien-rosset

plugins/grib_pi/src/GribReader.cpp

@@ -60,13 +60,18 @@ void GribReader::clean_all_vectors() {
     delete ls;
   }
   mapGribRecords.clear();
+  deletedRecords.clear();
 }
 //-------------------------------------------------------------------------------
 void GribReader::clean_vector(std::vector<GribRecord *> &ls) {
   std::vector<GribRecord *>::iterator it;
   for (it = ls.begin(); it != ls.end(); it++) {
-    delete *it;
-    *it = NULL;
+      GribRecord *ptr = *it;
+      wxLogMessage("clean_vector. About to delete ptr: %p. Already deleted: %d", ptr, deletedRecords.find(ptr) != deletedRecords.end());
+      if(ptr && deletedRecords.find(ptr) == deletedRecords.end()) {
+          delete ptr;
+          deletedRecords.insert(ptr);
+      }
   }
   ls.clear();
 }
@@ -82,6 +87,7 @@ void GribReader::storeRecordInMap(GribRecord *rec) {
 #endif
   std::map<std::string, std::vector<GribRecord *> *>::iterator it;
   it = mapGribRecords.find(rec->getKey());
+  wxLogMessage("storeRecordInMap: %p. Key: %s", rec, rec->getKey());
   if (it == mapGribRecords.end()) {
     mapGribRecords[rec->getKey()] = new std::vector<GribRecord *>;
     assert(mapGribRecords[rec->getKey()]);
@@ -131,24 +137,29 @@ void GribReader::readAllGribRecords() {
 
     if (is_v2 == false) {
       rec = new GribV1Record(file, id);
+      wxLogMessage("readAllGribRecords. Create GribV1Record: %p", rec);
       if (rec->isOk() == false) {
         delete rec;
         rec = new GribV2Record(file, id);
+        wxLogMessage("readAllGribRecords. GribV1Record not ok, deleted. Create GribV2Record: %p. isOk: %d", rec, rec->isOk());
         is_v2 = rec->isOk();
       }
     } else {
       GribV2Record *rec2 = dynamic_cast<GribV2Record *>(rec);
       if (rec2 && rec2->hasMoreDataSet()) {
         rec = rec2->GribV2NextDataSet(file, id);
+        wxLogMessage("rec2 hasMoreDataSet. Create GribV2Record: %p from rec2: %p", rec, rec2);
         delete prevDataSet;
       } else {
         rec = new GribV2Record(file, id);
+        wxLogMessage("rec2 has no more DataSet. Create GribV2Record: %p", rec);
       }
 
       is_v2 = rec->isOk();
       if (rec->isOk() == false) {
         delete rec;
         rec = new GribV1Record(file, id);
+        wxLogMessage("rec2 is not ok. Create GribV1Record: %p", rec);
       }
     }
     prevDataSet = 0;
@@ -290,6 +301,7 @@ void GribReader::copyFirstCumulativeRecord(int dataType, int levelType,
     rec = getFirstGribRecord(dataType, levelType, levelValue);
     if (rec != NULL) {
       GribRecord *r2 = new GribRecord(*rec);
+      wxLogMessage("copyFirstCumulativeRecord. Create GribRecord: %p", r2);
       r2->setRecordCurrentDate(dateref);  // 1er enregistrement factice
       storeRecordInMap(r2);
     }
@@ -334,6 +346,7 @@ void GribReader::copyMissingWaveRecords(int dataType, int levelType,
         if (rec2 && rec2->isOk()) {
           // create a copied record from date2
           GribRecord *r2 = new GribRecord(*rec2);
+          wxLogMessage("copyMissingWaveRecords. Create GribRecord: %p", r2);
           r2->setRecordCurrentDate(date);
           storeRecordInMap(r2);
         }
@@ -455,6 +468,7 @@ void GribReader::readGribFileContent() {
 
     // Crée un GribRecord avec les dewpoints calculés
     GribRecord *recDewpoint = new GribRecord(*recModel);
+    wxLogMessage("readGribFileContent. Create GribRecord: %p", recDewpoint);
     recDewpoint->setDataType(GRB_DEWPOINT);
     for (zuint i = 0; i < (zuint)recModel->getNi(); i++) {
       for (zuint j = 0; j < (zuint)recModel->getNj(); j++) {

plugins/grib_pi/src/GribReader.h

@@ -85,8 +85,20 @@ class GribReader {
 
   enum GribFileDataStatus { DATA_IN_FILE, NO_DATA_IN_FILE, COMPUTED_DATA };
 
+  /**
+   * Initializes cumulative meteorological parameters by copying their first record values.
+   * 
+   * This establishes a proper baseline for accumulation parameters like total precipitation
+   * and cloud cover, preventing artificial zero-value periods.
+   */
   void copyFirstCumulativeRecord();
   // void  removeFirstCumulativeRecord ();
+  /**
+   * Fills gaps in wave-related data fields by propagating known values across missing time periods.
+   * 
+   * This function handles multiple wave parameters including significant height, direction and period,
+   * ensuring continuous visualization of marine conditions.
+   */
   void copyMissingWaveRecords();
   void copyFirstCumulativeRecord(int dataType, int levelType, int levelValue);
   // void  removeFirstCumulativeRecord (int dataType,int levelType,int
@@ -120,6 +132,13 @@ class GribReader {
   void clean_vector(std::vector<GribRecord *> &ls);
   void clean_all_vectors();
   std::vector<GribRecord *> *getFirstNonEmptyList();
+  // GribRecords can be shared between different vectors in mapGribRecords.
+  // Several of the storeRecordInMap() calls in readAllGribRecords() can store
+  // the same GribRecord pointer in multiple vectors.
+  // This means when we try to clean up in clean_vector(), we could end up with
+  // double deletes of the same pointer.
+  // To avoid this, we keep track of which GribRecords have been deleted.
+  std::set<GribRecord*> deletedRecords;
 
   // Interpolation between 2 GribRecord
   double get2GribsInterpolatedValueByDate(double px, double py, time_t date,

plugins/grib_pi/src/GribRecord.h

@@ -151,6 +151,7 @@ class GribCode {
 //----------------------------------------------
 class GribRecord {
 public:
+  /** Copy constructor performs a deep copy of the GribRecord. */
   GribRecord(const GribRecord &rec);
   GribRecord() { m_bfilled = false; }
 
@@ -272,39 +273,146 @@ class GribRecord {
                                         int &Nj, int &rec1offi, int &rec1offj,
                                         int &rec2offi, int &rec2offj);
 
-  int id;          // unique identifiant
-  bool ok;         // valid?
-  bool knownData;  // type de donnée connu
+  /**
+   * Unique identifier for this record.
+   *
+   * Set during file reading for original records.
+   * Monotonically increasing for records read from file.
+   */
+  int id;
+  /**
+   * Indicates record validity.
+   *
+   * A record may be invalid if source records have mismatched dimensions,
+   * missing data arrays, failed interpolation, or the source records themselves
+   * are invalid when creating derived records.
+   */
+  bool ok;
+  /**
+   * Indicates whether the data type in this record is recognized by the parser.
+   * Used to skip unknown data types during processing.
+   */
+  bool knownData;
+  /**
+   * Differentiates wave-related parameters (height, direction, period) from
+   * other meteorological data for specialized processing.
+   */
   bool waveData;
+  /**
+   * Indicates if this record was created through copying rather than direct
+   * reading.
+   *
+   * Tracks whether this record was copied to maintain data continuity. This
+   * happens with wave data gaps or initial values for cumulative parameters.
+   */
   bool IsDuplicated;
+  /**
+   * Signals when the end of the GRIB file has been reached during parsing.
+   */
   bool eof;
+  /**
+   * Unique string identifier constructed from data type, level type, and level
+   * value. Used for record lookup and comparison.
+   */
   std::string dataKey;
   char strRefDate[32];
   char strCurDate[32];
+  /**
+   * Identifies the numerical weather model that produced this data.
+   *
+   * Standard WMO values from GRIB2 Table C-11 include:
+   * - 7: US National Weather Service, National Centers for Environmental
+   * Prediction (NCEP)
+   * - 34: Japanese Meteorological Agency - Tokyo (JMA)
+   * - 58: European Centre for Medium-Range Weather Forecasts (ECMWF)
+   * - 59: DWD (German Weather Service)
+   * - 85: French Weather Service (Meteo France)
+   * - 251: Norwegian Meteorological Institute
+   */
   int dataCenterModel;
+  /**
+   * Indicates whether the data array has been populated. Used to track
+   * partial loading states during record construction.
+   */
   bool m_bfilled;
 
   //---------------------------------------------
   // SECTION 0: THE INDICATOR SECTION (IS)
   //---------------------------------------------
+  /**
+   * GRIB edition number, indicating the version of the GRIB specification used.
+   * Determines how subsequent sections should be parsed.
+   */
   zuchar editionNumber;
 
   // SECTION 1: THE PRODUCT DEFINITION SECTION (PDS)
+  /**
+   * Originating center ID as defined by WMO common table C-1.
+   * Identifies which meteorological center generated the forecast.
+   */
   zuchar idCenter;
+  /**
+   * Model identifier within the originating center.
+   * Distinguishes between different forecast models run by the same center.
+   */
   zuchar idModel;
+  /**
+   * Grid identifier used by the originating center.
+   * Specifies the coordinate system and projection of the data grid.
+   */
   zuchar idGrid;
+  /**
+   * Parameter identifier as defined by GRIB tables.
+   * Specifies what physical quantity is represented (wind, temperature, etc).
+   */
   zuchar dataType;  // octet 9 = parameters and units
+  /**
+   * Vertical level type indicator.
+   * Specifies the type of vertical coordinate (pressure level, height above
+   * ground, etc).
+   */
   zuchar levelType;
+  /**
+   * Numeric value associated with levelType.
+   * For example, the specific pressure level in hectopascals.
+   */
   zuint levelValue;
 
+  /**
+   * Indicates presence of a bitmap section.
+   * When true, the data section uses a bitmap to indicate valid data points.
+   */
   bool hasBMS;
+  /**
+   * Components of the reference time for this forecast.
+   * Specifies when the forecast model was initialized.
+   */
   zuint refyear, refmonth, refday, refhour, refminute;
   // zuchar periodP1, periodP2;
+  /**
+   * Time range indicators for this forecast step.
+   * Used to calculate the valid time period for this data.
+   */
   zuint periodP1, periodP2;
+  /**
+   * Statistical processing indicator.
+   * Describes how the data was processed over time (e.g., accumulation,
+   * average).
+   */
   zuchar timeRange;
-  zuint periodsec;  // period in seconds
-  time_t refDate;   // C reference date
-  time_t curDate;   // C current date
+  /**
+   * Forecast period in seconds.
+   * Time offset from the reference time.
+   */
+  zuint periodsec;
+  /**
+   * Unix timestamp of model initialization time.
+   */
+  time_t refDate;
+  /**
+   * Unix timestamp of when this forecast is valid.
+   */
+  time_t curDate;
   // SECTION 2: THE GRID DESCRIPTION SECTION (GDS)
   zuchar NV, PV;
   zuchar gridType;