Seperated sanity checks and eroor mesaages

Author: janakarana

src/app/parameters.cpp

@@ -4,8 +4,8 @@
 //**********************************************************************
 
 #include "parameters.h"
-#include "qcombobox.h"
-#include "qradiobutton.h"
+#include <QComboBox>
+#include <QRadioButton>
 #include <QMessageBox>
 
 parameters::parameters(void)
@@ -20,199 +20,235 @@ parameters::~parameters(void)
 bool parameters::CheckCommonParameters(QRadioButton *radioButton_MonoDisperse,
                                        QRadioButton *radioButton_NumDen,
                                        QRadioButton *radioButton_VolFrac)
+{    
+    bool monoDisperseSelection = false;
+    bool numDenSelection = false;
+    bool volFracSelection = false;
+
+    if (radioButton_MonoDisperse->isChecked())
+        monoDisperseSelection = true;
+    if (radioButton_NumDen->isChecked())
+        numDenSelection = true;
+    if (radioButton_VolFrac->isChecked())
+        volFracSelection = true;
+
+    ParameterValidationResult check = CheckValidityCommonParameters(monoDisperseSelection,
+                                                         numDenSelection,volFracSelection);
+    if (!check.isValid)
+    {
+        QMessageBox msgBoxError;
+        msgBoxError.setWindowTitle("Error");
+        msgBoxError.setIcon(QMessageBox::Critical);
+        msgBoxError.setText(check.errorMessage);
+        msgBoxError.exec();
+        return false;
+    }
+    else
+        return true;
+}
+
+ParameterValidationResult parameters::CheckValidityCommonParameters(
+                                                    bool monoDisperseSelection,
+                                                    bool numDenSelection,
+                                                    bool volFracSelection)
 {
-    QMessageBox msgBox, msgBoxWarn;
-    msgBox.setWindowTitle("Error");
-    msgBox.setIcon(QMessageBox::Critical);
-    msgBoxWarn.setWindowTitle("Warning");
-    msgBoxWarn.setIcon(QMessageBox::Warning);
+    ParameterValidationResult result;
+    result.isValid = true;
 
     if ((scatRefReal <= 0.0) || (medRef <= 0.0))
     {
-        msgBox.setText("Refractive index cannot be zero");
-        msgBox.exec();
-        return 1;
+        result.isValid = false;
+        result.errorMessage = "Refractive index cannot be zero.";
+        return result;
+
     }
     if ((scatRefReal/medRef == 1.0))
     {
-        msgBox.setText("Relative refractive index cannot be 1.0");
-        msgBox.exec();
-        return 1;
+        result.isValid = false;
+        result.errorMessage = "Relative refractive index cannot be 1.0.";
+        return result;
     }
     double m = scatRefReal / medRef;
     if ((m < 0.05) || (m > 5.0))
     {
-        msgBoxWarn.setText("Unrealistic relative refractive index.");
-        msgBoxWarn.setInformativeText("Check sphere and medium refractive index values");
-        msgBoxWarn.exec();
-        return 1;
+        result.isValid = false;
+        result.errorMessage = "Unrealistic relative refractive index! Check sphere and medium refractive index values.";
+        return result;
     }
     if (scatRefImag >= 5.0)
     {
-        msgBox.setText("Imaginary refractive index must be negative or less than 5.0.");
-        msgBox.exec();
-        return 1;
+        result.isValid = false;
+        result.errorMessage = "Imaginary refractive index must be negative or less than 5.0.";
+        return result;
     }
     //Avoid zeros
     if ((startWavel <= 0.0) || (endWavel <= 0.0))
     {
-        msgBox.setText("The starting or ending wavelength cannot be zero");
-        msgBox.exec();
-        return 1;
+        result.isValid = false;
+        result.errorMessage = "The starting or ending wavelength cannot be zero.";
+        return result;
     }
     //Avoid zeros
     if (stepWavel <= 0.0)
     {
-        msgBox.setText("Wavelength step cannot be zero");
-        msgBox.exec();
-        return 1;
+        result.isValid = false;
+        result.errorMessage = "Wavelength step cannot be zero.";
+        return result;
     }
     if (startWavel < 50.0)
     {
-        msgBox.setText("Minimum wavlength is 50nm");
-        msgBox.exec();
-        return 1;
+        result.isValid = false;
+        result.errorMessage = "Current minimum wavlength is 50nm.";
+        return result;
     }
     if (endWavel > 3000.0)
     {
-        msgBox.setText("Maximum wavlength is 3000nm");
-        msgBox.exec();
-        return 1;
+        result.isValid = false;
+        result.errorMessage = "Current maximum wavlength is 3000nm.";
+        return result;
     }
     if (endWavel - startWavel < 0.0)
     {
-        msgBox.setText("The starting wavelength is greater than the ending wavelength");
-        msgBox.exec();
-        return 1;
+        result.isValid = false;
+        result.errorMessage = "The starting wavelength is greater than the ending wavelength.";
+        return result;
     }
-    if (radioButton_NumDen->isChecked())
+    if (numDenSelection)
     {
         if (sphNumDensity <= 0.0)
         {
-            msgBox.setText("Sphere concentration cannot be zero");
-            msgBox.exec();
-            return 1;
+            result.isValid = false;
+            result.errorMessage = "Sphere concentration cannot be zero.";
+            return result;
         }
     }
-    if (radioButton_VolFrac->isChecked())
+    if (volFracSelection)
     {
         if (volFraction <= 0.0)
         {
-            msgBox.setText("Volume Fraction cannot be zero");
-            msgBox.exec();
-            return 1;
+            result.isValid = false;
+            result.errorMessage = "Volume Fraction cannot be zero.";
+            return result;
         }
 
         if (volFraction >= 1.0)
         {
-            msgBox.setText("Volume Fraction cannot exceed 1.0");
-            msgBox.exec();
-            return 1;
+            result.isValid = false;
+            result.errorMessage = "Volume Fraction cannot exceed 1.0.";
+            return result;
         }
     }
     if ((meanRadius < 0.00005) ||(meanRadius >150))
     {
-        msgBox.setText("Diameter is out of range!");
-        msgBox.setInformativeText("Enter a value between 0.0001μm and 300μm");
-        msgBox.exec();
-        return 1;
+        result.isValid = false;
+        result.errorMessage = "Diameter is out of range! Enter a value between 0.0001μm and 300μm.";
+        return result;
     }
-    if (radioButton_MonoDisperse->isChecked())
+    if (monoDisperseSelection)
     {
-        if (radioButton_NumDen->isChecked())
+        if (numDenSelection)
         {
             double volume = 4.0 * M_PI *meanRadius * meanRadius * meanRadius / 3.0;
             if (sphNumDensity*volume >= 1e9)
             {
-                msgBoxWarn.setText("Concentration x Sphere Volume exceeds 1mm³.");
-                msgBoxWarn.setInformativeText("Reduce Concentration.");
-                msgBoxWarn.exec();
-                return 1;
+                result.isValid = false;
+                result.errorMessage = "Concentration x Sphere Volume exceeds 1mm³! Reduce Concentration (Conc).";
+                return result;
             }
         }
     }
-    return 0;
+    return result;
 }
 
+//Check the validity of Distribution parameters
 bool parameters::CheckDistributionParameters(QComboBox *comboBox_Distribution)
 {
-    QMessageBox msgBox;
-    msgBox.setWindowTitle("Error");
+    int comboBoxIndex =0;
+
+    if (comboBox_Distribution->currentIndex() == 0)
+        comboBoxIndex = 0;
+    if (comboBox_Distribution->currentIndex() == 1)
+        comboBoxIndex = 1;
+
+    ParameterValidationResult check = CheckValidityDistributionParameters(comboBoxIndex);
+
+    if (!check.isValid)
+    {
+        QMessageBox msgBoxError;
+        msgBoxError.setWindowTitle("Error");
+        msgBoxError.setIcon(QMessageBox::Critical);
+        msgBoxError.setText(check.errorMessage);
+        msgBoxError.exec();
+        return false;
+    }
+    else
+        return true;
+}
+
+ParameterValidationResult parameters::CheckValidityDistributionParameters(int comboBoxIndex)
+{
+    ParameterValidationResult result;
+    result.isValid = true;
 
     if (stdDev == 0.0)
     {
-        msgBox.setText("Standard Deviation is zero.");
-        msgBox.setInformativeText("Use 'Mono Disperse'.");
-        msgBox.exec();
-        return 1;
+        result.isValid = false;
+        result.errorMessage = "Standard Deviation is zero! Use 'Mono Disperse'.";
+        return result;
     }
-    if(comboBox_Distribution->currentIndex() == 0)
+    if(comboBoxIndex == 0)
     {
         if (stdDev > 3.0)
         {
-            msgBox.setIcon(QMessageBox::Critical);
-            msgBox.setText("Large standard deviation provides an abnormal Log Normal distribution.");
-            msgBox.setInformativeText("The limit was set to 3.0μm.");
-            msgBox.exec();
-            return 1;
+            result.isValid = false;
+            result.errorMessage = "Large standard deviation provides an abnormal Log Normal distribution! Current limit for Log Normal is 3.0μm.";
+            return result;
         }
         if (stdDev < 1e-5)
         {
-            msgBox.setIcon(QMessageBox::Critical);
-            msgBox.setText("The standard deviation is too small.");
-            msgBox.setInformativeText("Use 'Mono Disperse'.");
-            msgBox.exec();
-            return 1;
+            result.isValid = false;
+            result.errorMessage = "The standard deviation is too small! Use 'Mono Disperse'.";
+            return result;
         }
     }
-
-    if(comboBox_Distribution->currentIndex() == 1)
+    if(comboBoxIndex == 1)
     {
         if (stdDev > 50.0)
         {
-            msgBox.setIcon(QMessageBox::Critical);
-            msgBox.setText("The standard deviation is too large.");
-            msgBox.setInformativeText("The limit was set to 50.0μm.");
-            msgBox.exec();
-            return 1;
+            result.isValid = false;
+            result.errorMessage = "The standard deviation is too large! Current limit for Gaussian is 50.0μm.";
+            return result;
         }
         if (stdDev < 1e-8)
         {
-            msgBox.setIcon(QMessageBox::Critical);
-            msgBox.setText("The standard deviation is too small.");
-            msgBox.setInformativeText("Use 'Mono Disperse'.");
-            msgBox.exec();
-            return 1;
+            result.isValid = false;
+            result.errorMessage = "The standard deviation is too small! Use 'Mono Disperse'.";
+            return result;
         }
     }
     if (nRadius == 1)
     {
-        msgBox.setText("Discrete sphere size is 1. ");
-        msgBox.setInformativeText("Use 'Mono Disperse'.");
-        msgBox.exec();
-        return 1;
+        result.isValid = false;
+        result.errorMessage = "Discrete sphere size is 1! Use 'Mono Disperse'.";
+        return result;
     }
     if ((nRadius < 2.0) ||(nRadius >101.0))
     {
-        msgBox.setText("Number of sphere sizes is out of range.");
-        msgBox.setInformativeText("Enter a value between 2 and 101.");
-        msgBox.exec();
-        return 1;
+        result.isValid = false;
+        result.errorMessage = "Number of sphere sizes is out of range! Enter a value between 2 and 101.";
+        return result;
     }
     if ((meanRadius < 0.0005) ||(meanRadius >25))
     {
-        msgBox.setText("Diameter is out of range.");
-        msgBox.setInformativeText("Enter a value between 0.001μm and 50μm.");
-        msgBox.exec();
-        return 1;
+        result.isValid = false;
+        result.errorMessage = "Diameter is out of range! Enter a value between 0.001μm and 50μm.";
+        return result;
     }
     if (stdDev/meanRadius < 1.999e-5)
     {
-        msgBox.setIcon(QMessageBox::Critical);
-        msgBox.setText("Standard deviation to mean diameter ratio is smaller than 1e-5.");
-        msgBox.setInformativeText("Use 'Mono Disperse'");
-        msgBox.exec();
-        return 1;
+        result.isValid = false;
+        result.errorMessage = "Standard deviation to mean diameter ratio is smaller than 1e-5! Use 'Mono Disperse'.";
+        return result;
     }
-    return 0;
+    return result;
 }

src/app/parameters.h

@@ -7,6 +7,11 @@
 #include <QRadioButton>
 #include <QComboBox>
 
+struct ParameterValidationResult {
+    bool isValid;
+    QString errorMessage;
+};
+
 class parameters
 {
 public:
@@ -17,6 +22,10 @@ class parameters
                                QRadioButton *radioButton_NumDen,
                                QRadioButton *radioButton_VolFrac);
     bool CheckDistributionParameters(QComboBox *comboBox_Distribution);
+    ParameterValidationResult CheckValidityCommonParameters(bool monoDisperseSelection,
+                                                            bool numDenSelection,
+                                                            bool volFracSelection);
+    ParameterValidationResult CheckValidityDistributionParameters(int comboBoxIndex);
 
 
     double *radArray = nullptr;         // radArray: radius Array