src/model/WaterUseEquipmentDefinition.cpp
| 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 | #include "WaterUseEquipmentDefinition.hpp" | ||
| 7 | #include "WaterUseEquipmentDefinition_Impl.hpp" | ||
| 8 | #include "Schedule.hpp" | ||
| 9 | #include "Schedule_Impl.hpp" | ||
| 10 | #include <utilities/idd/OS_WaterUse_Equipment_Definition_FieldEnums.hxx> | ||
| 11 | #include <utilities/idd/IddEnums.hxx> | ||
| 12 | #include "../utilities/units/Unit.hpp" | ||
| 13 | #include "../utilities/core/Assert.hpp" | ||
| 14 | |||
| 15 | namespace openstudio { | ||
| 16 | |||
| 17 | namespace model { | ||
| 18 | |||
| 19 | namespace detail { | ||
| 20 | |||
| 21 | 49 | WaterUseEquipmentDefinition_Impl::WaterUseEquipmentDefinition_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle) | |
| 22 | 49 | : SpaceLoadDefinition_Impl(idfObject, model, keepHandle) { | |
| 23 |
4/6✓ Branch 1 taken 49 times.
✓ Branch 4 taken 49 times.
✓ Branch 7 taken 49 times.
✗ Branch 10 not taken.
✓ Branch 11 taken 49 times.
✗ Branch 13 not taken.
|
49 | OS_ASSERT(idfObject.iddObject().type() == WaterUseEquipmentDefinition::iddObjectType()); |
| 24 | 49 | } | |
| 25 | |||
| 26 | 23 | WaterUseEquipmentDefinition_Impl::WaterUseEquipmentDefinition_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, | |
| 27 | 23 | bool keepHandle) | |
| 28 | 23 | : SpaceLoadDefinition_Impl(other, model, keepHandle) { | |
| 29 |
4/6✓ Branch 1 taken 23 times.
✓ Branch 4 taken 23 times.
✓ Branch 7 taken 23 times.
✗ Branch 10 not taken.
✓ Branch 11 taken 23 times.
✗ Branch 13 not taken.
|
23 | OS_ASSERT(other.iddObject().type() == WaterUseEquipmentDefinition::iddObjectType()); |
| 30 | 23 | } | |
| 31 | |||
| 32 | 91 | WaterUseEquipmentDefinition_Impl::WaterUseEquipmentDefinition_Impl(const WaterUseEquipmentDefinition_Impl& other, Model_Impl* model, | |
| 33 | 91 | bool keepHandle) | |
| 34 | 91 | : SpaceLoadDefinition_Impl(other, model, keepHandle) {} | |
| 35 | |||
| 36 | // TODO: remove | ||
| 37 | ✗ | const std::vector<std::string>& WaterUseEquipmentDefinition_Impl::outputVariableNames() const { | |
| 38 | ✗ | static const std::vector<std::string> result; | |
| 39 | // Not appropriate: output is listed in WaterUseEquipment instead | ||
| 40 | ✗ | return result; | |
| 41 | } | ||
| 42 | |||
| 43 | ✗ | IddObjectType WaterUseEquipmentDefinition_Impl::iddObjectType() const { | |
| 44 | ✗ | return WaterUseEquipmentDefinition::iddObjectType(); | |
| 45 | } | ||
| 46 | |||
| 47 | 22 | std::string WaterUseEquipmentDefinition_Impl::endUseSubcategory() const { | |
| 48 |
1/1✓ Branch 1 taken 22 times.
|
22 | boost::optional<std::string> value = getString(OS_WaterUse_Equipment_DefinitionFields::EndUseSubcategory, true); |
| 49 |
1/3✗ Branch 1 not taken.
✓ Branch 2 taken 22 times.
✗ Branch 4 not taken.
|
22 | OS_ASSERT(value); |
| 50 |
2/2✓ Branch 1 taken 22 times.
✓ Branch 4 taken 22 times.
|
44 | return value.get(); |
| 51 | 22 | } | |
| 52 | |||
| 53 | ✗ | bool WaterUseEquipmentDefinition_Impl::isEndUseSubcategoryDefaulted() const { | |
| 54 | ✗ | return isEmpty(OS_WaterUse_Equipment_DefinitionFields::EndUseSubcategory); | |
| 55 | } | ||
| 56 | |||
| 57 | 22 | double WaterUseEquipmentDefinition_Impl::peakFlowRate() const { | |
| 58 |
1/1✓ Branch 1 taken 22 times.
|
22 | boost::optional<double> value = getDouble(OS_WaterUse_Equipment_DefinitionFields::PeakFlowRate, true); |
| 59 |
1/3✗ Branch 1 not taken.
✓ Branch 2 taken 22 times.
✗ Branch 4 not taken.
|
22 | OS_ASSERT(value); |
| 60 |
1/1✓ Branch 1 taken 22 times.
|
44 | return value.get(); |
| 61 | } | ||
| 62 | |||
| 63 | 22 | boost::optional<Schedule> WaterUseEquipmentDefinition_Impl::targetTemperatureSchedule() const { | |
| 64 |
2/2✓ Branch 1 taken 22 times.
✓ Branch 4 taken 22 times.
|
22 | return getObject<ModelObject>().getModelObjectTarget<Schedule>(OS_WaterUse_Equipment_DefinitionFields::TargetTemperatureScheduleName); |
| 65 | } | ||
| 66 | |||
| 67 | 22 | boost::optional<Schedule> WaterUseEquipmentDefinition_Impl::sensibleFractionSchedule() const { | |
| 68 |
2/2✓ Branch 1 taken 22 times.
✓ Branch 4 taken 22 times.
|
22 | return getObject<ModelObject>().getModelObjectTarget<Schedule>(OS_WaterUse_Equipment_DefinitionFields::SensibleFractionScheduleName); |
| 69 | } | ||
| 70 | |||
| 71 | 22 | boost::optional<Schedule> WaterUseEquipmentDefinition_Impl::latentFractionSchedule() const { | |
| 72 |
2/2✓ Branch 1 taken 22 times.
✓ Branch 4 taken 22 times.
|
22 | return getObject<ModelObject>().getModelObjectTarget<Schedule>(OS_WaterUse_Equipment_DefinitionFields::LatentFractionScheduleName); |
| 73 | } | ||
| 74 | |||
| 75 | ✗ | bool WaterUseEquipmentDefinition_Impl::setEndUseSubcategory(const std::string& endUseSubcategory) { | |
| 76 | ✗ | bool result = setString(OS_WaterUse_Equipment_DefinitionFields::EndUseSubcategory, endUseSubcategory); | |
| 77 | ✗ | OS_ASSERT(result); | |
| 78 | ✗ | return result; | |
| 79 | } | ||
| 80 | |||
| 81 | ✗ | void WaterUseEquipmentDefinition_Impl::resetEndUseSubcategory() { | |
| 82 | ✗ | bool result = setString(OS_WaterUse_Equipment_DefinitionFields::EndUseSubcategory, ""); | |
| 83 | ✗ | OS_ASSERT(result); | |
| 84 | ✗ | } | |
| 85 | |||
| 86 | 47 | bool WaterUseEquipmentDefinition_Impl::setPeakFlowRate(double peakFlowRate) { | |
| 87 | 47 | bool result = setDouble(OS_WaterUse_Equipment_DefinitionFields::PeakFlowRate, peakFlowRate); | |
| 88 | 47 | return result; | |
| 89 | } | ||
| 90 | |||
| 91 | 21 | bool WaterUseEquipmentDefinition_Impl::setTargetTemperatureSchedule(const boost::optional<Schedule>& targetTemperatureSchedule) { | |
| 92 | 21 | bool result = false; | |
| 93 |
1/2✓ Branch 0 taken 21 times.
✗ Branch 1 not taken.
|
21 | if (targetTemperatureSchedule) { |
| 94 |
3/3✓ Branch 1 taken 21 times.
✓ Branch 4 taken 21 times.
✓ Branch 7 taken 21 times.
|
21 | result = setPointer(OS_WaterUse_Equipment_DefinitionFields::TargetTemperatureScheduleName, targetTemperatureSchedule.get().handle()); |
| 95 | } else { | ||
| 96 | ✗ | result = setString(OS_WaterUse_Equipment_DefinitionFields::TargetTemperatureScheduleName, ""); | |
| 97 | } | ||
| 98 | 21 | return result; | |
| 99 | } | ||
| 100 | |||
| 101 | ✗ | void WaterUseEquipmentDefinition_Impl::resetTargetTemperatureSchedule() { | |
| 102 | ✗ | bool result = setString(OS_WaterUse_Equipment_DefinitionFields::TargetTemperatureScheduleName, ""); | |
| 103 | ✗ | OS_ASSERT(result); | |
| 104 | ✗ | } | |
| 105 | |||
| 106 | ✗ | bool WaterUseEquipmentDefinition_Impl::setSensibleFractionSchedule(const boost::optional<Schedule>& sensibleFractionSchedule) { | |
| 107 | ✗ | bool result = false; | |
| 108 | ✗ | if (sensibleFractionSchedule) { | |
| 109 | ✗ | result = setPointer(OS_WaterUse_Equipment_DefinitionFields::SensibleFractionScheduleName, sensibleFractionSchedule.get().handle()); | |
| 110 | } else { | ||
| 111 | ✗ | result = setString(OS_WaterUse_Equipment_DefinitionFields::SensibleFractionScheduleName, ""); | |
| 112 | } | ||
| 113 | ✗ | return result; | |
| 114 | } | ||
| 115 | |||
| 116 | ✗ | void WaterUseEquipmentDefinition_Impl::resetSensibleFractionSchedule() { | |
| 117 | ✗ | bool result = setString(OS_WaterUse_Equipment_DefinitionFields::SensibleFractionScheduleName, ""); | |
| 118 | ✗ | OS_ASSERT(result); | |
| 119 | ✗ | } | |
| 120 | |||
| 121 | ✗ | bool WaterUseEquipmentDefinition_Impl::setLatentFractionSchedule(const boost::optional<Schedule>& latentFractionSchedule) { | |
| 122 | ✗ | bool result = false; | |
| 123 | ✗ | if (latentFractionSchedule) { | |
| 124 | ✗ | result = setPointer(OS_WaterUse_Equipment_DefinitionFields::LatentFractionScheduleName, latentFractionSchedule.get().handle()); | |
| 125 | } else { | ||
| 126 | ✗ | result = setString(OS_WaterUse_Equipment_DefinitionFields::LatentFractionScheduleName, ""); | |
| 127 | } | ||
| 128 | ✗ | return result; | |
| 129 | } | ||
| 130 | |||
| 131 | ✗ | void WaterUseEquipmentDefinition_Impl::resetLatentFractionSchedule() { | |
| 132 | ✗ | bool result = setString(OS_WaterUse_Equipment_DefinitionFields::LatentFractionScheduleName, ""); | |
| 133 | ✗ | OS_ASSERT(result); | |
| 134 | ✗ | } | |
| 135 | |||
| 136 | ✗ | boost::optional<ModelObject> WaterUseEquipmentDefinition_Impl::targetTemperatureScheduleAsModelObject() const { | |
| 137 | ✗ | OptionalModelObject result; | |
| 138 | ✗ | OptionalSchedule intermediate = targetTemperatureSchedule(); | |
| 139 | ✗ | if (intermediate) { | |
| 140 | ✗ | result = *intermediate; | |
| 141 | } | ||
| 142 | ✗ | return result; | |
| 143 | ✗ | } | |
| 144 | |||
| 145 | ✗ | boost::optional<ModelObject> WaterUseEquipmentDefinition_Impl::sensibleFractionScheduleAsModelObject() const { | |
| 146 | ✗ | OptionalModelObject result; | |
| 147 | ✗ | OptionalSchedule intermediate = sensibleFractionSchedule(); | |
| 148 | ✗ | if (intermediate) { | |
| 149 | ✗ | result = *intermediate; | |
| 150 | } | ||
| 151 | ✗ | return result; | |
| 152 | ✗ | } | |
| 153 | |||
| 154 | ✗ | boost::optional<ModelObject> WaterUseEquipmentDefinition_Impl::latentFractionScheduleAsModelObject() const { | |
| 155 | ✗ | OptionalModelObject result; | |
| 156 | ✗ | OptionalSchedule intermediate = latentFractionSchedule(); | |
| 157 | ✗ | if (intermediate) { | |
| 158 | ✗ | result = *intermediate; | |
| 159 | } | ||
| 160 | ✗ | return result; | |
| 161 | ✗ | } | |
| 162 | |||
| 163 | ✗ | bool WaterUseEquipmentDefinition_Impl::setTargetTemperatureScheduleAsModelObject(const boost::optional<ModelObject>& modelObject) { | |
| 164 | ✗ | if (modelObject) { | |
| 165 | ✗ | OptionalSchedule intermediate = modelObject->optionalCast<Schedule>(); | |
| 166 | ✗ | if (intermediate) { | |
| 167 | ✗ | return setTargetTemperatureSchedule(*intermediate); | |
| 168 | } else { | ||
| 169 | ✗ | return false; | |
| 170 | } | ||
| 171 | ✗ | } else { | |
| 172 | ✗ | resetTargetTemperatureSchedule(); | |
| 173 | } | ||
| 174 | ✗ | return true; | |
| 175 | } | ||
| 176 | |||
| 177 | ✗ | bool WaterUseEquipmentDefinition_Impl::setSensibleFractionScheduleAsModelObject(const boost::optional<ModelObject>& modelObject) { | |
| 178 | ✗ | if (modelObject) { | |
| 179 | ✗ | OptionalSchedule intermediate = modelObject->optionalCast<Schedule>(); | |
| 180 | ✗ | if (intermediate) { | |
| 181 | ✗ | return setSensibleFractionSchedule(*intermediate); | |
| 182 | } else { | ||
| 183 | ✗ | return false; | |
| 184 | } | ||
| 185 | ✗ | } else { | |
| 186 | ✗ | resetSensibleFractionSchedule(); | |
| 187 | } | ||
| 188 | ✗ | return true; | |
| 189 | } | ||
| 190 | |||
| 191 | ✗ | bool WaterUseEquipmentDefinition_Impl::setLatentFractionScheduleAsModelObject(const boost::optional<ModelObject>& modelObject) { | |
| 192 | ✗ | if (modelObject) { | |
| 193 | ✗ | OptionalSchedule intermediate = modelObject->optionalCast<Schedule>(); | |
| 194 | ✗ | if (intermediate) { | |
| 195 | ✗ | return setLatentFractionSchedule(*intermediate); | |
| 196 | } else { | ||
| 197 | ✗ | return false; | |
| 198 | } | ||
| 199 | ✗ | } else { | |
| 200 | ✗ | resetLatentFractionSchedule(); | |
| 201 | } | ||
| 202 | ✗ | return true; | |
| 203 | } | ||
| 204 | |||
| 205 | } // namespace detail | ||
| 206 | |||
| 207 | 26 | WaterUseEquipmentDefinition::WaterUseEquipmentDefinition(const Model& model) | |
| 208 | 26 | : SpaceLoadDefinition(WaterUseEquipmentDefinition::iddObjectType(), model) { | |
| 209 |
1/3✗ Branch 2 not taken.
✓ Branch 3 taken 26 times.
✗ Branch 5 not taken.
|
26 | OS_ASSERT(getImpl<detail::WaterUseEquipmentDefinition_Impl>()); |
| 210 | |||
| 211 |
1/1✓ Branch 1 taken 26 times.
|
26 | setPeakFlowRate(0.0); |
| 212 | 26 | } | |
| 213 | |||
| 214 | 7696 | IddObjectType WaterUseEquipmentDefinition::iddObjectType() { | |
| 215 |
1/1✓ Branch 1 taken 7696 times.
|
7696 | return {IddObjectType::OS_WaterUse_Equipment_Definition}; |
| 216 | } | ||
| 217 | |||
| 218 | 22 | std::string WaterUseEquipmentDefinition::endUseSubcategory() const { | |
| 219 |
1/1✓ Branch 3 taken 22 times.
|
22 | return getImpl<detail::WaterUseEquipmentDefinition_Impl>()->endUseSubcategory(); |
| 220 | } | ||
| 221 | |||
| 222 | ✗ | bool WaterUseEquipmentDefinition::isEndUseSubcategoryDefaulted() const { | |
| 223 | ✗ | return getImpl<detail::WaterUseEquipmentDefinition_Impl>()->isEndUseSubcategoryDefaulted(); | |
| 224 | } | ||
| 225 | |||
| 226 | 22 | double WaterUseEquipmentDefinition::peakFlowRate() const { | |
| 227 |
1/1✓ Branch 3 taken 22 times.
|
22 | return getImpl<detail::WaterUseEquipmentDefinition_Impl>()->peakFlowRate(); |
| 228 | } | ||
| 229 | |||
| 230 | 22 | boost::optional<Schedule> WaterUseEquipmentDefinition::targetTemperatureSchedule() const { | |
| 231 |
1/1✓ Branch 3 taken 22 times.
|
22 | return getImpl<detail::WaterUseEquipmentDefinition_Impl>()->targetTemperatureSchedule(); |
| 232 | } | ||
| 233 | |||
| 234 | 22 | boost::optional<Schedule> WaterUseEquipmentDefinition::sensibleFractionSchedule() const { | |
| 235 |
1/1✓ Branch 3 taken 22 times.
|
22 | return getImpl<detail::WaterUseEquipmentDefinition_Impl>()->sensibleFractionSchedule(); |
| 236 | } | ||
| 237 | |||
| 238 | 22 | boost::optional<Schedule> WaterUseEquipmentDefinition::latentFractionSchedule() const { | |
| 239 |
1/1✓ Branch 3 taken 22 times.
|
22 | return getImpl<detail::WaterUseEquipmentDefinition_Impl>()->latentFractionSchedule(); |
| 240 | } | ||
| 241 | |||
| 242 | ✗ | bool WaterUseEquipmentDefinition::setEndUseSubcategory(const std::string& endUseSubcategory) { | |
| 243 | ✗ | return getImpl<detail::WaterUseEquipmentDefinition_Impl>()->setEndUseSubcategory(endUseSubcategory); | |
| 244 | } | ||
| 245 | |||
| 246 | ✗ | void WaterUseEquipmentDefinition::resetEndUseSubcategory() { | |
| 247 | ✗ | getImpl<detail::WaterUseEquipmentDefinition_Impl>()->resetEndUseSubcategory(); | |
| 248 | ✗ | } | |
| 249 | |||
| 250 | 47 | bool WaterUseEquipmentDefinition::setPeakFlowRate(double peakFlowRate) { | |
| 251 |
1/1✓ Branch 3 taken 47 times.
|
47 | return getImpl<detail::WaterUseEquipmentDefinition_Impl>()->setPeakFlowRate(peakFlowRate); |
| 252 | } | ||
| 253 | |||
| 254 | 21 | bool WaterUseEquipmentDefinition::setTargetTemperatureSchedule(const Schedule& targetTemperatureSchedule) { | |
| 255 |
2/2✓ Branch 3 taken 21 times.
✓ Branch 6 taken 21 times.
|
21 | return getImpl<detail::WaterUseEquipmentDefinition_Impl>()->setTargetTemperatureSchedule(targetTemperatureSchedule); |
| 256 | } | ||
| 257 | |||
| 258 | ✗ | void WaterUseEquipmentDefinition::resetTargetTemperatureSchedule() { | |
| 259 | ✗ | getImpl<detail::WaterUseEquipmentDefinition_Impl>()->resetTargetTemperatureSchedule(); | |
| 260 | ✗ | } | |
| 261 | |||
| 262 | ✗ | bool WaterUseEquipmentDefinition::setSensibleFractionSchedule(const Schedule& sensibleFractionSchedule) { | |
| 263 | ✗ | return getImpl<detail::WaterUseEquipmentDefinition_Impl>()->setSensibleFractionSchedule(sensibleFractionSchedule); | |
| 264 | } | ||
| 265 | |||
| 266 | ✗ | void WaterUseEquipmentDefinition::resetSensibleFractionSchedule() { | |
| 267 | ✗ | getImpl<detail::WaterUseEquipmentDefinition_Impl>()->resetSensibleFractionSchedule(); | |
| 268 | ✗ | } | |
| 269 | |||
| 270 | ✗ | bool WaterUseEquipmentDefinition::setLatentFractionSchedule(const Schedule& latentFractionSchedule) { | |
| 271 | ✗ | return getImpl<detail::WaterUseEquipmentDefinition_Impl>()->setLatentFractionSchedule(latentFractionSchedule); | |
| 272 | } | ||
| 273 | |||
| 274 | ✗ | void WaterUseEquipmentDefinition::resetLatentFractionSchedule() { | |
| 275 | ✗ | getImpl<detail::WaterUseEquipmentDefinition_Impl>()->resetLatentFractionSchedule(); | |
| 276 | ✗ | } | |
| 277 | |||
| 278 | /// @cond | ||
| 279 | 22 | WaterUseEquipmentDefinition::WaterUseEquipmentDefinition(std::shared_ptr<detail::WaterUseEquipmentDefinition_Impl> impl) | |
| 280 |
1/1✓ Branch 3 taken 22 times.
|
22 | : SpaceLoadDefinition(std::move(impl)) {} |
| 281 | /// @endcond | ||
| 282 | |||
| 283 | } // namespace model | ||
| 284 | } // namespace openstudio | ||
| 285 |