src/model/EnergyManagementSystemOutputVariable_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_ENERGYMANAGEMENTSYSTEMOUTPUTVARIABLE_IMPL_HPP | ||
| 7 | #define MODEL_ENERGYMANAGEMENTSYSTEMOUTPUTVARIABLE_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ModelObject_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | namespace detail { | ||
| 16 | |||
| 17 | /** EnergyManagementSystemOutputVariable_Impl is a ModelObject_Impl that is the implementation class for EnergyManagementSystemOutputVariable.*/ | ||
| 18 | class MODEL_API EnergyManagementSystemOutputVariable_Impl : public ModelObject_Impl | ||
| 19 | { | ||
| 20 | public: | ||
| 21 | /** @name Constructors and Destructors */ | ||
| 22 | //@{ | ||
| 23 | |||
| 24 | EnergyManagementSystemOutputVariable_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 25 | |||
| 26 | EnergyManagementSystemOutputVariable_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 27 | |||
| 28 | EnergyManagementSystemOutputVariable_Impl(const EnergyManagementSystemOutputVariable_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 29 | |||
| 30 | 24 | virtual ~EnergyManagementSystemOutputVariable_Impl() override = default; | |
| 31 | |||
| 32 | //@} | ||
| 33 | /** @name Virtual Methods */ | ||
| 34 | //@{ | ||
| 35 | |||
| 36 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 37 | |||
| 38 | virtual IddObjectType iddObjectType() const override; | ||
| 39 | |||
| 40 | //@} | ||
| 41 | /** @name Getters */ | ||
| 42 | //@{ | ||
| 43 | |||
| 44 | std::string emsVariableName() const; | ||
| 45 | |||
| 46 | std::string typeOfDataInVariable() const; | ||
| 47 | |||
| 48 | std::string updateFrequency() const; | ||
| 49 | |||
| 50 | std::string emsProgramOrSubroutineName() const; | ||
| 51 | |||
| 52 | boost::optional<EnergyManagementSystemProgram> emsProgram() const; | ||
| 53 | |||
| 54 | boost::optional<EnergyManagementSystemSubroutine> emsSubroutine() const; | ||
| 55 | |||
| 56 | std::string units() const; | ||
| 57 | |||
| 58 | boost::optional<ModelObject> emsVariableObject() const; | ||
| 59 | |||
| 60 | boost::optional<EnergyManagementSystemActuator> emsActuator() const; | ||
| 61 | boost::optional<EnergyManagementSystemSensor> emsSensor() const; | ||
| 62 | boost::optional<EnergyManagementSystemGlobalVariable> emsGlobalVariable() const; | ||
| 63 | boost::optional<EnergyManagementSystemTrendVariable> emsTrendVariable() const; | ||
| 64 | boost::optional<EnergyManagementSystemInternalVariable> emsInternalVariable() const; | ||
| 65 | boost::optional<EnergyManagementSystemCurveOrTableIndexVariable> emsCurveOrTableIndexVariable() const; | ||
| 66 | boost::optional<EnergyManagementSystemConstructionIndexVariable> emsConstructionIndexVariable() const; | ||
| 67 | |||
| 68 | bool exportToBCVTB() const; | ||
| 69 | |||
| 70 | bool isExportToBCVTBDefaulted() const; | ||
| 71 | |||
| 72 | //@} | ||
| 73 | /** @name Setters */ | ||
| 74 | //@{ | ||
| 75 | |||
| 76 | bool setEMSVariableName(const std::string& eMSVariableName); | ||
| 77 | |||
| 78 | bool setTypeOfDataInVariable(const std::string& typeofDatainVariable); | ||
| 79 | |||
| 80 | bool setUpdateFrequency(const std::string& updateFrequency); | ||
| 81 | |||
| 82 | bool setEMSProgramOrSubroutineName(const EnergyManagementSystemProgram& program); | ||
| 83 | |||
| 84 | bool setEMSProgramOrSubroutineName(const EnergyManagementSystemSubroutine& subroutine); | ||
| 85 | |||
| 86 | void resetEMSProgramOrSubroutineName(); | ||
| 87 | |||
| 88 | bool setUnits(const std::string& units); | ||
| 89 | |||
| 90 | void resetUnits(); | ||
| 91 | |||
| 92 | bool setEMSVariableName(const EnergyManagementSystemActuator& object); | ||
| 93 | bool setEMSVariableName(const EnergyManagementSystemSensor& object); | ||
| 94 | bool setEMSVariableName(const EnergyManagementSystemGlobalVariable& object); | ||
| 95 | bool setEMSVariableName(const EnergyManagementSystemTrendVariable& object); | ||
| 96 | bool setEMSVariableName(const EnergyManagementSystemInternalVariable& object); | ||
| 97 | bool setEMSVariableName(const EnergyManagementSystemCurveOrTableIndexVariable& object); | ||
| 98 | bool setEMSVariableName(const EnergyManagementSystemConstructionIndexVariable& object); | ||
| 99 | |||
| 100 | bool setExportToBCVTB(bool exportToBCVTB); | ||
| 101 | |||
| 102 | void resetExportToBCVTB(); | ||
| 103 | |||
| 104 | //@} | ||
| 105 | /** @name Other */ | ||
| 106 | //@{ | ||
| 107 | |||
| 108 | //@} | ||
| 109 | protected: | ||
| 110 | private: | ||
| 111 | REGISTER_LOGGER("openstudio.model.EnergyManagementSystemOutputVariable"); | ||
| 112 | }; | ||
| 113 | |||
| 114 | } // namespace detail | ||
| 115 | |||
| 116 | } // namespace model | ||
| 117 | } // namespace openstudio | ||
| 118 | |||
| 119 | #endif // MODEL_ENERGYMANAGEMENTSYSTEMOUTPUTVARIABLE_IMPL_HPP | ||
| 120 |