Line data    Source code

       1             : // EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University of Illinois,
       2             : // The Regents of the University of California, through Lawrence Berkeley National Laboratory
       3             : // (subject to receipt of any required approvals from the U.S. Dept. of Energy), Oak Ridge
       4             : // National Laboratory, managed by UT-Battelle, Alliance for Sustainable Energy, LLC, and other
       5             : // contributors. All rights reserved.
       6             : //
       7             : // NOTICE: This Software was developed under funding from the U.S. Department of Energy and the
       8             : // U.S. Government consequently retains certain rights. As such, the U.S. Government has been
       9             : // granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable,
      10             : // worldwide license in the Software to reproduce, distribute copies to the public, prepare
      11             : // derivative works, and perform publicly and display publicly, and to permit others to do so.
      12             : //
      13             : // Redistribution and use in source and binary forms, with or without modification, are permitted
      14             : // provided that the following conditions are met:
      15             : //
      16             : // (1) Redistributions of source code must retain the above copyright notice, this list of
      17             : //     conditions and the following disclaimer.
      18             : //
      19             : // (2) Redistributions in binary form must reproduce the above copyright notice, this list of
      20             : //     conditions and the following disclaimer in the documentation and/or other materials
      21             : //     provided with the distribution.
      22             : //
      23             : // (3) Neither the name of the University of California, Lawrence Berkeley National Laboratory,
      24             : //     the University of Illinois, U.S. Dept. of Energy nor the names of its contributors may be
      25             : //     used to endorse or promote products derived from this software without specific prior
      26             : //     written permission.
      27             : //
      28             : // (4) Use of EnergyPlus(TM) Name. If Licensee (i) distributes the software in stand-alone form
      29             : //     without changes from the version obtained under this License, or (ii) Licensee makes a
      30             : //     reference solely to the software portion of its product, Licensee must refer to the
      31             : //     software as "EnergyPlus version X" software, where "X" is the version number Licensee
      32             : //     obtained under this License and may not use a different name for the software. Except as
      33             : //     specifically required in this Section (4), Licensee shall not use in a company name, a
      34             : //     product name, in advertising, publicity, or other promotional activities any name, trade
      35             : //     name, trademark, logo, or other designation of "EnergyPlus", "E+", "e+" or confusingly
      36             : //     similar designation, without the U.S. Department of Energy's prior written consent.
      37             : //
      38             : // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
      39             : // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
      40             : // AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
      41             : // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
      42             : // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
      43             : // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
      44             : // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
      45             : // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
      46             : // POSSIBILITY OF SUCH DAMAGE.
      47             : 
      48             : #ifndef DataStringGlobals_hh_INCLUDED
      49             : #define DataStringGlobals_hh_INCLUDED
      50             : 
      51             : // C++ Headers
      52             : #include <string>
      53             : 
      54             : // EnergyPlus Headers
      55             : #include <EnergyPlus/Data/BaseData.hh>
      56             : #include <EnergyPlus/EnergyPlus.hh>
      57             : #include <EnergyPlus/FileSystem.hh>
      58             : 
      59             : namespace EnergyPlus {
      60             : 
      61             : namespace DataStringGlobals {
      62             : 
      63             : #ifdef _WIN32
      64             :     char constexpr pathChar('\\');
      65             :     char constexpr altpathChar('/');
      66             : #elif __linux__
      67             :     char constexpr pathChar('/');
      68             :     char constexpr altpathChar('\\');
      69             : #elif __unix__
      70             :     char constexpr pathChar('/');
      71             :     char constexpr altpathChar('\\');
      72             : #elif __posix__
      73             :     char constexpr pathChar('/');
      74             :     char constexpr altpathChar('\\');
      75             : #elif __APPLE__
      76             :     char constexpr pathChar('/');
      77             :     char constexpr altpathChar('\\');
      78             : #else
      79             : #error "Invalid platform detection in DataStringGlobals."
      80             : #endif
      81             :     char constexpr CharComma(',');     // comma
      82             :     char constexpr CharSemicolon(';'); // semicolon
      83             :     char constexpr CharTab('\t');      // tab
      84             :     char constexpr CharSpace(' ');     // space
      85             :     constexpr std::string_view zonePrefix = "Zone";
      86             :     constexpr std::string_view spacePrefix = "Space";
      87             : 
      88             :     extern std::string const VerString;        // String that represents version information
      89             :     extern std::string const MatchVersion;     // String to be matched by Version object
      90             :     extern std::string const PythonAPIVersion; // API version string to be matched when using the Python API
      91             :     extern std::string const BuildPlatformString;
      92             : } // namespace DataStringGlobals
      93             : 
      94             : struct DataStringGlobalsData : BaseGlobalStruct
      95             : {
      96             : 
      97             :     fs::path outputMddFilePath = "eplusout.mdd";
      98             :     fs::path outputRddFilePath = "eplusout.rdd";
      99             :     fs::path outputShdFilePath = "eplusout.shd";
     100             :     fs::path outputTblCsvFilePath = "eplustbl.csv";
     101             :     fs::path outputTblHtmFilePath = "eplustbl.htm";
     102             :     fs::path outputTblTabFilePath = "eplustbl.tab";
     103             :     fs::path outputTblTxtFilePath = "eplustbl.txt";
     104             :     fs::path outputTblXmlFilePath = "eplustbl.xml";
     105             :     fs::path outputAdsFilePath = "eplusADS.out";
     106             :     fs::path outputGLHEFilePath = "eplusout.glhe";
     107             :     fs::path outputDelightOutFilePath = "eplusout.delightout";
     108             :     fs::path outputIperrFilePath = "eplusout.iperr";
     109             :     fs::path outputPerfLogFilePath = "eplusout_perflog.csv";
     110             :     fs::path outputSqlFilePath = "eplusout.sql";
     111             :     fs::path outputSqliteErrFilePath = "eplussqlite.err";
     112             :     fs::path outputCsvFilePath = "eplusout.csv";
     113             :     fs::path outputMtrCsvFilePath = "eplusmtr.csv";
     114             :     fs::path outputRvauditFilePath = "eplusout.rvaudit";
     115             : 
     116             :     fs::path outputErrFilePath;
     117             :     fs::path eplusADSFilePath;
     118             :     fs::path inputFilePath; // Full name of file to open, including path `/path/to/myfile.idf`
     119             :     fs::path inputIddFilePath;
     120             :     fs::path inputEpJSONSchemaFilePath;
     121             :     fs::path outDirPath;
     122             :     fs::path inputDirPath;          // `/path/to/`
     123             :     fs::path inputFilePathNameOnly; // `myfile.idf`
     124             :     fs::path exeDirectoryPath;
     125             :     fs::path ProgramPath;          // Path for Program from INI file
     126             :     fs::path CurrentWorkingFolder; // Current working directory for run
     127             : 
     128             :     std::string IDDVerString;    // Version information from the IDD (line 1)
     129             :     std::string CurrentDateTime; // For printing current date and time at start of run
     130             :     std::string VerStringVar;
     131             : 
     132         796 :     void init_state([[maybe_unused]] EnergyPlusData &state) override
     133             :     {
     134         796 :     }
     135             : 
     136           0 :     void clear_state() override
     137             :     {
     138           0 :         outputErrFilePath.clear();
     139           0 :         eplusADSFilePath.clear();
     140           0 :         outDirPath.clear();
     141           0 :         inputFilePathNameOnly.clear();
     142           0 :         inputDirPath.clear();
     143           0 :         exeDirectoryPath.clear();
     144           0 :         inputFilePath.clear();
     145           0 :         inputIddFilePath.clear();
     146           0 :         inputEpJSONSchemaFilePath.clear();
     147           0 :         ProgramPath.clear();
     148           0 :         CurrentWorkingFolder.clear();
     149           0 :         CurrentDateTime.clear();
     150           0 :         IDDVerString.clear();
     151           0 :         VerStringVar.clear();
     152           0 :     }
     153             : };
     154             : 
     155             : } // namespace EnergyPlus
     156             : 
     157             : #endif