GCC Code Coverage Report


Directory: ./
Coverage: low: ≥ 0% medium: ≥ 75.0% high: ≥ 90.0%
Coverage Exec / Excl / Total
Lines: 53.6% 60 / 1 / 113
Functions: 75.0% 12 / 1 / 17
Branches: 16.7% 24 / 1 / 145

src/workflow/OSWorkflow.hpp
Line Branch Exec Source
1 /***********************************************************************************************************************
2 * OpenStudio(R), Copyright (c) Alliance for Energy Innovation, LLC.
3 * See also https://openstudio.net/license
4 ***********************************************************************************************************************/
5
6 #ifndef WORKFLOW_OSWORKFLOW_HPP
7 #define WORKFLOW_OSWORKFLOW_HPP
8
9 #include "Timer.hpp"
10
11 #include "../measure/OSRunner.hpp"
12 #include "../scriptengine/ScriptEngine.hpp"
13 #include "../utilities/core/Logger.hpp"
14 #include "../utilities/core/Filesystem.hpp"
15 #include "../utilities/filetypes/WorkflowJSON.hpp"
16 #include "../utilities/filetypes/RunOptions.hpp"
17 #include "../modelica/ModelicaFile.hpp"
18
19 #include <functional>
20 #include <map>
21 #include <memory>
22
23 #define USE_RUBY_ENGINE 1
24 #define USE_PYTHON_ENGINE 1
25
26 namespace openstudio {
27
28 struct WorkflowRunOptions;
29 class Variant;
30
31 namespace measure {
32 class OSArgument;
33 using OSArgumentMap = std::map<std::string, OSArgument>;
34 } // namespace measure
35
36 class OSWorkflow
37 {
38 public:
39 OSWorkflow(const filesystem::path& oswPath, ScriptEngineInstance& ruby, ScriptEngineInstance& python);
40 OSWorkflow(const WorkflowRunOptions& t_workflowRunOptions, ScriptEngineInstance& ruby, ScriptEngineInstance& python);
41
42 bool run();
43
44 private:
45 − REGISTER_LOGGER("openstudio.workflow.OSWorkflow");
46 #if USE_RUBY_ENGINE
47 ScriptEngineInstance& rubyEngine;
48 #endif
49 #if USE_PYTHON_ENGINE
50 ScriptEngineInstance& pythonEngine;
51 #endif
52 WorkflowJSON workflowJSON;
53 measure::OSRunner runner{workflowJSON};
54 model::Model model;
55 boost::optional<Workspace> workspace_;
56 boost::optional<modelica::ModelicaFile> modelicaFile;
57 boost::optional<openstudio::path> m_modelicaSeedFileName;
58 boost::optional<openstudio::path> m_latestModelicaFilePath;
59 boost::optional<openstudio::path> m_lastModelicaResultPath;
60 openstudio::filesystem::path epwPath;
61 openstudio::filesystem::path sqlPath;
62
63 // TODO: use a unique_ptr or an Instance?
64 std::unique_ptr<workflow::util::TimerCollection> m_timers = nullptr;
65
66 // TODO: should problably store as json directly...
67 // { measureName : { arg_name: arg_value }}
68 std::map<std::string, std::map<std::string, openstudio::Variant>> output_attributes;
69
70 bool m_no_simulation = false;
71 bool m_post_process_only = false;
72
73 // stdout stuff
74 bool m_show_stdout = false;
75 bool m_add_timings = false;
76 bool m_detailed_timings = true;
77 bool m_style_stdout = false;
78
79 /** @name Jobs */
80 //@{
81 // Jobs
82
83 enum class State
84 {
85 Queued = -10,
86 Errored = -1,
87 Finished = 0,
88
89 Initialization = 1,
90 OpenStudioMeasures,
91 Translator,
92 EnergyPlusMeasures,
93 ModelicaMeasures,
94 PreProcess,
95 EnergyPlus,
96 Modelica,
97 ReportingMeasures,
98 PostProcess,
99 Cleanup,
100 };
101 State state = State::Queued;
102
103 using memJobFunPtr = void (OSWorkflow::*)();
104
105 // void timeJob(memJobFunPtr, std::string message);
106
107 template <class F, class... Args>
108 138 auto detailedTimeBlock(std::string message, F&& func, Args&&... args) {
109
12/64
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::runEnergyPlus()::{lambda()#1}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::runEnergyPlus()::{lambda()#1}&&):
✗ Branch 0 not taken.
✓ Branch 1 taken 11 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::runEnergyPlus()::{lambda()#2}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::runEnergyPlus()::{lambda()#2}&&):
✗ Branch 0 not taken.
✓ Branch 1 taken 11 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::runEnergyPlus()::{lambda()#3}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::runEnergyPlus()::{lambda()#3}&&):
✗ Branch 0 not taken.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::runEnergyPlus()::{lambda()#4}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::runEnergyPlus()::{lambda()#4}&&):
✗ Branch 0 not taken.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::runEnergyPlus()::{lambda()#5}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::runEnergyPlus()::{lambda()#5}&&):
✗ Branch 0 not taken.
✓ Branch 1 taken 11 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::runInitialization()::{lambda()#1}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::runInitialization()::{lambda()#1}&&):
✗ Branch 0 not taken.
✓ Branch 1 taken 22 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::runInitialization()::{lambda()#2}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::runInitialization()::{lambda()#2}&&):
✗ Branch 0 not taken.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::runInitialization()::{lambda()#3}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::runInitialization()::{lambda()#3}&&):
✗ Branch 0 not taken.
✓ Branch 1 taken 15 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::runModelica()::{lambda()#1}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::runModelica()::{lambda()#1}&&):
✗ Branch 0 not taken.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::runOpenStudioMeasures()::{lambda()#1}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::runOpenStudioMeasures()::{lambda()#1}&&):
✗ Branch 0 not taken.
✓ Branch 1 taken 12 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::runPreProcess()::{lambda()#1}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::runPreProcess()::{lambda()#1}&&):
✗ Branch 0 not taken.
✓ Branch 1 taken 12 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::runPreProcess()::{lambda()#2}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::runPreProcess()::{lambda()#2}&&):
✗ Branch 0 not taken.
✓ Branch 1 taken 12 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::runPreProcess()::{lambda()#3}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::runPreProcess()::{lambda()#3}&&):
✗ Branch 0 not taken.
✓ Branch 1 taken 12 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::runTranslator()::{lambda()#1}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::runTranslator()::{lambda()#1}&&):
✗ Branch 0 not taken.
✓ Branch 1 taken 12 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::saveIDFToRootDirIfDebug()::{lambda()#1}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::saveIDFToRootDirIfDebug()::{lambda()#1}&&):
✗ Branch 0 not taken.
✓ Branch 1 taken 6 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::saveOSMToRootDirIfDebug()::{lambda()#1}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::saveOSMToRootDirIfDebug()::{lambda()#1}&&):
✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
138 if (m_add_timings && m_detailed_timings) {
110 ✗ m_timers->newTimer(std::move(message), 1);
111 }
112 138 std::invoke(std::forward<F>(func), std::forward<Args>(args)...);
113
12/64
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::runEnergyPlus()::{lambda()#1}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::runEnergyPlus()::{lambda()#1}&&):
✗ Branch 0 not taken.
✓ Branch 1 taken 11 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::runEnergyPlus()::{lambda()#2}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::runEnergyPlus()::{lambda()#2}&&):
✗ Branch 0 not taken.
✓ Branch 1 taken 11 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::runEnergyPlus()::{lambda()#3}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::runEnergyPlus()::{lambda()#3}&&):
✗ Branch 0 not taken.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::runEnergyPlus()::{lambda()#4}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::runEnergyPlus()::{lambda()#4}&&):
✗ Branch 0 not taken.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::runEnergyPlus()::{lambda()#5}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::runEnergyPlus()::{lambda()#5}&&):
✗ Branch 0 not taken.
✓ Branch 1 taken 11 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::runInitialization()::{lambda()#1}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::runInitialization()::{lambda()#1}&&):
✗ Branch 0 not taken.
✓ Branch 1 taken 22 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::runInitialization()::{lambda()#2}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::runInitialization()::{lambda()#2}&&):
✗ Branch 0 not taken.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::runInitialization()::{lambda()#3}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::runInitialization()::{lambda()#3}&&):
✗ Branch 0 not taken.
✓ Branch 1 taken 15 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::runModelica()::{lambda()#1}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::runModelica()::{lambda()#1}&&):
✗ Branch 0 not taken.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::runOpenStudioMeasures()::{lambda()#1}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::runOpenStudioMeasures()::{lambda()#1}&&):
✗ Branch 0 not taken.
✓ Branch 1 taken 12 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::runPreProcess()::{lambda()#1}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::runPreProcess()::{lambda()#1}&&):
✗ Branch 0 not taken.
✓ Branch 1 taken 12 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::runPreProcess()::{lambda()#2}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::runPreProcess()::{lambda()#2}&&):
✗ Branch 0 not taken.
✓ Branch 1 taken 12 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::runPreProcess()::{lambda()#3}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::runPreProcess()::{lambda()#3}&&):
✗ Branch 0 not taken.
✓ Branch 1 taken 12 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::runTranslator()::{lambda()#1}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::runTranslator()::{lambda()#1}&&):
✗ Branch 0 not taken.
✓ Branch 1 taken 12 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::saveIDFToRootDirIfDebug()::{lambda()#1}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::saveIDFToRootDirIfDebug()::{lambda()#1}&&):
✗ Branch 0 not taken.
✓ Branch 1 taken 6 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
auto openstudio::OSWorkflow::detailedTimeBlock<openstudio::OSWorkflow::saveOSMToRootDirIfDebug()::{lambda()#1}>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, openstudio::OSWorkflow::saveOSMToRootDirIfDebug()::{lambda()#1}&&):
✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
138 if (m_add_timings && m_detailed_timings) {
114 ✗ m_timers->tockCurrentTimer();
115 }
116 138 }
117
118 // Wipes and creates directory, loads the seed/idf file
119 void runInitialization();
120 void runOpenStudioMeasures();
121 void runTranslator();
122 void runEnergyPlusMeasures();
123 void runModelicaMeasures();
124 void runPreProcess();
125 void runEnergyPlus();
126 void runModelica();
127 void runReportingMeasures();
128 void runPostProcess();
129
130 void runCleanup();
131
132 //@}
133
134 void initializeWeatherFileFromOSW();
135 void updateLastWeatherFileFromModel();
136
137 enum class ApplyMeasureType
138 {
139 Regular = 0,
140 ModelOutputRequests,
141 EnergyPlusOutputRequest
142 };
143
144 void saveModelicaFileToPath(const openstudio::path& filePath);
145 void saveModelicaFileSnapshot(const openstudio::path& directory);
146 void applyMeasures(MeasureType measureType, ApplyMeasureType = ApplyMeasureType::Regular);
147 static void applyArguments(measure::OSArgumentMap& argumentMap, const std::string& argumentName, const openstudio::Variant& argumentValue);
148 void saveOSMToRootDirIfDebug();
149 void saveIDFToRootDirIfDebug();
150
151 // write output_attributes to the measure_attributes.json
152 void communicateMeasureAttributes() const;
153
154 /** Write results.json (same as the final measure_attributes.json but with sanitized keys)
155 * and if `absoluteRootDir (oswDir) / .. / analysis.json` is found, write the objectives.json */
156 void runExtractInputsAndOutputs() const;
157
158 // Zip and write data_point_out.osw
159 void communicateResults() const;
160 };
161
162 } // namespace openstudio
163
164 #endif // WORKFLOW_OSWORKFLOW_HPP
165