GCC Code Coverage Report


Directory: ./
Coverage: low: ≥ 0% medium: ≥ 75.0% high: ≥ 90.0%
Coverage Exec / Excl / Total
Lines: 100.0% 0 / 1 / 1
Functions: -% 0 / 1 / 1
Branches: -% 0 / 1 / 1

src/gbxml/ReverseTranslator.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 // krishnan adding a test comment for SVN check-in
7
8 #ifndef GBXML_REVERSETRANSLATOR_HPP
9 #define GBXML_REVERSETRANSLATOR_HPP
10
11 #include "gbXMLAPI.hpp"
12
13 #include "../utilities/core/Path.hpp"
14 #include "../utilities/core/Optional.hpp"
15 #include "../utilities/core/Logger.hpp"
16 #include "../utilities/core/StringStreamLogSink.hpp"
17
18 #include "../utilities/units/Unit.hpp"
19 #include <unordered_map>
20
21 namespace pugi {
22 class xml_node;
23 class xml_document;
24 } // namespace pugi
25
26 namespace openstudio {
27
28 class ProgressBar;
29
30 namespace model {
31 class Model;
32 class ModelObject;
33 class Surface;
34 } // namespace model
35
36 namespace gbxml {
37
38 class GBXML_API ReverseTranslator
39 {
40 public:
41 ReverseTranslator();
42
43 ~ReverseTranslator();
44
45 boost::optional<openstudio::model::Model> loadModel(const openstudio::path& path, ProgressBar* progressBar = nullptr);
46
47 /** Get warning messages generated by the last translation. */
48 std::vector<LogMessage> warnings() const;
49
50 /** Get error messages generated by the last translation. */
51 std::vector<LogMessage> errors() const;
52
53 private:
54 openstudio::Unit m_temperatureUnit;
55 openstudio::Unit m_lengthUnit;
56 double m_nonBaseMultiplier;
57 double m_lengthMultiplier;
58 openstudio::Unit m_areaUnit;
59 openstudio::Unit m_volumeUnit;
60 bool m_useSIUnitsForResults;
61
62 private:
63 // given id and name from XML (name may be empty) return an OS name
64 std::string escapeName(const std::string& id, const std::string& name);
65
66 std::map<std::string, openstudio::model::ModelObject> m_idToObjectMap;
67
68 // In ReverseTranslator.cpp
69 boost::optional<openstudio::model::Model> convert(const pugi::xml_node& root);
70 boost::optional<openstudio::model::Model> translateGBXML(const pugi::xml_node& root);
71 boost::optional<openstudio::model::ModelObject> translateCampus(const pugi::xml_node& element, openstudio::model::Model& model);
72 boost::optional<openstudio::model::ModelObject> translateBuilding(const pugi::xml_node& element, openstudio::model::Model& model);
73 boost::optional<openstudio::model::ModelObject> translateBuildingStory(const pugi::xml_node& element, openstudio::model::Model& model);
74 boost::optional<openstudio::model::ModelObject> translateThermalZone(const pugi::xml_node& element, openstudio::model::Model& model);
75 boost::optional<openstudio::model::ModelObject> translateSpace(const pugi::xml_node& element, openstudio::model::Model& model);
76 boost::optional<openstudio::model::ModelObject> translateSurface(const pugi::xml_node& element, openstudio::model::Model& model);
77 boost::optional<openstudio::model::ModelObject> translateSubSurface(const pugi::xml_node& element, openstudio::model::Surface& surface);
78
79 /** Set the model object Name and gbXMLId additional property as the id. */
80 void translateId(const pugi::xml_node& element, openstudio::model::ModelObject& modelObject);
81
82 /** Set the model object displayName additional property as the Name. */
83 void translateName(const pugi::xml_node& element, openstudio::model::ModelObject& modelObject);
84
85 /** Set the model object CADObjectId additional property as the CADObjectId. */
86 void translateCADObjectId(const pugi::xml_node& element, openstudio::model::ModelObject& modelObject);
87
88 // In MapSchedules.cpp
89 boost::optional<openstudio::model::ModelObject> translateScheduleDay(const pugi::xml_node& element, openstudio::model::Model& model);
90 boost::optional<openstudio::model::ModelObject> translateScheduleWeek(const pugi::xml_node& element, const pugi::xml_node& root,
91 openstudio::model::Model& model);
92 boost::optional<openstudio::model::ModelObject> translateSchedule(const pugi::xml_node& element, const pugi::xml_node& root,
93 openstudio::model::Model& model);
94
95 // In MapEnvelope.cpp
96 boost::optional<openstudio::model::ModelObject> translateConstruction(const pugi::xml_node& element,
97 const std::unordered_map<std::string, pugi::xml_node>& layerElements,
98 openstudio::model::Model& model);
99 boost::optional<openstudio::model::ModelObject> translateWindowType(const pugi::xml_node& element, openstudio::model::Model& model);
100 boost::optional<openstudio::model::ModelObject> translateMaterial(const pugi::xml_node& element, openstudio::model::Model& model);
101
102 void validateSpaceSurfaces(openstudio::model::Model& model);
103
104 StringStreamLogSink m_logSink;
105
106 ProgressBar* m_progressBar;
107
108 − REGISTER_LOGGER("openstudio.gbxml.ReverseTranslator");
109 };
110
111 } // namespace gbxml
112 } // namespace openstudio
113
114 #endif // GBXML_REVERSETRANSLATOR_HPP
115