src/model/HotWaterEquipmentDefinition_Impl.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 MODEL_HOTWATEREQUIPMENTDEFINITION_IMPL_HPP | ||
| 7 | #define MODEL_HOTWATEREQUIPMENTDEFINITION_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "SpaceLoadDefinition_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class HotWaterEquipmentDefinition; | ||
| 16 | |||
| 17 | namespace detail { | ||
| 18 | |||
| 19 | /** HotWaterEquipmentDefinition_Impl is a SpaceLoadDefinition_Impl that is the implementation class for HotWaterEquipmentDefinition.*/ | ||
| 20 | class MODEL_API HotWaterEquipmentDefinition_Impl : public SpaceLoadDefinition_Impl | ||
| 21 | { | ||
| 22 | public: | ||
| 23 | /** @name Constructors and Destructors */ | ||
| 24 | //@{ | ||
| 25 | |||
| 26 | HotWaterEquipmentDefinition_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 27 | |||
| 28 | HotWaterEquipmentDefinition_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 29 | |||
| 30 | HotWaterEquipmentDefinition_Impl(const HotWaterEquipmentDefinition_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 31 | |||
| 32 | 10 | virtual ~HotWaterEquipmentDefinition_Impl() override = default; | |
| 33 | |||
| 34 | //@} | ||
| 35 | |||
| 36 | // TODO: remove | ||
| 37 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 38 | |||
| 39 | virtual IddObjectType iddObjectType() const override; | ||
| 40 | |||
| 41 | /** @name Getters */ | ||
| 42 | //@{ | ||
| 43 | |||
| 44 | std::string designLevelCalculationMethod() const; | ||
| 45 | |||
| 46 | boost::optional<double> designLevel() const; | ||
| 47 | |||
| 48 | boost::optional<double> wattsperSpaceFloorArea() const; | ||
| 49 | |||
| 50 | boost::optional<double> wattsperPerson() const; | ||
| 51 | |||
| 52 | double fractionLatent() const; | ||
| 53 | |||
| 54 | bool isFractionLatentDefaulted() const; | ||
| 55 | |||
| 56 | double fractionRadiant() const; | ||
| 57 | |||
| 58 | bool isFractionRadiantDefaulted() const; | ||
| 59 | |||
| 60 | double fractionLost() const; | ||
| 61 | |||
| 62 | bool isFractionLostDefaulted() const; | ||
| 63 | |||
| 64 | //@} | ||
| 65 | /** @name Setters */ | ||
| 66 | //@{ | ||
| 67 | |||
| 68 | /// Sets designLevelCalculationMethod to 'DesignLevel', clears wattsperSpaceFloorArea | ||
| 69 | /// and wattsperPerson, and sets designLevel. | ||
| 70 | bool setDesignLevel(boost::optional<double> designLevel); | ||
| 71 | |||
| 72 | /// Sets designLevelCalculationMethod to 'Watts/Area', clears designLevel | ||
| 73 | /// and wattsperPerson, and sets wattsperSpaceFloorArea. | ||
| 74 | bool setWattsperSpaceFloorArea(boost::optional<double> wattsperSpaceFloorArea); | ||
| 75 | |||
| 76 | /// Sets designLevelCalculationMethod to 'Watts/Person', clears designLevel | ||
| 77 | /// and wattsperSpaceFloorArea, and sets wattsperPerson. | ||
| 78 | bool setWattsperPerson(boost::optional<double> wattsperPerson); | ||
| 79 | |||
| 80 | bool setFractionLatent(double fractionLatent); | ||
| 81 | |||
| 82 | void resetFractionLatent(); | ||
| 83 | |||
| 84 | bool setFractionRadiant(double fractionRadiant); | ||
| 85 | |||
| 86 | void resetFractionRadiant(); | ||
| 87 | |||
| 88 | bool setFractionLost(double fractionLost); | ||
| 89 | |||
| 90 | void resetFractionLost(); | ||
| 91 | |||
| 92 | //@} | ||
| 93 | /** @name Other */ | ||
| 94 | //@{ | ||
| 95 | |||
| 96 | /** Returns the design level represented by this definition, assuming floorArea (m^2) and | ||
| 97 | * numPeople. */ | ||
| 98 | double getDesignLevel(double floorArea, double numPeople) const; | ||
| 99 | |||
| 100 | /** Returns the watts/m^2 represented by this definition, assuming floorArea (m^2) and | ||
| 101 | * numPeople. */ | ||
| 102 | double getPowerPerFloorArea(double floorArea, double numPeople) const; | ||
| 103 | |||
| 104 | /** Returns the watts/person represented by this definition, assuming floorArea (m^2) and | ||
| 105 | * numPeople. */ | ||
| 106 | double getPowerPerPerson(double floorArea, double numPeople) const; | ||
| 107 | |||
| 108 | /** If method is a \link validDesignLevelCalculationMethodValues valid design level | ||
| 109 | * calculation method \endlink, changes this definition to an equivalent power level, under | ||
| 110 | * the assumptions of floorArea (m^2) and numPeople. */ | ||
| 111 | bool setDesignLevelCalculationMethod(const std::string& method, double floorArea, double numPeople); | ||
| 112 | |||
| 113 | virtual std::vector<EMSActuatorNames> emsActuatorNames() const override; | ||
| 114 | |||
| 115 | virtual std::vector<std::string> emsInternalVariableNames() const override; | ||
| 116 | |||
| 117 | //@} | ||
| 118 | protected: | ||
| 119 | private: | ||
| 120 | − | REGISTER_LOGGER("openstudio.model.HotWaterEquipmentDefinition"); | |
| 121 | }; | ||
| 122 | |||
| 123 | } // namespace detail | ||
| 124 | |||
| 125 | } // namespace model | ||
| 126 | } // namespace openstudio | ||
| 127 | |||
| 128 | #endif // MODEL_HOTWATEREQUIPMENTDEFINITION_IMPL_HPP | ||
| 129 |