Fix file not found output message

src/EnergyPlus/CurveManager.cc

@@ -1729,7 +1729,9 @@ namespace CurveManager {
                             std::size_t rowNum = indVarInstance.at("external_file_starting_row_number").get<std::size_t>() - 1;
 
                             if (!state.dataCurveManager->btwxtManager.tableFiles.count(filePath)) {
-                                state.dataCurveManager->btwxtManager.tableFiles.emplace(filePath, TableFile{IOFiles::getSingleton(), filePath});
+                                TableFile tableFile;
+                                ErrorsFound |= tableFile.load(IOFiles::getSingleton(), filePath);
+                                state.dataCurveManager->btwxtManager.tableFiles.emplace(filePath, tableFile);
                             }
 
                             axis = state.dataCurveManager->btwxtManager.tableFiles[filePath].getArray({colNum, rowNum});
@@ -1918,8 +1920,11 @@ namespace CurveManager {
                     std::size_t colNum = fields.at("external_file_column_number").get<std::size_t>() - 1;
                     std::size_t rowNum = fields.at("external_file_starting_row_number").get<std::size_t>() - 1;
 
+
                     if (!state.dataCurveManager->btwxtManager.tableFiles.count(filePath)) {
-                        state.dataCurveManager->btwxtManager.tableFiles.emplace(filePath, TableFile{IOFiles::getSingleton(), filePath});
+                        TableFile tableFile;
+                        ErrorsFound |= tableFile.load(IOFiles::getSingleton(), filePath);
+                        state.dataCurveManager->btwxtManager.tableFiles.emplace(filePath, tableFile);
                     }
 
                     lookupValues = state.dataCurveManager->btwxtManager.tableFiles[filePath].getArray({colNum, rowNum});
@@ -2018,19 +2023,15 @@ namespace CurveManager {
         tableFiles.clear();
     }
 
-    TableFile::TableFile(IOFiles &ioFiles, std::string path)
-    {
-        load(ioFiles, path);
-    }
-
-    void TableFile::load(IOFiles &ioFiles, std::string path)
+    bool TableFile::load(IOFiles &ioFiles, std::string path)
     {
         filePath = path;
         bool fileFound;
         std::string fullPath;
-        DataSystemVariables::CheckForActualFileName(ioFiles, path, fileFound, fullPath);
-        if (!fileFound) {
-            ShowFatalError("File \"" + filePath + "\" : File not found.");
+        std::string contextString = "CurveManager::TableFile::load: ";
+        DataSystemVariables::CheckForActualFileName(ioFiles, path, fileFound, fullPath, contextString);
+        if(!fileFound){
+            return true;
         }
         std::ifstream file(fullPath);
         std::string line("");
@@ -2064,6 +2065,7 @@ namespace CurveManager {
                 ++colNum;
             }
         }
+        return false;
     }
 
     std::vector<double>& TableFile::getArray(std::pair<std::size_t, std::size_t> colAndRow) {

src/EnergyPlus/CurveManager.hh

@@ -239,11 +239,10 @@ namespace CurveManager {
     {
     public:
         TableFile() = default;
-        TableFile(IOFiles &ioFiles, std::string path);
         std::string filePath;
         std::vector<std::vector<std::string>> contents;
         std::map<std::pair<std::size_t, std::size_t>, std::vector<double>> arrays;
-        void load(IOFiles &ioFiles, std::string path);
+        bool load(IOFiles &ioFiles, std::string path);
         std::vector<double>& getArray(std::pair<std::size_t, std::size_t> colAndRow);
 
     private:

src/EnergyPlus/DataSystemVariables.cc

@@ -45,6 +45,9 @@
 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 // POSSIBILITY OF SUCH DAMAGE.
 
+//C++ Headers
+#include <utility>
+
 // ObjexxFCL Headers
 #include <ObjexxFCL/environment.hh>
 #include <ObjexxFCL/gio.hh>
@@ -202,7 +205,8 @@ namespace DataSystemVariables {
     void CheckForActualFileName(IOFiles &ioFiles,
                                 std::string const &originalInputFileName, // name as input for object
                                 bool &FileFound,                          // Set to true if file found and is in CheckedFileName
-                                std::string &CheckedFileName              // Blank if not found.
+                                std::string &CheckedFileName,             // Blank if not found.
+                                const std::string contextString           //
     )
     {
 
@@ -217,28 +221,13 @@ namespace DataSystemVariables {
         // be accurate. This searches a few folders (CurrentWorkingFolder, Program folder) to see
         // if the file can be found. (It may have been input with full path so that is checked first.)
 
-        // METHODOLOGY EMPLOYED:
-        // na
-
-        // REFERENCES:
-        // na
-
-        // USE STATEMENTS:
-        // na
-
         // Locals
         // SUBROUTINE ARGUMENT DEFINITIONS:
 
         // SUBROUTINE PARAMETER DEFINITIONS:
         static std::string const blank;
         static ObjexxFCL::gio::Fmt fmtA("(A)");
 
-        // INTERFACE BLOCK SPECIFICATIONS:
-        // na
-
-        // DERIVED TYPE DEFINITIONS:
-        // na
-
         // SUBROUTINE LOCAL VARIABLE DECLARATIONS:
         std::string InputFileName; // save for changing out path characters
         std::string::size_type pos;
@@ -255,81 +244,44 @@ namespace DataSystemVariables {
             firstTime = false;
         }
 
-
         FileFound = false;
         CheckedFileName = blank;
         InputFileName = originalInputFileName;
         makeNativePath(InputFileName);
 
-        if (FileSystem::fileExists(InputFileName)) {
-            FileFound = true;
-            CheckedFileName = InputFileName;
-            print(ioFiles.audit, "{}={}\n", "found (user input)", getAbsolutePath(CheckedFileName));
-            return;
-        } else {
-            print(ioFiles.audit, "{}={}\n", "not found (user input)", getAbsolutePath(InputFileName));
-        }
-
-        // Look relative to input file path
-        if (FileSystem::fileExists(DataStringGlobals::inputDirPathName + InputFileName)) {
-            FileFound = true;
-            CheckedFileName = DataStringGlobals::inputDirPathName + InputFileName;
-            print(ioFiles.audit, "{}={}\n", "found (input file)", getAbsolutePath(CheckedFileName));
-            return;
-        } else {
-            print(ioFiles.audit, "{}={}\n", "not found (input file)", getAbsolutePath(DataStringGlobals::inputDirPathName + InputFileName));
-        }
-
-        // Look relative to input path
-        if (FileSystem::fileExists(envinputpath1 + InputFileName)) {
-            FileFound = true;
-            CheckedFileName = envinputpath1 + InputFileName;
-            print(ioFiles.audit, "{}={}\n", "found (epin)", getAbsolutePath(CheckedFileName));
-            return;
-        } else {
-            print(ioFiles.audit, "{}={}\n", "not found (epin)", getAbsolutePath(envinputpath1 + InputFileName));
-        }
-
-        // Look relative to input path
-        if (FileSystem::fileExists(envinputpath2 + InputFileName)) {
-            FileFound = true;
-            CheckedFileName = envinputpath2 + InputFileName;
-            print(ioFiles.audit, "{}={}\n", "found (input_path)", getAbsolutePath(CheckedFileName));
-            return;
-        } else {
-            print(ioFiles.audit, "{}={}\n", "not found (input_path)", getAbsolutePath(envinputpath2 + InputFileName));
-        }
-
-        // Look relative to program path
-        if (FileSystem::fileExists(envprogrampath + InputFileName)) {
-            FileFound = true;
-            CheckedFileName = envprogrampath + InputFileName;
-            print(ioFiles.audit, "{}={}\n", "found (program_path)", getAbsolutePath(CheckedFileName));
-            return;
-        } else {
-            print(ioFiles.audit, "{}={}\n", "not found (program_path)", getAbsolutePath(envprogrampath + InputFileName));
-        }
-
-        if (!TestAllPaths) return;
-
-        // Look relative to current working folder
-        if (FileSystem::fileExists(CurrentWorkingFolder + InputFileName)) {
-            FileFound = true;
-            CheckedFileName = CurrentWorkingFolder + InputFileName;
-            print(ioFiles.audit, "{}={}\n", "found (CWF)", getAbsolutePath(CheckedFileName));
-            return;
-        } else {
-            print(ioFiles.audit, "{}={}\n", "not found (CWF)", getAbsolutePath(CurrentWorkingFolder + InputFileName));
+        std::vector<std::pair<std::string, std::string>> pathsChecked;
+
+        const std::vector<std::pair<std::string, std::string>> pathsToCheck = {
+            {InputFileName, "InputFileName"},
+            {DataStringGlobals::inputDirPathName + InputFileName, "inputDirPathName"},
+            {envinputpath1 + InputFileName, "envinputpath1"},
+            {envinputpath2 + InputFileName, "envinputpath2"},
+            {envprogrampath + InputFileName, "envprogrampath"},
+            {CurrentWorkingFolder + InputFileName, "CurrentWorkingFolder"},
+            {ProgramPath + InputFileName, "ProgramPath"}
+        };
+
+        std::size_t numPathsToNotTest = (TestAllPaths) ? pathsToCheck.size()-2 : pathsToCheck.size();
+
+        for(std::size_t i = 0; i < numPathsToNotTest; i++) {
+            if (FileSystem::fileExists(pathsToCheck[i].first)) {
+                FileFound = true;
+                CheckedFileName = pathsToCheck[i].first;
+                print(ioFiles.audit, "{}={}\n", "found (" + pathsToCheck[i].second +")", getAbsolutePath(CheckedFileName));
+                return;
+            } else {
+                std::pair <std::string,std::string> currentPath(getAbsolutePath(pathsToCheck[i].first), pathsToCheck[i].second);
+                if (std::find(pathsChecked.begin(), pathsChecked.end(), currentPath) == pathsChecked.end()){
+                    pathsChecked.push_back(currentPath);
+                }
+                print(ioFiles.audit, "{}={}\n", "not found (" + pathsToCheck[i].second +")\"", getAbsolutePath(pathsToCheck[i].first));
+            }
         }
-
-        // Look relative to program path
-        if (FileSystem::fileExists(ProgramPath + InputFileName)) {
-            FileFound = true;
-            CheckedFileName = ProgramPath + InputFileName;
-            print(ioFiles.audit, "{}={}\n", "found (program path - ini)", getAbsolutePath(CheckedFileName));
-            return;
-        } else {
-            print(ioFiles.audit, "{}={}\n", "not found (program path - ini)", getAbsolutePath(ProgramPath + InputFileName));
+        if (!FileFound) {
+            ShowSevereError(contextString+ "\"" + originalInputFileName + "\" not found. Paths searched:");
+            for(auto path: pathsChecked){
+                ShowContinueError("   (" + path.second +")\"" + path.first +"\"");
+            }
         }
     }
 

src/EnergyPlus/DataSystemVariables.hh

@@ -53,6 +53,7 @@
 
 // EnergyPlus Headers
 #include <EnergyPlus/EnergyPlus.hh>
+#include <EnergyPlus/IOFiles.hh>
 
 namespace EnergyPlus {
 
@@ -172,7 +173,8 @@ namespace DataSystemVariables {
     void CheckForActualFileName(IOFiles &ioFiles,
                                 std::string const &originalInputFileName, // name as input for object
                                 bool &FileFound,                          // Set to true if file found and is in CheckedFileName
-                                std::string &CheckedFileName              // Blank if not found.
+                                std::string &foundFileName,             // Blank if not found.
+                                const std::string contextString = std::string()
     );
 
     // Needed for unit tests, should not be normally called.

src/EnergyPlus/ExternalInterface.cc

@@ -1156,7 +1156,9 @@ namespace ExternalInterface {
                                               cNumericFieldNames);
                 // Get the FMU name
                 FMU(Loop).Name = cAlphaArgs(1);
-                CheckForActualFileName(ioFiles, cAlphaArgs(1), fileExist, tempFullFileName);
+                std::string contextString = cCurrentModuleObject + ", " + cAlphaFieldNames(1) + ": ";
+
+                CheckForActualFileName(ioFiles, cAlphaArgs(1), fileExist, tempFullFileName, contextString);
                 if (fileExist) {
                     pos = index(FMU(Loop).Name, pathChar, true); // look backwards
                     if (pos != std::string::npos) {
@@ -1171,8 +1173,6 @@ namespace ExternalInterface {
                     }
                     fullFileName(Loop) = tempFullFileName;
                 } else {
-                    ShowSevereError("ExternalInterface/InitExternalInterfaceFMUImport:");
-                    ShowContinueError("file not located = \"" + cAlphaArgs(1) + "\".");
                     ErrorsFound = true;
                 }
                 // Get fmu time out

src/EnergyPlus/HeatBalanceManager.cc

@@ -6262,14 +6262,11 @@ namespace HeatBalanceManager {
         ConstructionFound = false;
         // ErrorsFound = .FALSE.
         EOFonFile = false;
+        std::string contextString = "HeatBalanceManager::SearchWindow5DataFile: ";
 
-        CheckForActualFileName(ioFiles, DesiredFileName, exists, ioFiles.TempFullFileName.fileName);
+        CheckForActualFileName(ioFiles, DesiredFileName, exists, ioFiles.TempFullFileName.fileName, contextString);
         // INQUIRE(FILE=TRIM(DesiredFileName), EXIST=exists)
         if (!exists) {
-            ShowSevereError("HeatBalanceManager: SearchWindow5DataFile: Could not locate Window5 Data File, expecting it as file name=" +
-                            DesiredFileName);
-            ShowContinueError("Certain run environments require a full path to be included with the file name in the input field.");
-            ShowContinueError("Try again with putting full path and file name in the field.");
             ShowFatalError("Program terminates due to these conditions.");
         }
 

src/EnergyPlus/ScheduleManager.cc

@@ -535,12 +535,10 @@ namespace ScheduleManager {
             inputProcessor->getObjectItem(
                 CurrentModuleObject, 1, Alphas, NumAlphas, Numbers, NumNumbers, Status, lNumericBlanks, lAlphaBlanks, cAlphaFields, cNumericFields);
             std::string ShadingSunlitFracFileName = Alphas(1);
-            CheckForActualFileName(ioFiles, ShadingSunlitFracFileName, FileExists, ioFiles.TempFullFileName.fileName);
+
+            std::string contextString = CurrentModuleObject + ", " + cAlphaFields(1) + ": ";
+            CheckForActualFileName(ioFiles, ShadingSunlitFracFileName, FileExists, ioFiles.TempFullFileName.fileName, contextString);
             if (!FileExists) {
-                ShowSevereError(RoutineName + ":\"" + ShadingSunlitFracFileName +
-                                "\" not found when External Shading Calculation Method = ImportedShading.");
-                ShowContinueError("Certain run environments require a full path to be included with the file name in the input field.");
-                ShowContinueError("Try again with putting full path and file name in the field.");
                 ShowFatalError("Program terminates due to previous condition.");
             }
 
@@ -1750,16 +1748,13 @@ namespace ScheduleManager {
             //      ENDDO
             //    ENDIF
 
-            CheckForActualFileName(ioFiles, Alphas(3), FileExists, ioFiles.TempFullFileName.fileName);
+            std::string contextString = CurrentModuleObject + "=\"" + Alphas(1) + "\", " + cAlphaFields(3) + ": ";
+
+            CheckForActualFileName(ioFiles, Alphas(3), FileExists, ioFiles.TempFullFileName.fileName, contextString);
 
             //    INQUIRE(file=Alphas(3),EXIST=FileExists)
             // Setup file reading parameters
             if (!FileExists) {
-                DisplayString("Missing " + Alphas(3));
-                ShowSevereError(RoutineName + CurrentModuleObject + "=\"" + Alphas(1) + "\", " + cAlphaFields(3) + "=\"" + Alphas(3) +
-                                "\" not found.");
-                ShowContinueError("Certain run environments require a full path to be included with the file name in the input field.");
-                ShowContinueError("Try again with putting full path and file name in the field.");
                 ErrorsFound = true;
             } else {
                 auto SchdFile = ioFiles.TempFullFileName.try_open();

tst/EnergyPlus/unit/CMakeLists.txt

@@ -72,6 +72,7 @@ set( test_src
   Datasets.unit.cc
   DataSizing.unit.cc
   DataSurfaces.unit.cc
+  DataSystemVariables.unit.cc
   DataZoneEquipment.unit.cc
   DaylightingManager.unit.cc
   DElightManager.unit.cc