--minor

Author: jturner65

src/esp/metadata/diagnostics/DatasetDiagnosticsTool.cpp

@@ -46,7 +46,8 @@ bool DatasetDiagnosticsTool::setDiagnosticesFromJSON(
   ESP_ERROR(Mn::Debug::Flag::NoSpace)
       << msgStr
       << " configuration specifies `request_diagnostics` but specification "
-         "is unable to be parsed, so diagnostics request is ignored.";
+         "is unable to be parsed as either a string or an array, so "
+         "diagnostics request is ignored.";
   return false;
 }  // DatasetDiagnosticsTool::setDiagnosticesFromJSON
 

src/esp/metadata/diagnostics/DatasetDiagnosticsTool.h

@@ -208,21 +208,36 @@ class DatasetDiagnosticsTool {
   /**
    * @brief Set that a save is required. This is to bridge from reading the json
    * file into the attributes and registering the attributes to the
-   * post-registration code.
+   * post-registration code. True means we corrected dataset components due to
+   * diagnostic activities and we wish to save those corrected components.
    */
   void setSaveRequired(bool saveRequired) {
     _requiresCorrectedSave = saveRequired;
   }
 
   /**
-   * @brief Clear any flags set due to specific diagnostics
+   * @brief Reset the current state of the Diagnostics tool.
+   */
+  void reset() {
+    clearSaveRequired();
+    clearDiagnosticFlags();
+  }
+
+  /**
+   * @brief Clear save flag set due to specific diagnostic conditions
    */
   void clearSaveRequired() { _requiresCorrectedSave = false; }
 
+  /**
+   * @brief Clear all existing diagnostic flag settings.
+   */
+  void clearDiagnosticFlags() { _diagnosticsFlags = 0u; }
+
   /**
    * @brief Get whether a save is required. This is to bridge from reading the
    * json file into the attributes and registering the attributes to the
-   * post-registration code.
+   * post-registration code. True means we corrected dataset components due to
+   * diagnostic activities and we wish to save those corrected components.
    */
   bool saveRequired() const { return _requiresCorrectedSave; }
 

src/esp/metadata/managers/AbstractAttributesManager.h

@@ -192,7 +192,7 @@ class AbstractAttributesManager : public ManagedFileBasedContainer<T, Access> {
   void setValsFromJSONDoc(AttribsPtr attribs,
                           const io::JsonGenericValue& jsonConfig) {
     // Clear diagnostic flags from previous run
-    this->datasetDiagnostics_->clearSaveRequired();
+    this->datasetDiagnostics_->reset();
     this->setValsFromJSONDocInternal(attribs, jsonConfig);
     if (this->datasetDiagnostics_->saveRequired()) {
       ESP_WARNING(Mn::Debug::Flag::NoSpace)
@@ -208,18 +208,19 @@ class AbstractAttributesManager : public ManagedFileBasedContainer<T, Access> {
    * @brief Configure @ref datasetDiagnostics_ tool based on if passsed jsonConfig
    * requests them.
    */
-  bool setDSDiagnostics(AttribsPtr attribs,
-                        const io::JsonGenericValue& jsonConfig) {
+  bool setDSDiagnosticsFromJSON(AttribsPtr attribs,
+                                const io::JsonGenericValue& jsonConfig) {
     io::JsonGenericValue::ConstMemberIterator jsonIter =
         jsonConfig.FindMember("request_diagnostics");
     if (jsonIter == jsonConfig.MemberEnd()) {
       return false;
     }
     return this->datasetDiagnostics_->setDiagnosticesFromJSON(
-        jsonIter->value, Cr::Utility::formatString(
-                             "(setDSDiagnostics) <{}> : {}", this->objectType_,
-                             attribs->getSimplifiedHandle()));
-  }  // setDSDiagnostics
+        jsonIter->value,
+        Cr::Utility::formatString("(setDSDiagnosticsFromJSON) <{}> : {}",
+                                  this->objectType_,
+                                  attribs->getSimplifiedHandle()));
+  }  // setDSDiagnosticsFromJSON
 
   /**
    * @brief Merge the passed DatasetDiagnosticsTool settings into

src/esp/metadata/managers/SceneDatasetAttributesManager.cpp

@@ -70,7 +70,7 @@ void SceneDatasetAttributesManager::setValsFromJSONDocInternal(
     attributes::SceneDatasetAttributes::ptr dsAttribs,
     const io::JsonGenericValue& jsonConfig) {
   // check for diagnostics requests
-  bool dsSet = this->setDSDiagnostics(dsAttribs, jsonConfig);
+  bool dsSet = this->setDSDiagnosticsFromJSON(dsAttribs, jsonConfig);
   ESP_VERY_VERBOSE(Mn::Debug::Flag::NoSpace)
       << "Attempt to set dataset diagnostics was a "
       << (dsSet ? "Success" : "Failure");