src/utilities/sql/SqlFile.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 UTILITIES_SQL_SQLFILE_HPP | ||
| 7 | #define UTILITIES_SQL_SQLFILE_HPP | ||
| 8 | |||
| 9 | #include "../UtilitiesAPI.hpp" | ||
| 10 | |||
| 11 | #include "SummaryData.hpp" | ||
| 12 | #include "SqlFileDataDictionary.hpp" | ||
| 13 | #include "SqlFileEnums.hpp" | ||
| 14 | #include "SqlFile_Impl.hpp" | ||
| 15 | |||
| 16 | #include "../data/Vector.hpp" | ||
| 17 | #include "../data/Matrix.hpp" | ||
| 18 | #include "../data/DataEnums.hpp" | ||
| 19 | #include "../data/EndUses.hpp" | ||
| 20 | |||
| 21 | #include "../units/SIUnit.hpp" | ||
| 22 | |||
| 23 | #include "../core/Path.hpp" | ||
| 24 | #include "../core/Logger.hpp" | ||
| 25 | #include "../core/Optional.hpp" | ||
| 26 | #include "../core/Deprecated.hpp" | ||
| 27 | |||
| 28 | #include <boost/optional.hpp> | ||
| 29 | |||
| 30 | #include <string> | ||
| 31 | |||
| 32 | namespace openstudio { | ||
| 33 | |||
| 34 | // forward declarations | ||
| 35 | class DateTime; | ||
| 36 | class EpwFile; | ||
| 37 | class Calendar; | ||
| 38 | class SqlFileTimeSeriesQuery; | ||
| 39 | |||
| 40 | //namespace detail { | ||
| 41 | //class SqlFile_Impl; | ||
| 42 | //} | ||
| 43 | |||
| 44 | /** SqlFile class is a transaction script around the sql output of EnergyPlus. */ | ||
| 45 | class UTILITIES_API SqlFile | ||
| 46 | { | ||
| 47 | public: | ||
| 48 | /** @name Constructors */ | ||
| 49 | //@{ | ||
| 50 | |||
| 51 | /// default constructor | ||
| 52 | SqlFile(); | ||
| 53 | |||
| 54 | /// constructor from path | ||
| 55 | /// Creates indexes by default, pass in false for no new indexes and quicker opening | ||
| 56 | explicit SqlFile(const openstudio::path& path, const bool createIndexes = true); | ||
| 57 | |||
| 58 | /// initializes a new sql file for output | ||
| 59 | /// Creates indexes by default, pass in false for no indexes and quicker creation | ||
| 60 | SqlFile(const openstudio::path& t_path, const openstudio::EpwFile& t_epwFile, const openstudio::DateTime& t_simulationTime, | ||
| 61 | const openstudio::Calendar& t_calendar, const bool createIndexes = true); | ||
| 62 | |||
| 63 | // virtual destructor | ||
| 64 | 2413 | virtual ~SqlFile() = default; | |
| 65 | |||
| 66 | // Remove indexes that exist, useful for performance reasons. | ||
| 67 | void removeIndexes(); | ||
| 68 | |||
| 69 | // create indexes on the sql file if they do not exist | ||
| 70 | void createIndexes(); | ||
| 71 | |||
| 72 | //@} | ||
| 73 | /** @name File Queries and Operations */ | ||
| 74 | //@{ | ||
| 75 | |||
| 76 | /// returns whether or not connection is open | ||
| 77 | bool connectionOpen() const; | ||
| 78 | |||
| 79 | /// get the path | ||
| 80 | openstudio::path path() const; | ||
| 81 | |||
| 82 | /// \returns true if the sqlfile is of a version that's in our supported range | ||
| 83 | bool supportedVersion() const; | ||
| 84 | |||
| 85 | // Check if the SQLFile contains the 'Year' field (Added in E+ 8.9.0, but perhaps not working for 8.9.0 itself) | ||
| 86 | bool hasYear() const; | ||
| 87 | |||
| 88 | // Check if the SqlFile contains 'Year' field for DaylightMapHourlyReports (added Year in 9.2.0) | ||
| 89 | bool hasIlluminanceMapYear() const; | ||
| 90 | |||
| 91 | // return a fenestration value for matching subSurfaceName (RowName) and columnName | ||
| 92 | boost::optional<double> getExteriorFenestrationValue(const std::string& subSurfaceName, const std::string& columnName) const; | ||
| 93 | |||
| 94 | // return an Assembly U-Factor value for matching subSurfaceName (RowName) | ||
| 95 | boost::optional<double> assemblyUFactor(const std::string& subSurfaceName) const; | ||
| 96 | |||
| 97 | // return an Assembly SHGC value for matching subSurfaceName (RowName) | ||
| 98 | boost::optional<double> assemblySHGC(const std::string& subSurfaceName) const; | ||
| 99 | |||
| 100 | // return an Assembly Visible Transmittance value for matching subSurfaceName (RowName) | ||
| 101 | boost::optional<double> assemblyVisibleTransmittance(const std::string& subSurfaceName) const; | ||
| 102 | |||
| 103 | /// close the file | ||
| 104 | bool close(); | ||
| 105 | |||
| 106 | /// re-open the file | ||
| 107 | bool reopen(); | ||
| 108 | |||
| 109 | /// Energy Plus eplusout.sql file name | ||
| 110 | std::string energyPlusSqliteFile() const; | ||
| 111 | |||
| 112 | //@} | ||
| 113 | /** @name Standard Queries */ | ||
| 114 | //@{ | ||
| 115 | |||
| 116 | /// hours simulated | ||
| 117 | boost::optional<double> hoursSimulated() const; | ||
| 118 | |||
| 119 | /// net site energy in GJ | ||
| 120 | boost::optional<double> netSiteEnergy() const; | ||
| 121 | |||
| 122 | /// net source energy in GJ | ||
| 123 | boost::optional<double> netSourceEnergy() const; | ||
| 124 | |||
| 125 | /// total site energy in GJ | ||
| 126 | boost::optional<double> totalSiteEnergy() const; | ||
| 127 | |||
| 128 | /// total source energy in GJ | ||
| 129 | boost::optional<double> totalSourceEnergy() const; | ||
| 130 | |||
| 131 | /// Returns the annual total cost associated with the given fuel type in dollars. | ||
| 132 | /// Requires EnergyPlus simulation output to calculate. | ||
| 133 | boost::optional<double> annualTotalCost(const FuelType& fuel) const; | ||
| 134 | |||
| 135 | /// Returns the annual total cost per total building area associated with the given fuel type in dollars per square meter. | ||
| 136 | /// Requires EnergyPlus simulation output to calculate. | ||
| 137 | boost::optional<double> annualTotalCostPerBldgArea(const FuelType& fuel) const; | ||
| 138 | |||
| 139 | /// Returns the annual total cost per net conditioned building area associated with the given fuel type in dollars per square meter. | ||
| 140 | /// Requires EnergyPlus simulation output to calculate. | ||
| 141 | boost::optional<double> annualTotalCostPerNetConditionedBldgArea(const FuelType& fuel) const; | ||
| 142 | |||
| 143 | /// Returns the annual total cost for all fuel types in dollars. Requires EnergyPlus simulation output to calculate. | ||
| 144 | boost::optional<double> annualTotalUtilityCost() const; | ||
| 145 | |||
| 146 | /// Returns the total energy cost over the analysis period in dollars according to the discounting convention. | ||
| 147 | /// Requires EnergyPlus simulation output and LifeCycleCost_Parameters input object to calculate. | ||
| 148 | boost::optional<double> economicsEnergyCost() const; | ||
| 149 | |||
| 150 | OptionalDouble getElecOrGasUse(bool t_getGas = true) const; | ||
| 151 | OptionalDouble getElecOrGasCost(bool t_getGas = true) const; | ||
| 152 | |||
| 153 | /// Returns an EndUses object containing all end uses for the simulation. | ||
| 154 | boost::optional<EndUses> endUses() const; | ||
| 155 | |||
| 156 | /// Returns the energy consumption for the given fuel type, category and month. | ||
| 157 | /// Requires BUILDING ENERGY PERFORMANCE tabular report. Value is energy use in J. | ||
| 158 | boost::optional<double> energyConsumptionByMonth(const openstudio::EndUseFuelType& t_fuelType, const openstudio::EndUseCategoryType& t_categoryType, | ||
| 159 | const openstudio::MonthOfYear& t_monthOfYear) const; | ||
| 160 | |||
| 161 | /// Returns the energy demand for the given fuel type, category and month. | ||
| 162 | /// Requires BUILDING ENERGY PERFORMANCE tabular report. Value is energy use in W. | ||
| 163 | boost::optional<double> peakEnergyDemandByMonth(const openstudio::EndUseFuelType& t_fuelType, const openstudio::EndUseCategoryType& t_categoryType, | ||
| 164 | const openstudio::MonthOfYear& t_monthOfYear) const; | ||
| 165 | |||
| 166 | /// Returns the electric energy used for heating in gigajoules. | ||
| 167 | /// Requires EnergyPlus simulation output to calculate. | ||
| 168 | boost::optional<double> electricityHeating() const; | ||
| 169 | |||
| 170 | /// Returns the electric energy used for cooling in gigajoules. | ||
| 171 | /// Requires EnergyPlus simulation output to calculate. | ||
| 172 | boost::optional<double> electricityCooling() const; | ||
| 173 | |||
| 174 | /// Returns the electric energy used for interior lighting in gigajoules. | ||
| 175 | /// Requires EnergyPlus simulation output to calculate. | ||
| 176 | boost::optional<double> electricityInteriorLighting() const; | ||
| 177 | |||
| 178 | /// Returns the electric energy used for exterior lighting in gigajoules. | ||
| 179 | /// Requires EnergyPlus simulation output to calculate. | ||
| 180 | boost::optional<double> electricityExteriorLighting() const; | ||
| 181 | |||
| 182 | /// Returns the electric energy used for interior equipment in gigajoules. | ||
| 183 | /// Requires EnergyPlus simulation output to calculate. | ||
| 184 | boost::optional<double> electricityInteriorEquipment() const; | ||
| 185 | |||
| 186 | /// Returns the electric energy used for exterior equipment in gigajoules. | ||
| 187 | /// Requires EnergyPlus simulation output to calculate. | ||
| 188 | boost::optional<double> electricityExteriorEquipment() const; | ||
| 189 | |||
| 190 | /// Returns the electric energy used for fans in gigajoules. | ||
| 191 | /// Requires EnergyPlus simulation output to calculate. | ||
| 192 | boost::optional<double> electricityFans() const; | ||
| 193 | |||
| 194 | /// Returns the electric energy used for pumps in gigajoules. | ||
| 195 | /// Requires EnergyPlus simulation output to calculate. | ||
| 196 | boost::optional<double> electricityPumps() const; | ||
| 197 | |||
| 198 | /// Returns the electric energy used for heat rejection in gigajoules. | ||
| 199 | /// Requires EnergyPlus simulation output to calculate. | ||
| 200 | boost::optional<double> electricityHeatRejection() const; | ||
| 201 | |||
| 202 | /// Returns the electric energy used for humidification in gigajoules. | ||
| 203 | /// Requires EnergyPlus simulation output to calculate. | ||
| 204 | boost::optional<double> electricityHumidification() const; | ||
| 205 | |||
| 206 | /// Returns the electric energy used for heat recovery in gigajoules. | ||
| 207 | /// Requires EnergyPlus simulation output to calculate. | ||
| 208 | boost::optional<double> electricityHeatRecovery() const; | ||
| 209 | |||
| 210 | /// Returns the electric energy used for water systems in gigajoules. | ||
| 211 | /// Requires EnergyPlus simulation output to calculate. | ||
| 212 | boost::optional<double> electricityWaterSystems() const; | ||
| 213 | |||
| 214 | /// Returns the electric energy used for refrigeration in gigajoules. | ||
| 215 | /// Requires EnergyPlus simulation output to calculate. | ||
| 216 | boost::optional<double> electricityRefrigeration() const; | ||
| 217 | |||
| 218 | /// Returns the electric energy used for generators in gigajoules. | ||
| 219 | /// Requires EnergyPlus simulation output to calculate. | ||
| 220 | boost::optional<double> electricityGenerators() const; | ||
| 221 | |||
| 222 | /// Returns the electric energy used for all uses in gigajoules. | ||
| 223 | /// Requires EnergyPlus simulation output to calculate. | ||
| 224 | boost::optional<double> electricityTotalEndUses() const; | ||
| 225 | |||
| 226 | /// Returns the natural gas energy used for heating in gigajoules. | ||
| 227 | /// Requires EnergyPlus simulation output to calculate. | ||
| 228 | boost::optional<double> naturalGasHeating() const; | ||
| 229 | |||
| 230 | /// Returns the natural gas energy used for cooling in gigajoules. | ||
| 231 | /// Requires EnergyPlus simulation output to calculate. | ||
| 232 | boost::optional<double> naturalGasCooling() const; | ||
| 233 | |||
| 234 | /// Returns the natural gas energy used for interior lighting in gigajoules. | ||
| 235 | /// Requires EnergyPlus simulation output to calculate. | ||
| 236 | boost::optional<double> naturalGasInteriorLighting() const; | ||
| 237 | |||
| 238 | /// Returns the natural gas energy used for exterior lighting in gigajoules. | ||
| 239 | /// Requires EnergyPlus simulation output to calculate. | ||
| 240 | boost::optional<double> naturalGasExteriorLighting() const; | ||
| 241 | |||
| 242 | /// Returns the natural gas energy used for interior equipment in gigajoules. | ||
| 243 | /// Requires EnergyPlus simulation output to calculate. | ||
| 244 | boost::optional<double> naturalGasInteriorEquipment() const; | ||
| 245 | |||
| 246 | /// Returns the natural gas energy used for exterior equipment in gigajoules. | ||
| 247 | /// Requires EnergyPlus simulation output to calculate. | ||
| 248 | boost::optional<double> naturalGasExteriorEquipment() const; | ||
| 249 | |||
| 250 | /// Returns the natural gas energy used for fans in gigajoules. | ||
| 251 | /// Requires EnergyPlus simulation output to calculate. | ||
| 252 | boost::optional<double> naturalGasFans() const; | ||
| 253 | |||
| 254 | /// Returns the natural gas energy used for pumps in gigajoules. | ||
| 255 | /// Requires EnergyPlus simulation output to calculate. | ||
| 256 | boost::optional<double> naturalGasPumps() const; | ||
| 257 | |||
| 258 | /// Returns the natural gas energy used for heat rejection in gigajoules. | ||
| 259 | /// Requires EnergyPlus simulation output to calculate. | ||
| 260 | boost::optional<double> naturalGasHeatRejection() const; | ||
| 261 | |||
| 262 | /// Returns the natural gas energy used for humidification in gigajoules. | ||
| 263 | /// Requires EnergyPlus simulation output to calculate. | ||
| 264 | boost::optional<double> naturalGasHumidification() const; | ||
| 265 | |||
| 266 | /// Returns the natural gas energy used for heat recovery in gigajoules. | ||
| 267 | /// Requires EnergyPlus simulation output to calculate. | ||
| 268 | boost::optional<double> naturalGasHeatRecovery() const; | ||
| 269 | |||
| 270 | /// Returns the natural gas energy used for water systems in gigajoules. | ||
| 271 | /// Requires EnergyPlus simulation output to calculate. | ||
| 272 | boost::optional<double> naturalGasWaterSystems() const; | ||
| 273 | |||
| 274 | /// Returns the natural gas energy used for refrigeration in gigajoules. | ||
| 275 | /// Requires EnergyPlus simulation output to calculate. | ||
| 276 | boost::optional<double> naturalGasRefrigeration() const; | ||
| 277 | |||
| 278 | /// Returns the natural gas energy used for generators in gigajoules. | ||
| 279 | /// Requires EnergyPlus simulation output to calculate. | ||
| 280 | boost::optional<double> naturalGasGenerators() const; | ||
| 281 | |||
| 282 | /// Returns the natural gas energy used for all end uses in gigajoules. | ||
| 283 | /// Requires EnergyPlus simulation output to calculate. | ||
| 284 | boost::optional<double> naturalGasTotalEndUses() const; | ||
| 285 | |||
| 286 | /// Gasoline | ||
| 287 | /// Returns the energy used for heating from gasoline in gigajoules. | ||
| 288 | /// Requires EnergyPlus simulation output to calculate. | ||
| 289 | boost::optional<double> gasolineHeating() const; | ||
| 290 | |||
| 291 | /// Returns the energy used for cooling from gasoline in gigajoules. | ||
| 292 | /// Requires EnergyPlus simulation output to calculate. | ||
| 293 | boost::optional<double> gasolineCooling() const; | ||
| 294 | |||
| 295 | /// Returns the energy used for interior lighting from gasoline in gigajoules. | ||
| 296 | /// Requires EnergyPlus simulation output to calculate. | ||
| 297 | boost::optional<double> gasolineInteriorLighting() const; | ||
| 298 | |||
| 299 | /// Returns the energy used for exterior lighting from gasoline in gigajoules. | ||
| 300 | /// Requires EnergyPlus simulation output to calculate. | ||
| 301 | boost::optional<double> gasolineExteriorLighting() const; | ||
| 302 | |||
| 303 | /// Returns the energy used for interior equipment from gasoline in gigajoules. | ||
| 304 | /// Requires EnergyPlus simulation output to calculate. | ||
| 305 | boost::optional<double> gasolineInteriorEquipment() const; | ||
| 306 | |||
| 307 | /// Returns the energy used for exterior equipment from gasoline in gigajoules. | ||
| 308 | /// Requires EnergyPlus simulation output to calculate. | ||
| 309 | boost::optional<double> gasolineExteriorEquipment() const; | ||
| 310 | |||
| 311 | /// Returns the energy used for fans from gasoline in gigajoules. | ||
| 312 | /// Requires EnergyPlus simulation output to calculate. | ||
| 313 | boost::optional<double> gasolineFans() const; | ||
| 314 | |||
| 315 | /// Returns the energy used for pumps from gasoline in gigajoules. | ||
| 316 | /// Requires EnergyPlus simulation output to calculate. | ||
| 317 | boost::optional<double> gasolinePumps() const; | ||
| 318 | |||
| 319 | /// Returns the energy used for heat rejection from gasoline in gigajoules. | ||
| 320 | /// Requires EnergyPlus simulation output to calculate. | ||
| 321 | boost::optional<double> gasolineHeatRejection() const; | ||
| 322 | |||
| 323 | /// Returns the energy used for humidification from gasoline in gigajoules. | ||
| 324 | /// Requires EnergyPlus simulation output to calculate. | ||
| 325 | boost::optional<double> gasolineHumidification() const; | ||
| 326 | |||
| 327 | /// Returns the energy used for heat recovery from gasoline in gigajoules. | ||
| 328 | /// Requires EnergyPlus simulation output to calculate. | ||
| 329 | boost::optional<double> gasolineHeatRecovery() const; | ||
| 330 | |||
| 331 | /// Returns the energy used for water systems from gasoline in gigajoules. | ||
| 332 | /// Requires EnergyPlus simulation output to calculate. | ||
| 333 | boost::optional<double> gasolineWaterSystems() const; | ||
| 334 | |||
| 335 | /// Returns the energy used for refrigeration from gasoline in gigajoules. | ||
| 336 | /// Requires EnergyPlus simulation output to calculate. | ||
| 337 | boost::optional<double> gasolineRefrigeration() const; | ||
| 338 | |||
| 339 | /// Returns the energy used for generators from gasoline in gigajoules. | ||
| 340 | /// Requires EnergyPlus simulation output to calculate. | ||
| 341 | boost::optional<double> gasolineGenerators() const; | ||
| 342 | |||
| 343 | /// Returns the energy used for all end uses from gasoline in gigajoules. | ||
| 344 | /// Requires EnergyPlus simulation output to calculate. | ||
| 345 | boost::optional<double> gasolineTotalEndUses() const; | ||
| 346 | |||
| 347 | /// Diesel | ||
| 348 | /// Returns the energy used for heating from diesel in gigajoules. | ||
| 349 | /// Requires EnergyPlus simulation output to calculate. | ||
| 350 | boost::optional<double> dieselHeating() const; | ||
| 351 | |||
| 352 | /// Returns the energy used for cooling from diesel in gigajoules. | ||
| 353 | /// Requires EnergyPlus simulation output to calculate. | ||
| 354 | boost::optional<double> dieselCooling() const; | ||
| 355 | |||
| 356 | /// Returns the energy used for interior lighting from diesel in gigajoules. | ||
| 357 | /// Requires EnergyPlus simulation output to calculate. | ||
| 358 | boost::optional<double> dieselInteriorLighting() const; | ||
| 359 | |||
| 360 | /// Returns the energy used for exterior lighting from diesel in gigajoules. | ||
| 361 | /// Requires EnergyPlus simulation output to calculate. | ||
| 362 | boost::optional<double> dieselExteriorLighting() const; | ||
| 363 | |||
| 364 | /// Returns the energy used for interior equipment from diesel in gigajoules. | ||
| 365 | /// Requires EnergyPlus simulation output to calculate. | ||
| 366 | boost::optional<double> dieselInteriorEquipment() const; | ||
| 367 | |||
| 368 | /// Returns the energy used for exterior equipment from diesel in gigajoules. | ||
| 369 | /// Requires EnergyPlus simulation output to calculate. | ||
| 370 | boost::optional<double> dieselExteriorEquipment() const; | ||
| 371 | |||
| 372 | /// Returns the energy used for fans from diesel in gigajoules. | ||
| 373 | /// Requires EnergyPlus simulation output to calculate. | ||
| 374 | boost::optional<double> dieselFans() const; | ||
| 375 | |||
| 376 | /// Returns the energy used for pumps from diesel in gigajoules. | ||
| 377 | /// Requires EnergyPlus simulation output to calculate. | ||
| 378 | boost::optional<double> dieselPumps() const; | ||
| 379 | |||
| 380 | /// Returns the energy used for heat rejection from diesel in gigajoules. | ||
| 381 | /// Requires EnergyPlus simulation output to calculate. | ||
| 382 | boost::optional<double> dieselHeatRejection() const; | ||
| 383 | |||
| 384 | /// Returns the energy used for humidification from diesel in gigajoules. | ||
| 385 | /// Requires EnergyPlus simulation output to calculate. | ||
| 386 | boost::optional<double> dieselHumidification() const; | ||
| 387 | |||
| 388 | /// Returns the energy used for heat recovery from diesel in gigajoules. | ||
| 389 | /// Requires EnergyPlus simulation output to calculate. | ||
| 390 | boost::optional<double> dieselHeatRecovery() const; | ||
| 391 | |||
| 392 | /// Returns the energy used for water systems from diesel in gigajoules. | ||
| 393 | /// Requires EnergyPlus simulation output to calculate. | ||
| 394 | boost::optional<double> dieselWaterSystems() const; | ||
| 395 | |||
| 396 | /// Returns the energy used for refrigeration from diesel in gigajoules. | ||
| 397 | /// Requires EnergyPlus simulation output to calculate. | ||
| 398 | boost::optional<double> dieselRefrigeration() const; | ||
| 399 | |||
| 400 | /// Returns the energy used for generators from diesel in gigajoules. | ||
| 401 | /// Requires EnergyPlus simulation output to calculate. | ||
| 402 | boost::optional<double> dieselGenerators() const; | ||
| 403 | |||
| 404 | /// Returns the energy used for all end uses from diesel in gigajoules. | ||
| 405 | /// Requires EnergyPlus simulation output to calculate. | ||
| 406 | boost::optional<double> dieselTotalEndUses() const; | ||
| 407 | |||
| 408 | /// Coal | ||
| 409 | /// Returns the energy used for heating from coal in gigajoules. | ||
| 410 | /// Requires EnergyPlus simulation output to calculate. | ||
| 411 | boost::optional<double> coalHeating() const; | ||
| 412 | |||
| 413 | /// Returns the energy used for cooling from coal in gigajoules. | ||
| 414 | /// Requires EnergyPlus simulation output to calculate. | ||
| 415 | boost::optional<double> coalCooling() const; | ||
| 416 | |||
| 417 | /// Returns the energy used for interior lighting from coal in gigajoules. | ||
| 418 | /// Requires EnergyPlus simulation output to calculate. | ||
| 419 | boost::optional<double> coalInteriorLighting() const; | ||
| 420 | |||
| 421 | /// Returns the energy used for exterior lighting from coal in gigajoules. | ||
| 422 | /// Requires EnergyPlus simulation output to calculate. | ||
| 423 | boost::optional<double> coalExteriorLighting() const; | ||
| 424 | |||
| 425 | /// Returns the energy used for interior equipment from coal in gigajoules. | ||
| 426 | /// Requires EnergyPlus simulation output to calculate. | ||
| 427 | boost::optional<double> coalInteriorEquipment() const; | ||
| 428 | |||
| 429 | /// Returns the energy used for exterior equipment from coal in gigajoules. | ||
| 430 | /// Requires EnergyPlus simulation output to calculate. | ||
| 431 | boost::optional<double> coalExteriorEquipment() const; | ||
| 432 | |||
| 433 | /// Returns the energy used for fans from coal in gigajoules. | ||
| 434 | /// Requires EnergyPlus simulation output to calculate. | ||
| 435 | boost::optional<double> coalFans() const; | ||
| 436 | |||
| 437 | /// Returns the energy used for pumps from coal in gigajoules. | ||
| 438 | /// Requires EnergyPlus simulation output to calculate. | ||
| 439 | boost::optional<double> coalPumps() const; | ||
| 440 | |||
| 441 | /// Returns the energy used for heat rejection from coal in gigajoules. | ||
| 442 | /// Requires EnergyPlus simulation output to calculate. | ||
| 443 | boost::optional<double> coalHeatRejection() const; | ||
| 444 | |||
| 445 | /// Returns the energy used for humidification from coal in gigajoules. | ||
| 446 | /// Requires EnergyPlus simulation output to calculate. | ||
| 447 | boost::optional<double> coalHumidification() const; | ||
| 448 | |||
| 449 | /// Returns the energy used for heat recovery from coal in gigajoules. | ||
| 450 | /// Requires EnergyPlus simulation output to calculate. | ||
| 451 | boost::optional<double> coalHeatRecovery() const; | ||
| 452 | |||
| 453 | /// Returns the energy used for water systems from coal in gigajoules. | ||
| 454 | /// Requires EnergyPlus simulation output to calculate. | ||
| 455 | boost::optional<double> coalWaterSystems() const; | ||
| 456 | |||
| 457 | /// Returns the energy used for refrigeration from coal in gigajoules. | ||
| 458 | /// Requires EnergyPlus simulation output to calculate. | ||
| 459 | boost::optional<double> coalRefrigeration() const; | ||
| 460 | |||
| 461 | /// Returns the energy used for generators from coal in gigajoules. | ||
| 462 | /// Requires EnergyPlus simulation output to calculate. | ||
| 463 | boost::optional<double> coalGenerators() const; | ||
| 464 | |||
| 465 | /// Returns the energy used for all end uses from coal in gigajoules. | ||
| 466 | /// Requires EnergyPlus simulation output to calculate. | ||
| 467 | boost::optional<double> coalTotalEndUses() const; | ||
| 468 | |||
| 469 | /// Fuel Oil No 1 | ||
| 470 | /// Returns the energy used for heating from fuelOilNo1 in gigajoules. | ||
| 471 | /// Requires EnergyPlus simulation output to calculate. | ||
| 472 | boost::optional<double> fuelOilNo1Heating() const; | ||
| 473 | |||
| 474 | /// Returns the energy used for cooling from fuelOilNo1 in gigajoules. | ||
| 475 | /// Requires EnergyPlus simulation output to calculate. | ||
| 476 | boost::optional<double> fuelOilNo1Cooling() const; | ||
| 477 | |||
| 478 | /// Returns the energy used for interior lighting from fuelOilNo1 in gigajoules. | ||
| 479 | /// Requires EnergyPlus simulation output to calculate. | ||
| 480 | boost::optional<double> fuelOilNo1InteriorLighting() const; | ||
| 481 | |||
| 482 | /// Returns the energy used for exterior lighting from fuelOilNo1 in gigajoules. | ||
| 483 | /// Requires EnergyPlus simulation output to calculate. | ||
| 484 | boost::optional<double> fuelOilNo1ExteriorLighting() const; | ||
| 485 | |||
| 486 | /// Returns the energy used for interior equipment from fuelOilNo1 in gigajoules. | ||
| 487 | /// Requires EnergyPlus simulation output to calculate. | ||
| 488 | boost::optional<double> fuelOilNo1InteriorEquipment() const; | ||
| 489 | |||
| 490 | /// Returns the energy used for exterior equipment from fuelOilNo1 in gigajoules. | ||
| 491 | /// Requires EnergyPlus simulation output to calculate. | ||
| 492 | boost::optional<double> fuelOilNo1ExteriorEquipment() const; | ||
| 493 | |||
| 494 | /// Returns the energy used for fans from fuelOilNo1 in gigajoules. | ||
| 495 | /// Requires EnergyPlus simulation output to calculate. | ||
| 496 | boost::optional<double> fuelOilNo1Fans() const; | ||
| 497 | |||
| 498 | /// Returns the energy used for pumps from fuelOilNo1 in gigajoules. | ||
| 499 | /// Requires EnergyPlus simulation output to calculate. | ||
| 500 | boost::optional<double> fuelOilNo1Pumps() const; | ||
| 501 | |||
| 502 | /// Returns the energy used for heat rejection from fuelOilNo1 in gigajoules. | ||
| 503 | /// Requires EnergyPlus simulation output to calculate. | ||
| 504 | boost::optional<double> fuelOilNo1HeatRejection() const; | ||
| 505 | |||
| 506 | /// Returns the energy used for humidification from fuelOilNo1 in gigajoules. | ||
| 507 | /// Requires EnergyPlus simulation output to calculate. | ||
| 508 | boost::optional<double> fuelOilNo1Humidification() const; | ||
| 509 | |||
| 510 | /// Returns the energy used for heat recovery from fuelOilNo1 in gigajoules. | ||
| 511 | /// Requires EnergyPlus simulation output to calculate. | ||
| 512 | boost::optional<double> fuelOilNo1HeatRecovery() const; | ||
| 513 | |||
| 514 | /// Returns the energy used for water systems from fuelOilNo1 in gigajoules. | ||
| 515 | /// Requires EnergyPlus simulation output to calculate. | ||
| 516 | boost::optional<double> fuelOilNo1WaterSystems() const; | ||
| 517 | |||
| 518 | /// Returns the energy used for refrigeration from fuelOilNo1 in gigajoules. | ||
| 519 | /// Requires EnergyPlus simulation output to calculate. | ||
| 520 | boost::optional<double> fuelOilNo1Refrigeration() const; | ||
| 521 | |||
| 522 | /// Returns the energy used for generators from fuelOilNo1 in gigajoules. | ||
| 523 | /// Requires EnergyPlus simulation output to calculate. | ||
| 524 | boost::optional<double> fuelOilNo1Generators() const; | ||
| 525 | |||
| 526 | /// Returns the energy used for all end uses from fuelOilNo1 in gigajoules. | ||
| 527 | /// Requires EnergyPlus simulation output to calculate. | ||
| 528 | boost::optional<double> fuelOilNo1TotalEndUses() const; | ||
| 529 | |||
| 530 | /// Fuel Oil No 2 | ||
| 531 | /// Returns the energy used for heating from fuelOilNo2 in gigajoules. | ||
| 532 | /// Requires EnergyPlus simulation output to calculate. | ||
| 533 | boost::optional<double> fuelOilNo2Heating() const; | ||
| 534 | |||
| 535 | /// Returns the energy used for cooling from fuelOilNo2 in gigajoules. | ||
| 536 | /// Requires EnergyPlus simulation output to calculate. | ||
| 537 | boost::optional<double> fuelOilNo2Cooling() const; | ||
| 538 | |||
| 539 | /// Returns the energy used for interior lighting from fuelOilNo2 in gigajoules. | ||
| 540 | /// Requires EnergyPlus simulation output to calculate. | ||
| 541 | boost::optional<double> fuelOilNo2InteriorLighting() const; | ||
| 542 | |||
| 543 | /// Returns the energy used for exterior lighting from fuelOilNo2 in gigajoules. | ||
| 544 | /// Requires EnergyPlus simulation output to calculate. | ||
| 545 | boost::optional<double> fuelOilNo2ExteriorLighting() const; | ||
| 546 | |||
| 547 | /// Returns the energy used for interior equipment from fuelOilNo2 in gigajoules. | ||
| 548 | /// Requires EnergyPlus simulation output to calculate. | ||
| 549 | boost::optional<double> fuelOilNo2InteriorEquipment() const; | ||
| 550 | |||
| 551 | /// Returns the energy used for exterior equipment from fuelOilNo2 in gigajoules. | ||
| 552 | /// Requires EnergyPlus simulation output to calculate. | ||
| 553 | boost::optional<double> fuelOilNo2ExteriorEquipment() const; | ||
| 554 | |||
| 555 | /// Returns the energy used for fans from fuelOilNo2 in gigajoules. | ||
| 556 | /// Requires EnergyPlus simulation output to calculate. | ||
| 557 | boost::optional<double> fuelOilNo2Fans() const; | ||
| 558 | |||
| 559 | /// Returns the energy used for pumps from fuelOilNo2 in gigajoules. | ||
| 560 | /// Requires EnergyPlus simulation output to calculate. | ||
| 561 | boost::optional<double> fuelOilNo2Pumps() const; | ||
| 562 | |||
| 563 | /// Returns the energy used for heat rejection from fuelOilNo2 in gigajoules. | ||
| 564 | /// Requires EnergyPlus simulation output to calculate. | ||
| 565 | boost::optional<double> fuelOilNo2HeatRejection() const; | ||
| 566 | |||
| 567 | /// Returns the energy used for humidification from fuelOilNo2 in gigajoules. | ||
| 568 | /// Requires EnergyPlus simulation output to calculate. | ||
| 569 | boost::optional<double> fuelOilNo2Humidification() const; | ||
| 570 | |||
| 571 | /// Returns the energy used for heat recovery from fuelOilNo2 in gigajoules. | ||
| 572 | /// Requires EnergyPlus simulation output to calculate. | ||
| 573 | boost::optional<double> fuelOilNo2HeatRecovery() const; | ||
| 574 | |||
| 575 | /// Returns the energy used for water systems from fuelOilNo2 in gigajoules. | ||
| 576 | /// Requires EnergyPlus simulation output to calculate. | ||
| 577 | boost::optional<double> fuelOilNo2WaterSystems() const; | ||
| 578 | |||
| 579 | /// Returns the energy used for refrigeration from fuelOilNo2 in gigajoules. | ||
| 580 | /// Requires EnergyPlus simulation output to calculate. | ||
| 581 | boost::optional<double> fuelOilNo2Refrigeration() const; | ||
| 582 | |||
| 583 | /// Returns the energy used for generators from fuelOilNo2 in gigajoules. | ||
| 584 | /// Requires EnergyPlus simulation output to calculate. | ||
| 585 | boost::optional<double> fuelOilNo2Generators() const; | ||
| 586 | |||
| 587 | /// Returns the energy used for all end uses from fuelOilNo2 in gigajoules. | ||
| 588 | /// Requires EnergyPlus simulation output to calculate. | ||
| 589 | boost::optional<double> fuelOilNo2TotalEndUses() const; | ||
| 590 | |||
| 591 | /// Propane | ||
| 592 | /// Returns the energy used for heating from propane in gigajoules. | ||
| 593 | /// Requires EnergyPlus simulation output to calculate. | ||
| 594 | boost::optional<double> propaneHeating() const; | ||
| 595 | |||
| 596 | /// Returns the energy used for cooling from propane in gigajoules. | ||
| 597 | /// Requires EnergyPlus simulation output to calculate. | ||
| 598 | boost::optional<double> propaneCooling() const; | ||
| 599 | |||
| 600 | /// Returns the energy used for interior lighting from propane in gigajoules. | ||
| 601 | /// Requires EnergyPlus simulation output to calculate. | ||
| 602 | boost::optional<double> propaneInteriorLighting() const; | ||
| 603 | |||
| 604 | /// Returns the energy used for exterior lighting from propane in gigajoules. | ||
| 605 | /// Requires EnergyPlus simulation output to calculate. | ||
| 606 | boost::optional<double> propaneExteriorLighting() const; | ||
| 607 | |||
| 608 | /// Returns the energy used for interior equipment from propane in gigajoules. | ||
| 609 | /// Requires EnergyPlus simulation output to calculate. | ||
| 610 | boost::optional<double> propaneInteriorEquipment() const; | ||
| 611 | |||
| 612 | /// Returns the energy used for exterior equipment from propane in gigajoules. | ||
| 613 | /// Requires EnergyPlus simulation output to calculate. | ||
| 614 | boost::optional<double> propaneExteriorEquipment() const; | ||
| 615 | |||
| 616 | /// Returns the energy used for fans from propane in gigajoules. | ||
| 617 | /// Requires EnergyPlus simulation output to calculate. | ||
| 618 | boost::optional<double> propaneFans() const; | ||
| 619 | |||
| 620 | /// Returns the energy used for pumps from propane in gigajoules. | ||
| 621 | /// Requires EnergyPlus simulation output to calculate. | ||
| 622 | boost::optional<double> propanePumps() const; | ||
| 623 | |||
| 624 | /// Returns the energy used for heat rejection from propane in gigajoules. | ||
| 625 | /// Requires EnergyPlus simulation output to calculate. | ||
| 626 | boost::optional<double> propaneHeatRejection() const; | ||
| 627 | |||
| 628 | /// Returns the energy used for humidification from propane in gigajoules. | ||
| 629 | /// Requires EnergyPlus simulation output to calculate. | ||
| 630 | boost::optional<double> propaneHumidification() const; | ||
| 631 | |||
| 632 | /// Returns the energy used for heat recovery from propane in gigajoules. | ||
| 633 | /// Requires EnergyPlus simulation output to calculate. | ||
| 634 | boost::optional<double> propaneHeatRecovery() const; | ||
| 635 | |||
| 636 | /// Returns the energy used for water systems from propane in gigajoules. | ||
| 637 | /// Requires EnergyPlus simulation output to calculate. | ||
| 638 | boost::optional<double> propaneWaterSystems() const; | ||
| 639 | |||
| 640 | /// Returns the energy used for refrigeration from propane in gigajoules. | ||
| 641 | /// Requires EnergyPlus simulation output to calculate. | ||
| 642 | boost::optional<double> propaneRefrigeration() const; | ||
| 643 | |||
| 644 | /// Returns the energy used for generators from propane in gigajoules. | ||
| 645 | /// Requires EnergyPlus simulation output to calculate. | ||
| 646 | boost::optional<double> propaneGenerators() const; | ||
| 647 | |||
| 648 | /// Returns the energy used for all end uses from propane in gigajoules. | ||
| 649 | /// Requires EnergyPlus simulation output to calculate. | ||
| 650 | boost::optional<double> propaneTotalEndUses() const; | ||
| 651 | |||
| 652 | /// Other Fuel 1 | ||
| 653 | /// Returns the energy used for heating from otherFuel1 in gigajoules. | ||
| 654 | /// Requires EnergyPlus simulation output to calculate. | ||
| 655 | boost::optional<double> otherFuel1Heating() const; | ||
| 656 | |||
| 657 | /// Returns the energy used for cooling from otherFuel1 in gigajoules. | ||
| 658 | /// Requires EnergyPlus simulation output to calculate. | ||
| 659 | boost::optional<double> otherFuel1Cooling() const; | ||
| 660 | |||
| 661 | /// Returns the energy used for interior lighting from otherFuel1 in gigajoules. | ||
| 662 | /// Requires EnergyPlus simulation output to calculate. | ||
| 663 | boost::optional<double> otherFuel1InteriorLighting() const; | ||
| 664 | |||
| 665 | /// Returns the energy used for exterior lighting from otherFuel1 in gigajoules. | ||
| 666 | /// Requires EnergyPlus simulation output to calculate. | ||
| 667 | boost::optional<double> otherFuel1ExteriorLighting() const; | ||
| 668 | |||
| 669 | /// Returns the energy used for interior equipment from otherFuel1 in gigajoules. | ||
| 670 | /// Requires EnergyPlus simulation output to calculate. | ||
| 671 | boost::optional<double> otherFuel1InteriorEquipment() const; | ||
| 672 | |||
| 673 | /// Returns the energy used for exterior equipment from otherFuel1 in gigajoules. | ||
| 674 | /// Requires EnergyPlus simulation output to calculate. | ||
| 675 | boost::optional<double> otherFuel1ExteriorEquipment() const; | ||
| 676 | |||
| 677 | /// Returns the energy used for fans from otherFuel1 in gigajoules. | ||
| 678 | /// Requires EnergyPlus simulation output to calculate. | ||
| 679 | boost::optional<double> otherFuel1Fans() const; | ||
| 680 | |||
| 681 | /// Returns the energy used for pumps from otherFuel1 in gigajoules. | ||
| 682 | /// Requires EnergyPlus simulation output to calculate. | ||
| 683 | boost::optional<double> otherFuel1Pumps() const; | ||
| 684 | |||
| 685 | /// Returns the energy used for heat rejection from otherFuel1 in gigajoules. | ||
| 686 | /// Requires EnergyPlus simulation output to calculate. | ||
| 687 | boost::optional<double> otherFuel1HeatRejection() const; | ||
| 688 | |||
| 689 | /// Returns the energy used for humidification from otherFuel1 in gigajoules. | ||
| 690 | /// Requires EnergyPlus simulation output to calculate. | ||
| 691 | boost::optional<double> otherFuel1Humidification() const; | ||
| 692 | |||
| 693 | /// Returns the energy used for heat recovery from otherFuel1 in gigajoules. | ||
| 694 | /// Requires EnergyPlus simulation output to calculate. | ||
| 695 | boost::optional<double> otherFuel1HeatRecovery() const; | ||
| 696 | |||
| 697 | /// Returns the energy used for water systems from otherFuel1 in gigajoules. | ||
| 698 | /// Requires EnergyPlus simulation output to calculate. | ||
| 699 | boost::optional<double> otherFuel1WaterSystems() const; | ||
| 700 | |||
| 701 | /// Returns the energy used for refrigeration from otherFuel1 in gigajoules. | ||
| 702 | /// Requires EnergyPlus simulation output to calculate. | ||
| 703 | boost::optional<double> otherFuel1Refrigeration() const; | ||
| 704 | |||
| 705 | /// Returns the energy used for generators from otherFuel1 in gigajoules. | ||
| 706 | /// Requires EnergyPlus simulation output to calculate. | ||
| 707 | boost::optional<double> otherFuel1Generators() const; | ||
| 708 | |||
| 709 | /// Returns the energy used for all end uses from otherFuel1 in gigajoules. | ||
| 710 | /// Requires EnergyPlus simulation output to calculate. | ||
| 711 | boost::optional<double> otherFuel1TotalEndUses() const; | ||
| 712 | |||
| 713 | /// Other Fuel 2 | ||
| 714 | /// Returns the energy used for heating from otherFuel2 in gigajoules. | ||
| 715 | /// Requires EnergyPlus simulation output to calculate. | ||
| 716 | boost::optional<double> otherFuel2Heating() const; | ||
| 717 | |||
| 718 | /// Returns the energy used for cooling from otherFuel2 in gigajoules. | ||
| 719 | /// Requires EnergyPlus simulation output to calculate. | ||
| 720 | boost::optional<double> otherFuel2Cooling() const; | ||
| 721 | |||
| 722 | /// Returns the energy used for interior lighting from otherFuel2 in gigajoules. | ||
| 723 | /// Requires EnergyPlus simulation output to calculate. | ||
| 724 | boost::optional<double> otherFuel2InteriorLighting() const; | ||
| 725 | |||
| 726 | /// Returns the energy used for exterior lighting from otherFuel2 in gigajoules. | ||
| 727 | /// Requires EnergyPlus simulation output to calculate. | ||
| 728 | boost::optional<double> otherFuel2ExteriorLighting() const; | ||
| 729 | |||
| 730 | /// Returns the energy used for interior equipment from otherFuel2 in gigajoules. | ||
| 731 | /// Requires EnergyPlus simulation output to calculate. | ||
| 732 | boost::optional<double> otherFuel2InteriorEquipment() const; | ||
| 733 | |||
| 734 | /// Returns the energy used for exterior equipment from otherFuel2 in gigajoules. | ||
| 735 | /// Requires EnergyPlus simulation output to calculate. | ||
| 736 | boost::optional<double> otherFuel2ExteriorEquipment() const; | ||
| 737 | |||
| 738 | /// Returns the energy used for fans from otherFuel2 in gigajoules. | ||
| 739 | /// Requires EnergyPlus simulation output to calculate. | ||
| 740 | boost::optional<double> otherFuel2Fans() const; | ||
| 741 | |||
| 742 | /// Returns the energy used for pumps from otherFuel2 in gigajoules. | ||
| 743 | /// Requires EnergyPlus simulation output to calculate. | ||
| 744 | boost::optional<double> otherFuel2Pumps() const; | ||
| 745 | |||
| 746 | /// Returns the energy used for heat rejection from otherFuel2 in gigajoules. | ||
| 747 | /// Requires EnergyPlus simulation output to calculate. | ||
| 748 | boost::optional<double> otherFuel2HeatRejection() const; | ||
| 749 | |||
| 750 | /// Returns the energy used for humidification from otherFuel2 in gigajoules. | ||
| 751 | /// Requires EnergyPlus simulation output to calculate. | ||
| 752 | boost::optional<double> otherFuel2Humidification() const; | ||
| 753 | |||
| 754 | /// Returns the energy used for heat recovery from otherFuel2 in gigajoules. | ||
| 755 | /// Requires EnergyPlus simulation output to calculate. | ||
| 756 | boost::optional<double> otherFuel2HeatRecovery() const; | ||
| 757 | |||
| 758 | /// Returns the energy used for water systems from otherFuel2 in gigajoules. | ||
| 759 | /// Requires EnergyPlus simulation output to calculate. | ||
| 760 | boost::optional<double> otherFuel2WaterSystems() const; | ||
| 761 | |||
| 762 | /// Returns the energy used for refrigeration from otherFuel2 in gigajoules. | ||
| 763 | /// Requires EnergyPlus simulation output to calculate. | ||
| 764 | boost::optional<double> otherFuel2Refrigeration() const; | ||
| 765 | |||
| 766 | /// Returns the energy used for generators from otherFuel2 in gigajoules. | ||
| 767 | /// Requires EnergyPlus simulation output to calculate. | ||
| 768 | boost::optional<double> otherFuel2Generators() const; | ||
| 769 | |||
| 770 | /// Returns the energy used for all end uses from otherFuel2 in gigajoules. | ||
| 771 | /// Requires EnergyPlus simulation output to calculate. | ||
| 772 | boost::optional<double> otherFuel2TotalEndUses() const; | ||
| 773 | |||
| 774 | /// Returns the district cooling energy used for heating in gigajoules. | ||
| 775 | /// Requires EnergyPlus simulation output to calculate. | ||
| 776 | boost::optional<double> districtCoolingHeating() const; | ||
| 777 | |||
| 778 | /// Returns the district cooling energy used for cooling in gigajoules. | ||
| 779 | /// Requires EnergyPlus simulation output to calculate. | ||
| 780 | boost::optional<double> districtCoolingCooling() const; | ||
| 781 | |||
| 782 | /// Returns the district cooling energy used for interior lighting in gigajoules. | ||
| 783 | /// Requires EnergyPlus simulation output to calculate. | ||
| 784 | boost::optional<double> districtCoolingInteriorLighting() const; | ||
| 785 | |||
| 786 | /// Returns the district cooling energy used for exterior lighting in gigajoules. | ||
| 787 | /// Requires EnergyPlus simulation output to calculate. | ||
| 788 | boost::optional<double> districtCoolingExteriorLighting() const; | ||
| 789 | |||
| 790 | /// Returns the district cooling energy used for interior equipment in gigajoules. | ||
| 791 | /// Requires EnergyPlus simulation output to calculate. | ||
| 792 | boost::optional<double> districtCoolingInteriorEquipment() const; | ||
| 793 | |||
| 794 | /// Returns the district cooling energy used for exterior equipment in gigajoules. | ||
| 795 | /// Requires EnergyPlus simulation output to calculate. | ||
| 796 | boost::optional<double> districtCoolingExteriorEquipment() const; | ||
| 797 | |||
| 798 | /// Returns the district cooling energy used for fans in gigajoules. | ||
| 799 | /// Requires EnergyPlus simulation output to calculate. | ||
| 800 | boost::optional<double> districtCoolingFans() const; | ||
| 801 | |||
| 802 | /// Returns the district cooling energy used for pumps in gigajoules. | ||
| 803 | /// Requires EnergyPlus simulation output to calculate. | ||
| 804 | boost::optional<double> districtCoolingPumps() const; | ||
| 805 | |||
| 806 | /// Returns the district cooling energy used for heat rejection in gigajoules. | ||
| 807 | /// Requires EnergyPlus simulation output to calculate. | ||
| 808 | boost::optional<double> districtCoolingHeatRejection() const; | ||
| 809 | |||
| 810 | /// Returns the district cooling energy used for humidification in gigajoules. | ||
| 811 | /// Requires EnergyPlus simulation output to calculate. | ||
| 812 | boost::optional<double> districtCoolingHumidification() const; | ||
| 813 | |||
| 814 | /// Returns the district cooling energy used for heat recovery in gigajoules. | ||
| 815 | /// Requires EnergyPlus simulation output to calculate. | ||
| 816 | boost::optional<double> districtCoolingHeatRecovery() const; | ||
| 817 | |||
| 818 | /// Returns the district cooling energy used for water systems in gigajoules. | ||
| 819 | /// Requires EnergyPlus simulation output to calculate. | ||
| 820 | boost::optional<double> districtCoolingWaterSystems() const; | ||
| 821 | |||
| 822 | /// Returns the district cooling energy used for refrigeration in gigajoules. | ||
| 823 | /// Requires EnergyPlus simulation output to calculate. | ||
| 824 | boost::optional<double> districtCoolingRefrigeration() const; | ||
| 825 | |||
| 826 | /// Returns the district cooling energy used for generators in gigajoules. | ||
| 827 | /// Requires EnergyPlus simulation output to calculate. | ||
| 828 | boost::optional<double> districtCoolingGenerators() const; | ||
| 829 | |||
| 830 | /// Returns the district cooling energy used for all end uses in gigajoules. | ||
| 831 | /// Requires EnergyPlus simulation output to calculate. | ||
| 832 | boost::optional<double> districtCoolingTotalEndUses() const; | ||
| 833 | |||
| 834 | /// Returns the district heating energy used for heating in gigajoules. | ||
| 835 | /// Requires EnergyPlus simulation output to calculate. | ||
| 836 | boost::optional<double> districtHeatingHeating() const; | ||
| 837 | |||
| 838 | /// Returns the district heating energy used for cooling in gigajoules. | ||
| 839 | /// Requires EnergyPlus simulation output to calculate. | ||
| 840 | boost::optional<double> districtHeatingCooling() const; | ||
| 841 | |||
| 842 | /// Returns the district heating energy used for interior lighting in gigajoules. | ||
| 843 | /// Requires EnergyPlus simulation output to calculate. | ||
| 844 | boost::optional<double> districtHeatingInteriorLighting() const; | ||
| 845 | |||
| 846 | /// Returns the district heating energy used for exterior lighting in gigajoules. | ||
| 847 | /// Requires EnergyPlus simulation output to calculate. | ||
| 848 | boost::optional<double> districtHeatingExteriorLighting() const; | ||
| 849 | |||
| 850 | /// Returns the district heating energy used for interior equipment in gigajoules. | ||
| 851 | /// Requires EnergyPlus simulation output to calculate. | ||
| 852 | boost::optional<double> districtHeatingInteriorEquipment() const; | ||
| 853 | |||
| 854 | /// Returns the district heating energy used for exterior equipment in gigajoules. | ||
| 855 | /// Requires EnergyPlus simulation output to calculate. | ||
| 856 | boost::optional<double> districtHeatingExteriorEquipment() const; | ||
| 857 | |||
| 858 | /// Returns the district heating energy used for fans in gigajoules. | ||
| 859 | /// Requires EnergyPlus simulation output to calculate. | ||
| 860 | boost::optional<double> districtHeatingFans() const; | ||
| 861 | |||
| 862 | /// Returns the district heating energy used for pumps in gigajoules. | ||
| 863 | /// Requires EnergyPlus simulation output to calculate. | ||
| 864 | boost::optional<double> districtHeatingPumps() const; | ||
| 865 | |||
| 866 | /// Returns the district heating energy used for heat rejection in gigajoules. | ||
| 867 | /// Requires EnergyPlus simulation output to calculate. | ||
| 868 | boost::optional<double> districtHeatingHeatRejection() const; | ||
| 869 | |||
| 870 | /// Returns the district heating energy used for humidification in gigajoules. | ||
| 871 | /// Requires EnergyPlus simulation output to calculate. | ||
| 872 | boost::optional<double> districtHeatingHumidification() const; | ||
| 873 | |||
| 874 | /// Returns the district heating energy used for heat recovery in gigajoules. | ||
| 875 | /// Requires EnergyPlus simulation output to calculate. | ||
| 876 | boost::optional<double> districtHeatingHeatRecovery() const; | ||
| 877 | |||
| 878 | /// Returns the district heating energy used for water systems in gigajoules. | ||
| 879 | /// Requires EnergyPlus simulation output to calculate. | ||
| 880 | boost::optional<double> districtHeatingWaterSystems() const; | ||
| 881 | |||
| 882 | /// Returns the district heating energy used for refrigeration in gigajoules. | ||
| 883 | /// Requires EnergyPlus simulation output to calculate. | ||
| 884 | boost::optional<double> districtHeatingRefrigeration() const; | ||
| 885 | |||
| 886 | /// Returns the district heating energy used for generators in gigajoules. | ||
| 887 | /// Requires EnergyPlus simulation output to calculate. | ||
| 888 | boost::optional<double> districtHeatingGenerators() const; | ||
| 889 | |||
| 890 | /// Returns the district heating energy used for all end uses in gigajoules. | ||
| 891 | /// Requires EnergyPlus simulation output to calculate. | ||
| 892 | boost::optional<double> districtHeatingTotalEndUses() const; | ||
| 893 | |||
| 894 | /// Returns the district heating water energy used for heating in gigajoules. | ||
| 895 | /// Requires EnergyPlus simulation output to calculate. | ||
| 896 | boost::optional<double> districtHeatingWaterHeating() const; | ||
| 897 | |||
| 898 | /// Returns the district heating water energy used for cooling in gigajoules. | ||
| 899 | /// Requires EnergyPlus simulation output to calculate. | ||
| 900 | boost::optional<double> districtHeatingWaterCooling() const; | ||
| 901 | |||
| 902 | /// Returns the district heating water energy used for interior lighting in gigajoules. | ||
| 903 | /// Requires EnergyPlus simulation output to calculate. | ||
| 904 | boost::optional<double> districtHeatingWaterInteriorLighting() const; | ||
| 905 | |||
| 906 | /// Returns the district heating water energy used for exterior lighting in gigajoules. | ||
| 907 | /// Requires EnergyPlus simulation output to calculate. | ||
| 908 | boost::optional<double> districtHeatingWaterExteriorLighting() const; | ||
| 909 | |||
| 910 | /// Returns the district heating water energy used for interior equipment in gigajoules. | ||
| 911 | /// Requires EnergyPlus simulation output to calculate. | ||
| 912 | boost::optional<double> districtHeatingWaterInteriorEquipment() const; | ||
| 913 | |||
| 914 | /// Returns the district heating water energy used for exterior equipment in gigajoules. | ||
| 915 | /// Requires EnergyPlus simulation output to calculate. | ||
| 916 | boost::optional<double> districtHeatingWaterExteriorEquipment() const; | ||
| 917 | |||
| 918 | /// Returns the district heating water energy used for fans in gigajoules. | ||
| 919 | /// Requires EnergyPlus simulation output to calculate. | ||
| 920 | boost::optional<double> districtHeatingWaterFans() const; | ||
| 921 | |||
| 922 | /// Returns the district heating water energy used for pumps in gigajoules. | ||
| 923 | /// Requires EnergyPlus simulation output to calculate. | ||
| 924 | boost::optional<double> districtHeatingWaterPumps() const; | ||
| 925 | |||
| 926 | /// Returns the district heating water energy used for heat rejection in gigajoules. | ||
| 927 | /// Requires EnergyPlus simulation output to calculate. | ||
| 928 | boost::optional<double> districtHeatingWaterHeatRejection() const; | ||
| 929 | |||
| 930 | /// Returns the district heating water energy used for humidification in gigajoules. | ||
| 931 | /// Requires EnergyPlus simulation output to calculate. | ||
| 932 | boost::optional<double> districtHeatingWaterHumidification() const; | ||
| 933 | |||
| 934 | /// Returns the district heating water energy used for heat recovery in gigajoules. | ||
| 935 | /// Requires EnergyPlus simulation output to calculate. | ||
| 936 | boost::optional<double> districtHeatingWaterHeatRecovery() const; | ||
| 937 | |||
| 938 | /// Returns the district heating water energy used for water systems in gigajoules. | ||
| 939 | /// Requires EnergyPlus simulation output to calculate. | ||
| 940 | boost::optional<double> districtHeatingWaterWaterSystems() const; | ||
| 941 | |||
| 942 | /// Returns the district heating water energy used for refrigeration in gigajoules. | ||
| 943 | /// Requires EnergyPlus simulation output to calculate. | ||
| 944 | boost::optional<double> districtHeatingWaterRefrigeration() const; | ||
| 945 | |||
| 946 | /// Returns the district heating water energy used for generators in gigajoules. | ||
| 947 | /// Requires EnergyPlus simulation output to calculate. | ||
| 948 | boost::optional<double> districtHeatingWaterGenerators() const; | ||
| 949 | |||
| 950 | /// Returns the district heating water energy used for all end uses in gigajoules. | ||
| 951 | /// Requires EnergyPlus simulation output to calculate. | ||
| 952 | boost::optional<double> districtHeatingWaterTotalEndUses() const; | ||
| 953 | |||
| 954 | /// Returns the district heating steam energy used for heating in gigajoules. | ||
| 955 | /// Requires EnergyPlus simulation output to calculate. | ||
| 956 | boost::optional<double> districtHeatingSteamHeating() const; | ||
| 957 | |||
| 958 | /// Returns the district heating steam energy used for cooling in gigajoules. | ||
| 959 | /// Requires EnergyPlus simulation output to calculate. | ||
| 960 | boost::optional<double> districtHeatingSteamCooling() const; | ||
| 961 | |||
| 962 | /// Returns the district heating steam energy used for interior lighting in gigajoules. | ||
| 963 | /// Requires EnergyPlus simulation output to calculate. | ||
| 964 | boost::optional<double> districtHeatingSteamInteriorLighting() const; | ||
| 965 | |||
| 966 | /// Returns the district heating steam energy used for exterior lighting in gigajoules. | ||
| 967 | /// Requires EnergyPlus simulation output to calculate. | ||
| 968 | boost::optional<double> districtHeatingSteamExteriorLighting() const; | ||
| 969 | |||
| 970 | /// Returns the district heating steam energy used for interior equipment in gigajoules. | ||
| 971 | /// Requires EnergyPlus simulation output to calculate. | ||
| 972 | boost::optional<double> districtHeatingSteamInteriorEquipment() const; | ||
| 973 | |||
| 974 | /// Returns the district heating steam energy used for exterior equipment in gigajoules. | ||
| 975 | /// Requires EnergyPlus simulation output to calculate. | ||
| 976 | boost::optional<double> districtHeatingSteamExteriorEquipment() const; | ||
| 977 | |||
| 978 | /// Returns the district heating steam energy used for fans in gigajoules. | ||
| 979 | /// Requires EnergyPlus simulation output to calculate. | ||
| 980 | boost::optional<double> districtHeatingSteamFans() const; | ||
| 981 | |||
| 982 | /// Returns the district heating steam energy used for pumps in gigajoules. | ||
| 983 | /// Requires EnergyPlus simulation output to calculate. | ||
| 984 | boost::optional<double> districtHeatingSteamPumps() const; | ||
| 985 | |||
| 986 | /// Returns the district heating steam energy used for heat rejection in gigajoules. | ||
| 987 | /// Requires EnergyPlus simulation output to calculate. | ||
| 988 | boost::optional<double> districtHeatingSteamHeatRejection() const; | ||
| 989 | |||
| 990 | /// Returns the district heating steam energy used for humidification in gigajoules. | ||
| 991 | /// Requires EnergyPlus simulation output to calculate. | ||
| 992 | boost::optional<double> districtHeatingSteamHumidification() const; | ||
| 993 | |||
| 994 | /// Returns the district heating steam energy used for heat recovery in gigajoules. | ||
| 995 | /// Requires EnergyPlus simulation output to calculate. | ||
| 996 | boost::optional<double> districtHeatingSteamHeatRecovery() const; | ||
| 997 | |||
| 998 | /// Returns the district heating steam energy used for water systems in gigajoules. | ||
| 999 | /// Requires EnergyPlus simulation output to calculate. | ||
| 1000 | boost::optional<double> districtHeatingSteamWaterSystems() const; | ||
| 1001 | |||
| 1002 | /// Returns the district heating steam energy used for refrigeration in gigajoules. | ||
| 1003 | /// Requires EnergyPlus simulation output to calculate. | ||
| 1004 | boost::optional<double> districtHeatingSteamRefrigeration() const; | ||
| 1005 | |||
| 1006 | /// Returns the district heating steam energy used for generators in gigajoules. | ||
| 1007 | /// Requires EnergyPlus simulation output to calculate. | ||
| 1008 | boost::optional<double> districtHeatingSteamGenerators() const; | ||
| 1009 | |||
| 1010 | /// Returns the district heating steam energy used for all end uses in gigajoules. | ||
| 1011 | /// Requires EnergyPlus simulation output to calculate. | ||
| 1012 | boost::optional<double> districtHeatingSteamTotalEndUses() const; | ||
| 1013 | |||
| 1014 | /// Returns the water used for heating in cubic meters. | ||
| 1015 | /// Requires EnergyPlus simulation output to calculate. | ||
| 1016 | boost::optional<double> waterHeating() const; | ||
| 1017 | |||
| 1018 | /// Returns the water used for cooling in cubic meters. | ||
| 1019 | /// Requires EnergyPlus simulation output to calculate. | ||
| 1020 | boost::optional<double> waterCooling() const; | ||
| 1021 | |||
| 1022 | /// Returns the water used for interior lighting in cubic meters. | ||
| 1023 | /// Requires EnergyPlus simulation output to calculate. | ||
| 1024 | boost::optional<double> waterInteriorLighting() const; | ||
| 1025 | |||
| 1026 | /// Returns the water used for exterior lighting in cubic meters. | ||
| 1027 | /// Requires EnergyPlus simulation output to calculate. | ||
| 1028 | boost::optional<double> waterExteriorLighting() const; | ||
| 1029 | |||
| 1030 | /// Returns the water used for interior equipment in cubic meters. | ||
| 1031 | /// Requires EnergyPlus simulation output to calculate. | ||
| 1032 | boost::optional<double> waterInteriorEquipment() const; | ||
| 1033 | |||
| 1034 | /// Returns the water used for exterior equipment in cubic meters. | ||
| 1035 | /// Requires EnergyPlus simulation output to calculate. | ||
| 1036 | boost::optional<double> waterExteriorEquipment() const; | ||
| 1037 | |||
| 1038 | /// Returns the water used for fans in cubic meters. | ||
| 1039 | /// Requires EnergyPlus simulation output to calculate. | ||
| 1040 | boost::optional<double> waterFans() const; | ||
| 1041 | |||
| 1042 | /// Returns the water used for pumps in cubic meters. | ||
| 1043 | /// Requires EnergyPlus simulation output to calculate. | ||
| 1044 | boost::optional<double> waterPumps() const; | ||
| 1045 | |||
| 1046 | /// Returns the water used for heat rejection in cubic meters. | ||
| 1047 | /// Requires EnergyPlus simulation output to calculate. | ||
| 1048 | boost::optional<double> waterHeatRejection() const; | ||
| 1049 | |||
| 1050 | /// Returns the water used for humidification in cubic meters. | ||
| 1051 | /// Requires EnergyPlus simulation output to calculate. | ||
| 1052 | boost::optional<double> waterHumidification() const; | ||
| 1053 | |||
| 1054 | /// Returns the water used for heat recovery in cubic meters. | ||
| 1055 | /// Requires EnergyPlus simulation output to calculate. | ||
| 1056 | boost::optional<double> waterHeatRecovery() const; | ||
| 1057 | |||
| 1058 | /// Returns the water used for water systems in cubic meters. | ||
| 1059 | /// Requires EnergyPlus simulation output to calculate. | ||
| 1060 | boost::optional<double> waterWaterSystems() const; | ||
| 1061 | |||
| 1062 | /// Returns the water used for refrigeration in cubic meters. | ||
| 1063 | /// Requires EnergyPlus simulation output to calculate. | ||
| 1064 | boost::optional<double> waterRefrigeration() const; | ||
| 1065 | |||
| 1066 | /// Returns the water used for generators in cubic meters. | ||
| 1067 | /// Requires EnergyPlus simulation output to calculate. | ||
| 1068 | boost::optional<double> waterGenerators() const; | ||
| 1069 | |||
| 1070 | /// Returns the water used for all uses in cubic meters. | ||
| 1071 | /// Requires EnergyPlus simulation output to calculate. | ||
| 1072 | boost::optional<double> waterTotalEndUses() const; | ||
| 1073 | |||
| 1074 | /// Returns the total number of hours the heating setpoint is not met. | ||
| 1075 | /// Requires EnergyPlus simulation output to calculate. | ||
| 1076 | boost::optional<double> hoursHeatingSetpointNotMet() const; | ||
| 1077 | |||
| 1078 | /// Returns the total number of hours the cooling setpoint is not met. | ||
| 1079 | /// Requires EnergyPlus simulation output to calculate. | ||
| 1080 | boost::optional<double> hoursCoolingSetpointNotMet() const; | ||
| 1081 | |||
| 1082 | // returns an optional pair of date times for begin and end of daylight savings time | ||
| 1083 | boost::optional<std::pair<DateTime, DateTime>> daylightSavingsPeriod() const; | ||
| 1084 | |||
| 1085 | /// Energy plus version number | ||
| 1086 | std::string energyPlusVersion() const; | ||
| 1087 | |||
| 1088 | //@} | ||
| 1089 | /** @name Generic TimeSeries Interface */ | ||
| 1090 | //@{ | ||
| 1091 | |||
| 1092 | // return a vector of all the available time series | ||
| 1093 | // do not return variables only reported at run period intervals | ||
| 1094 | std::vector<std::string> availableTimeSeries(); | ||
| 1095 | |||
| 1096 | // return a vector of all the available reporting frequencies for a given timeseries and environment period | ||
| 1097 | // std::vector<ReportingFrequency> availableReportingFrequencies(const std::string& envPeriod, const std::string& timeSeriesName) ; | ||
| 1098 | |||
| 1099 | // get the type of environment period | ||
| 1100 | boost::optional<openstudio::EnvironmentType> environmentType(const std::string& envPeriod) const; | ||
| 1101 | |||
| 1102 | // return a vector of all the available environment periods | ||
| 1103 | std::vector<std::string> availableEnvPeriods() const; | ||
| 1104 | |||
| 1105 | // return a vector of all the available reporting frequencies for a given environment period | ||
| 1106 | std::vector<std::string> availableReportingFrequencies(const std::string& envPeriod); | ||
| 1107 | |||
| 1108 | // version specific translation for reporting frequencies used in database to reporting frequency enum values | ||
| 1109 | boost::optional<openstudio::ReportingFrequency> reportingFrequencyFromDB(const std::string& dbReportingFrequency); | ||
| 1110 | |||
| 1111 | // return a vector of all the available variableName for environment period and reporting frequency | ||
| 1112 | std::vector<std::string> availableVariableNames(const std::string& envPeriod, const std::string& reportingFrequency) const; | ||
| 1113 | |||
| 1114 | // return a vector of all timeseries matching name, envPeriod, and reportingFrequency | ||
| 1115 | // this could be used to get "Mean Air Temperature" for all zones for instance | ||
| 1116 | std::vector<TimeSeries> timeSeries(const std::string& envPeriod, const std::string& reportingFrequency, const std::string& timeSeriesName); | ||
| 1117 | |||
| 1118 | // return a vector of all keyValues matching name, envPeriod, and reportingFrequency | ||
| 1119 | std::vector<std::string> availableKeyValues(const std::string& envPeriod, const std::string& reportingFrequency, const std::string& timeSeriesName); | ||
| 1120 | |||
| 1121 | // return a runPeriod value e.g. Electricity::Facility | ||
| 1122 | boost::optional<double> runPeriodValue(const std::string& envPeriod, const std::string& timeSeriesName, const std::string& keyValue); | ||
| 1123 | |||
| 1124 | // return a single timeseries matching name, keyValue, envPeriod, and reportingFrequency | ||
| 1125 | // this could be used to get "Mean Air Temperature" for a particular zone | ||
| 1126 | boost::optional<TimeSeries> timeSeries(const std::string& envPeriod, const std::string& reportingFrequency, const std::string& timeSeriesName, | ||
| 1127 | const std::string& keyValue); | ||
| 1128 | |||
| 1129 | /** Expands query to create a vector of all matching queries. The returned queries will have | ||
| 1130 | * one environment period, one reporting frequency, and one time series name specified. The | ||
| 1131 | * returned queries will also be "vetted". */ | ||
| 1132 | std::vector<SqlFileTimeSeriesQuery> expandQuery(const SqlFileTimeSeriesQuery& query); | ||
| 1133 | |||
| 1134 | /** Executes query. ReportingFrequency must be specified. Use expandQuery first to break query | ||
| 1135 | * down by ReportingFrequency and determine how many TimeSeries will be returned. */ | ||
| 1136 | std::vector<TimeSeries> timeSeries(const SqlFileTimeSeriesQuery& query); | ||
| 1137 | |||
| 1138 | //@} | ||
| 1139 | /** @name Illuminance Map Interface */ | ||
| 1140 | //@{ | ||
| 1141 | |||
| 1142 | /// get names of all available illuminance maps | ||
| 1143 | std::vector<std::string> illuminanceMapNames() const; | ||
| 1144 | std::vector<std::string> illuminanceMapNames(const std::string& envPeriod) const; | ||
| 1145 | |||
| 1146 | /// get zone names of for specified illuminance map | ||
| 1147 | std::vector<std::string> illuminanceMapZoneNames(const std::string& name) const; | ||
| 1148 | std::vector<std::string> illuminanceMapZoneNames(int mapIndex) const; | ||
| 1149 | |||
| 1150 | /// reference point for map - form RefPtn=(x:y:illuminance) | ||
| 1151 | boost::optional<std::string> illuminanceMapRefPt(const std::string& name, int ptNum) const; | ||
| 1152 | boost::optional<std::string> illuminanceMapRefPt(int mapIndex, int ptNum) const; | ||
| 1153 | |||
| 1154 | /// minimum value of map | ||
| 1155 | boost::optional<double> illuminanceMapMinValue(const std::string& name) const; | ||
| 1156 | boost::optional<double> illuminanceMapMinValue(int mapIndex) const; | ||
| 1157 | |||
| 1158 | /// maximum value of map | ||
| 1159 | boost::optional<double> illuminanceMapMaxValue(const std::string& name) const; | ||
| 1160 | boost::optional<double> illuminanceMapMaxValue(int mapIndex) const; | ||
| 1161 | |||
| 1162 | /// minimum and maximum of map | ||
| 1163 | void illuminanceMapMaxValue(const std::string& name, double& minValue, double& maxValue) const; | ||
| 1164 | void illuminanceMapMaxValue(int mapIndex, double& minValue, double& maxValue) const; | ||
| 1165 | |||
| 1166 | // find the illuminance map index by name | ||
| 1167 | boost::optional<int> illuminanceMapIndex(const std::string& name) const; | ||
| 1168 | |||
| 1169 | /// x position (m) of the illuminance map | ||
| 1170 | Vector illuminanceMapX(const std::string& name, const DateTime& dateTime) const; | ||
| 1171 | |||
| 1172 | /// y position (m) of the illuminance map | ||
| 1173 | Vector illuminanceMapY(const std::string& name, const DateTime& dateTime) const; | ||
| 1174 | |||
| 1175 | /// x position (m) of the illuminance map | ||
| 1176 | Vector illuminanceMapX(int hourlyReportIndex) const; | ||
| 1177 | |||
| 1178 | /// y position (m) of the illuminance map | ||
| 1179 | Vector illuminanceMapY(int hourlyReportIndex) const; | ||
| 1180 | |||
| 1181 | /// hourly report index for mapIndex at date and time | ||
| 1182 | boost::optional<int> illuminanceMapHourlyReportIndex(int mapIndex, const DateTime& dateTime) const; | ||
| 1183 | |||
| 1184 | /// date time at hourly report index | ||
| 1185 | boost::optional<DateTime> illuminanceMapDate(int hourlyReportIndex) const; | ||
| 1186 | |||
| 1187 | /// hourly report indices of the illuminance map | ||
| 1188 | std::vector<int> illuminanceMapHourlyReportIndices(const std::string& name) const; | ||
| 1189 | |||
| 1190 | /// hourly report indices of the illuminance map | ||
| 1191 | std::vector<std::pair<int, DateTime>> illuminanceMapHourlyReportIndicesDates(int mapIndex) const; | ||
| 1192 | |||
| 1193 | /// hourly report indices of the illuminance map | ||
| 1194 | std::vector<std::pair<int, DateTime>> illuminanceMapHourlyReportIndicesDates(const std::string& name) const; | ||
| 1195 | |||
| 1196 | /// hourly report indices of the illuminance map | ||
| 1197 | std::vector<int> illuminanceMapHourlyReportIndices(int mapIndex) const; | ||
| 1198 | |||
| 1199 | /** value (lux) of the illuminance map at date and time | ||
| 1200 | * value(i,j) is the illuminance at x(i), y(j) */ | ||
| 1201 | Matrix illuminanceMap(const std::string& name, const DateTime& dateTime) const; | ||
| 1202 | |||
| 1203 | /** value (lux) of the illuminance map at hourlyReportIndex | ||
| 1204 | * value(i,j) is the illuminance at x(i), y(j) */ | ||
| 1205 | Matrix illuminanceMap(int hourlyReportIndex) const; | ||
| 1206 | |||
| 1207 | /** value (lux) of the illuminance map at hourlyReportIndex | ||
| 1208 | * value(i,j) is the illuminance at x(i), y(j) fills in x,y, illuminance*/ | ||
| 1209 | void illuminanceMap(int hourlyReportIndex, std::vector<double>& x, std::vector<double>& y, std::vector<double>& illuminance) const; | ||
| 1210 | |||
| 1211 | /// Returns the summary data for each installlocation and fuel type found in report variables | ||
| 1212 | std::vector<SummaryData> getSummaryData() const; | ||
| 1213 | |||
| 1214 | int insertZone(const std::string& t_name, double t_relNorth, double t_originX, double t_originY, double t_originZ, double t_centroidX, | ||
| 1215 | double t_centroidY, double t_centroidZ, int t_ofType, double t_multiplier, double t_listMultiplier, double t_minimumX, | ||
| 1216 | double t_maximumX, double t_minimumY, double t_maximumY, double t_minimumZ, double t_maximumZ, double t_ceilingHeight, | ||
| 1217 | double t_volume, int t_insideConvectionAlgo, int t_outsideConvectionAlgo, double t_floorArea, double t_extGrossWallArea, | ||
| 1218 | double t_extNetWallArea, double t_extWindowArea, bool t_isPartOfTotalArea); | ||
| 1219 | |||
| 1220 | void insertIlluminanceMap(const std::string& t_zoneName, const std::string& t_name, const std::string& t_environmentName, | ||
| 1221 | const std::vector<DateTime>& t_times, const std::vector<double>& t_xs, const std::vector<double>& t_ys, double t_z, | ||
| 1222 | const std::vector<Matrix>& t_maps); | ||
| 1223 | |||
| 1224 | //@} | ||
| 1225 | /** @name Generic Query Interface */ | ||
| 1226 | //@{ | ||
| 1227 | |||
| 1228 | /// execute a statement and return the first (if any) value as a double | ||
| 1229 | // Variadic arguments are the bind arguments if any, to replace '?' placeholders in the statement string | ||
| 1230 | template <typename... Args> | ||
| 1231 | 14 | boost::optional<double> execAndReturnFirstDouble(const std::string& statement, Args&&... args) const { | |
| 1232 | 14 | boost::optional<double> result; | |
| 1233 |
2/18boost::optional<double> openstudio::SqlFile::execAndReturnFirstDouble<>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&) const:
✗ Branch 1 not taken.
✗ Branch 2 not taken.
boost::optional<double> openstudio::SqlFile::execAndReturnFirstDouble<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > >(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&&) const:
✓ Branch 1 taken 8 times.
✗ Branch 2 not taken.
boost::optional<double> openstudio::SqlFile::execAndReturnFirstDouble<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&) const:
✗ Branch 1 not taken.
✗ Branch 2 not taken.
boost::optional<double> openstudio::SqlFile::execAndReturnFirstDouble<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&) const:
✗ Branch 1 not taken.
✗ Branch 2 not taken.
boost::optional<double> openstudio::SqlFile::execAndReturnFirstDouble<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&) const:
✗ Branch 1 not taken.
✗ Branch 2 not taken.
boost::optional<double> openstudio::SqlFile::execAndReturnFirstDouble<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&) const:
✗ Branch 1 not taken.
✗ Branch 2 not taken.
boost::optional<double> openstudio::SqlFile::execAndReturnFirstDouble<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&) const:
✗ Branch 1 not taken.
✗ Branch 2 not taken.
boost::optional<double> openstudio::SqlFile::execAndReturnFirstDouble<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&) const:
✓ Branch 1 taken 6 times.
✗ Branch 2 not taken.
boost::optional<double> openstudio::SqlFile::execAndReturnFirstDouble<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&) const:
✗ Branch 1 not taken.
✗ Branch 2 not taken.
|
14 | if (m_impl) { |
| 1234 |
2/9boost::optional<double> openstudio::SqlFile::execAndReturnFirstDouble<>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&) const:
✗ Branch 2 not taken.
boost::optional<double> openstudio::SqlFile::execAndReturnFirstDouble<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > >(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&&) const:
✓ Branch 3 taken 8 times.
boost::optional<double> openstudio::SqlFile::execAndReturnFirstDouble<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&) const:
✗ Branch 6 not taken.
boost::optional<double> openstudio::SqlFile::execAndReturnFirstDouble<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&) const:
✗ Branch 4 not taken.
boost::optional<double> openstudio::SqlFile::execAndReturnFirstDouble<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&) const:
✗ Branch 3 not taken.
boost::optional<double> openstudio::SqlFile::execAndReturnFirstDouble<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&) const:
✗ Branch 4 not taken.
boost::optional<double> openstudio::SqlFile::execAndReturnFirstDouble<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&) const:
✗ Branch 6 not taken.
boost::optional<double> openstudio::SqlFile::execAndReturnFirstDouble<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&) const:
✓ Branch 4 taken 6 times.
boost::optional<double> openstudio::SqlFile::execAndReturnFirstDouble<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&>(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >&) const:
✗ Branch 3 not taken.
|
14 | result = m_impl->execAndReturnFirstDouble(statement, std::forward<Args>(args)...); |
| 1235 | } | ||
| 1236 | 14 | return result; | |
| 1237 | } | ||
| 1238 | |||
| 1239 | ✗ | boost::optional<double> execAndReturnFirstDouble(const std::string& statement) const { | |
| 1240 | // Forward to the variadic one. This one is for the ruby bindings | ||
| 1241 | ✗ | return execAndReturnFirstDouble<>(statement); | |
| 1242 | } | ||
| 1243 | |||
| 1244 | /// execute a statement and return the first (if any) value as a int | ||
| 1245 | // Variadic arguments are the bind arguments if any, to replace '?' placeholders in the statement string | ||
| 1246 | template <typename... Args> | ||
| 1247 | ✗ | boost::optional<int> execAndReturnFirstInt(const std::string& statement, Args&&... args) const { | |
| 1248 | ✗ | boost::optional<int> result; | |
| 1249 | ✗ | if (m_impl) { | |
| 1250 | ✗ | result = m_impl->execAndReturnFirstInt(statement, std::forward<Args>(args)...); | |
| 1251 | } | ||
| 1252 | ✗ | return result; | |
| 1253 | } | ||
| 1254 | |||
| 1255 | ✗ | boost::optional<int> execAndReturnFirstInt(const std::string& statement) const { | |
| 1256 | // Forward to the variadic one. This one is for the ruby bindings | ||
| 1257 | ✗ | return execAndReturnFirstInt<>(statement); | |
| 1258 | } | ||
| 1259 | |||
| 1260 | /// execute a statement and return the first (if any) value as a string | ||
| 1261 | // Variadic arguments are the bind arguments if any, to replace '?' placeholders in the statement string | ||
| 1262 | template <typename... Args> | ||
| 1263 | ✗ | boost::optional<std::string> execAndReturnFirstString(const std::string& statement, Args&&... args) const { | |
| 1264 | ✗ | boost::optional<std::string> result; | |
| 1265 | ✗ | if (m_impl) { | |
| 1266 | ✗ | result = m_impl->execAndReturnFirstString(statement, std::forward<Args>(args)...); | |
| 1267 | } | ||
| 1268 | ✗ | return result; | |
| 1269 | ✗ | } | |
| 1270 | |||
| 1271 | ✗ | boost::optional<std::string> execAndReturnFirstString(const std::string& statement) const { | |
| 1272 | // Forward to the variadic one. This one is for the ruby bindings | ||
| 1273 | ✗ | return execAndReturnFirstString<>(statement); | |
| 1274 | } | ||
| 1275 | |||
| 1276 | /// execute a statement and return the results (if any) in a vector of double | ||
| 1277 | // Variadic arguments are the bind arguments if any, to replace '?' placeholders in the statement string | ||
| 1278 | template <typename... Args> | ||
| 1279 | ✗ | boost::optional<std::vector<double>> execAndReturnVectorOfDouble(const std::string& statement, Args&&... args) const { | |
| 1280 | ✗ | boost::optional<std::vector<double>> result; | |
| 1281 | ✗ | if (m_impl) { | |
| 1282 | ✗ | result = m_impl->execAndReturnVectorOfDouble(statement, std::forward<Args>(args)...); | |
| 1283 | } | ||
| 1284 | ✗ | return result; | |
| 1285 | ✗ | } | |
| 1286 | |||
| 1287 | ✗ | boost::optional<std::vector<double>> execAndReturnVectorOfDouble(const std::string& statement) const { | |
| 1288 | // Forward to the variadic one. This one is for the ruby bindings | ||
| 1289 | ✗ | return execAndReturnVectorOfDouble<>(statement); | |
| 1290 | } | ||
| 1291 | |||
| 1292 | /// execute a statement and return the results (if any) in a vector of int | ||
| 1293 | // Variadic arguments are the bind arguments if any, to replace '?' placeholders in the statement string | ||
| 1294 | template <typename... Args> | ||
| 1295 | ✗ | boost::optional<std::vector<int>> execAndReturnVectorOfInt(const std::string& statement, Args&&... args) const { | |
| 1296 | ✗ | boost::optional<std::vector<int>> result; | |
| 1297 | ✗ | if (m_impl) { | |
| 1298 | ✗ | result = m_impl->execAndReturnVectorOfInt(statement, std::forward<Args>(args)...); | |
| 1299 | } | ||
| 1300 | ✗ | return result; | |
| 1301 | ✗ | } | |
| 1302 | |||
| 1303 | ✗ | boost::optional<std::vector<int>> execAndReturnVectorOfInt(const std::string& statement) const { | |
| 1304 | // Forward to the variadic one. This one is for the ruby bindings | ||
| 1305 | ✗ | return execAndReturnVectorOfInt<>(statement); | |
| 1306 | } | ||
| 1307 | |||
| 1308 | /// execute a statement and return the results (if any) in a vector of string | ||
| 1309 | // Variadic arguments are the bind arguments if any, to replace '?' placeholders in the statement string | ||
| 1310 | template <typename... Args> | ||
| 1311 | ✗ | boost::optional<std::vector<std::string>> execAndReturnVectorOfString(const std::string& statement, Args&&... args) const { | |
| 1312 | ✗ | boost::optional<std::vector<std::string>> result; | |
| 1313 | ✗ | if (m_impl) { | |
| 1314 | ✗ | result = m_impl->execAndReturnVectorOfString(statement, std::forward<Args>(args)...); | |
| 1315 | } | ||
| 1316 | ✗ | return result; | |
| 1317 | ✗ | } | |
| 1318 | |||
| 1319 | ✗ | boost::optional<std::vector<std::string>> execAndReturnVectorOfString(const std::string& statement) const { | |
| 1320 | // Forward to the variadic one. This one is for the ruby bindings | ||
| 1321 | ✗ | return execAndReturnVectorOfString<>(statement); | |
| 1322 | } | ||
| 1323 | |||
| 1324 | /// execute a statement and return the error code, used for create/drop tables | ||
| 1325 | // Variadic arguments are the bind arguments if any, to replace '?' placeholders in the statement string | ||
| 1326 | template <typename... Args> | ||
| 1327 | ✗ | int execute(const std::string& statement, Args&&... args) { | |
| 1328 | ✗ | int result = 1; // SQLITE_ERROR | |
| 1329 | ✗ | if (m_impl) { | |
| 1330 | ✗ | result = m_impl->execute(statement, std::forward<Args>(args)...); | |
| 1331 | } | ||
| 1332 | ✗ | return result; | |
| 1333 | } | ||
| 1334 | |||
| 1335 | ✗ | int execute(const std::string& statement) { | |
| 1336 | // Forward to the variadic one. This one is for the ruby bindings | ||
| 1337 | ✗ | return execute<>(statement); | |
| 1338 | } | ||
| 1339 | |||
| 1340 | void insertTimeSeriesData(const std::string& t_variableType, const std::string& t_indexGroup, const std::string& t_timestepType, | ||
| 1341 | const std::string& t_keyValue, const std::string& t_variableName, | ||
| 1342 | const openstudio::ReportingFrequency& t_reportingFrequency, const boost::optional<std::string>& t_scheduleName, | ||
| 1343 | const std::string& t_variableUnits, const openstudio::TimeSeries& t_timeSeries); | ||
| 1344 | |||
| 1345 | //@} | ||
| 1346 | /** @name Operators */ | ||
| 1347 | //@{ | ||
| 1348 | |||
| 1349 | // equality test | ||
| 1350 | bool operator==(const SqlFile& other) const; | ||
| 1351 | |||
| 1352 | // inequality test | ||
| 1353 | bool operator<(const SqlFile& other) const; | ||
| 1354 | |||
| 1355 | //@} | ||
| 1356 | |||
| 1357 | private: | ||
| 1358 | − | REGISTER_LOGGER("openstudio.sql.SqlFile"); | |
| 1359 | |||
| 1360 | std::shared_ptr<detail::SqlFile_Impl> m_impl; | ||
| 1361 | |||
| 1362 | /// returns datadictionary of available timeseries | ||
| 1363 | detail::DataDictionaryTable dataDictionary() const; | ||
| 1364 | }; | ||
| 1365 | |||
| 1366 | /// optional SqlFile | ||
| 1367 | using OptionalSqlFile = boost::optional<SqlFile>; | ||
| 1368 | |||
| 1369 | } // namespace openstudio | ||
| 1370 | |||
| 1371 | #endif // UTILITIES_SQL_SQLFILE_HPP | ||
| 1372 |