src/model/EnergyManagementSystemTrendVariable.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_ENERGYMANAGEMENTSYSTEMTRENDVARIABLE_HPP | ||
| 7 | #define MODEL_ENERGYMANAGEMENTSYSTEMTRENDVARIABLE_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ModelObject.hpp" | ||
| 11 | #include "EnergyManagementSystemActuator.hpp" | ||
| 12 | #include "EnergyManagementSystemSensor.hpp" | ||
| 13 | #include "EnergyManagementSystemGlobalVariable.hpp" | ||
| 14 | #include "EnergyManagementSystemTrendVariable.hpp" | ||
| 15 | #include "EnergyManagementSystemInternalVariable.hpp" | ||
| 16 | #include "EnergyManagementSystemCurveOrTableIndexVariable.hpp" | ||
| 17 | #include "EnergyManagementSystemConstructionIndexVariable.hpp" | ||
| 18 | |||
| 19 | namespace openstudio { | ||
| 20 | |||
| 21 | namespace energyplus { | ||
| 22 | class ReverseTranslator; | ||
| 23 | } | ||
| 24 | |||
| 25 | namespace model { | ||
| 26 | |||
| 27 | namespace detail { | ||
| 28 | |||
| 29 | class EnergyManagementSystemTrendVariable_Impl; | ||
| 30 | |||
| 31 | } // namespace detail | ||
| 32 | |||
| 33 | /** EnergyManagementSystemTrendVariable is a ModelObject that wraps the OpenStudio IDD object 'OS:EnergyManagementSystem:TrendVariable'. */ | ||
| 34 | class MODEL_API EnergyManagementSystemTrendVariable : public ModelObject | ||
| 35 | { | ||
| 36 | public: | ||
| 37 | /** @name Constructors and Destructors */ | ||
| 38 | //@{ | ||
| 39 | explicit EnergyManagementSystemTrendVariable(const Model& model, const std::string& eMSVariableName); | ||
| 40 | |||
| 41 | explicit EnergyManagementSystemTrendVariable(const Model& model, const EnergyManagementSystemActuator& object); | ||
| 42 | |||
| 43 | explicit EnergyManagementSystemTrendVariable(const Model& model, const EnergyManagementSystemSensor& object); | ||
| 44 | |||
| 45 | explicit EnergyManagementSystemTrendVariable(const Model& model, const EnergyManagementSystemGlobalVariable& object); | ||
| 46 | |||
| 47 | explicit EnergyManagementSystemTrendVariable(const Model& model, const EnergyManagementSystemTrendVariable& object); | ||
| 48 | |||
| 49 | explicit EnergyManagementSystemTrendVariable(const Model& model, const EnergyManagementSystemInternalVariable& object); | ||
| 50 | |||
| 51 | explicit EnergyManagementSystemTrendVariable(const Model& model, const EnergyManagementSystemCurveOrTableIndexVariable& object); | ||
| 52 | |||
| 53 | explicit EnergyManagementSystemTrendVariable(const Model& model, const EnergyManagementSystemConstructionIndexVariable& object); | ||
| 54 | |||
| 55 | 17 | virtual ~EnergyManagementSystemTrendVariable() override = default; | |
| 56 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 57 | ✗ | EnergyManagementSystemTrendVariable(const EnergyManagementSystemTrendVariable& other) = default; | |
| 58 | ✗ | EnergyManagementSystemTrendVariable(EnergyManagementSystemTrendVariable&& other) = default; | |
| 59 | ✗ | EnergyManagementSystemTrendVariable& operator=(const EnergyManagementSystemTrendVariable&) = default; | |
| 60 | ✗ | EnergyManagementSystemTrendVariable& operator=(EnergyManagementSystemTrendVariable&&) = default; | |
| 61 | |||
| 62 | //@} | ||
| 63 | |||
| 64 | static IddObjectType iddObjectType(); | ||
| 65 | |||
| 66 | /** @name Getters */ | ||
| 67 | //@{ | ||
| 68 | |||
| 69 | std::string emsVariableName() const; | ||
| 70 | |||
| 71 | int numberOfTimestepsToBeLogged() const; | ||
| 72 | |||
| 73 | boost::optional<ModelObject> emsVariableObject() const; | ||
| 74 | |||
| 75 | boost::optional<EnergyManagementSystemActuator> emsActuator() const; | ||
| 76 | boost::optional<EnergyManagementSystemSensor> emsSensor() const; | ||
| 77 | boost::optional<EnergyManagementSystemGlobalVariable> emsGlobalVariable() const; | ||
| 78 | boost::optional<EnergyManagementSystemTrendVariable> emsTrendVariable() const; | ||
| 79 | boost::optional<EnergyManagementSystemInternalVariable> emsInternalVariable() const; | ||
| 80 | boost::optional<EnergyManagementSystemCurveOrTableIndexVariable> emsCurveOrTableIndexVariable() const; | ||
| 81 | boost::optional<EnergyManagementSystemConstructionIndexVariable> emsConstructionIndexVariable() const; | ||
| 82 | |||
| 83 | //@} | ||
| 84 | /** @name Setters */ | ||
| 85 | //@{ | ||
| 86 | |||
| 87 | bool setEMSVariableName(const std::string& eMSVariableName); | ||
| 88 | |||
| 89 | bool setNumberOfTimestepsToBeLogged(int numberofTimestepstobeLogged); | ||
| 90 | |||
| 91 | bool setEMSVariableName(const EnergyManagementSystemActuator& object); | ||
| 92 | bool setEMSVariableName(const EnergyManagementSystemSensor& object); | ||
| 93 | bool setEMSVariableName(const EnergyManagementSystemGlobalVariable& object); | ||
| 94 | bool setEMSVariableName(const EnergyManagementSystemTrendVariable& object); | ||
| 95 | bool setEMSVariableName(const EnergyManagementSystemInternalVariable& object); | ||
| 96 | bool setEMSVariableName(const EnergyManagementSystemCurveOrTableIndexVariable& object); | ||
| 97 | bool setEMSVariableName(const EnergyManagementSystemConstructionIndexVariable& object); | ||
| 98 | |||
| 99 | //@} | ||
| 100 | /** @name Other */ | ||
| 101 | //@{ | ||
| 102 | |||
| 103 | //@} | ||
| 104 | protected: | ||
| 105 | /// @cond | ||
| 106 | using ImplType = detail::EnergyManagementSystemTrendVariable_Impl; | ||
| 107 | |||
| 108 | explicit EnergyManagementSystemTrendVariable(std::shared_ptr<detail::EnergyManagementSystemTrendVariable_Impl> impl); | ||
| 109 | |||
| 110 | friend class detail::EnergyManagementSystemTrendVariable_Impl; | ||
| 111 | friend class Model; | ||
| 112 | friend class IdfObject; | ||
| 113 | friend class openstudio::detail::IdfObject_Impl; | ||
| 114 | friend class energyplus::ReverseTranslator; | ||
| 115 | /// @endcond | ||
| 116 | private: | ||
| 117 | − | REGISTER_LOGGER("openstudio.model.EnergyManagementSystemTrendVariable"); | |
| 118 | explicit EnergyManagementSystemTrendVariable(const Model& model); | ||
| 119 | }; | ||
| 120 | |||
| 121 | /** \relates EnergyManagementSystemTrendVariable*/ | ||
| 122 | using OptionalEnergyManagementSystemTrendVariable = boost::optional<EnergyManagementSystemTrendVariable>; | ||
| 123 | |||
| 124 | /** \relates EnergyManagementSystemTrendVariable*/ | ||
| 125 | using EnergyManagementSystemTrendVariableVector = std::vector<EnergyManagementSystemTrendVariable>; | ||
| 126 | |||
| 127 | } // namespace model | ||
| 128 | } // namespace openstudio | ||
| 129 | |||
| 130 | #endif // MODEL_ENERGYMANAGEMENTSYSTEMTRENDVARIABLE_HPP | ||
| 131 |