src/model/PythonPluginOutputVariable_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_PYTHONPLUGINOUTPUTVARIABLE_IMPL_HPP | ||
| 7 | #define MODEL_PYTHONPLUGINOUTPUTVARIABLE_IMPL_HPP | ||
| 8 | |||
| 9 | #include <model/ModelAPI.hpp> | ||
| 10 | #include "ModelObject_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class PythonPluginVariable; | ||
| 16 | |||
| 17 | namespace detail { | ||
| 18 | |||
| 19 | /** PythonPluginOutputVariable_Impl is a ModelObject_Impl that is the implementation class for PythonPluginOutputVariable.*/ | ||
| 20 | class MODEL_API PythonPluginOutputVariable_Impl : public ModelObject_Impl | ||
| 21 | { | ||
| 22 | public: | ||
| 23 | /** @name Constructors and Destructors */ | ||
| 24 | //@{ | ||
| 25 | |||
| 26 | PythonPluginOutputVariable_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 27 | |||
| 28 | PythonPluginOutputVariable_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 29 | |||
| 30 | PythonPluginOutputVariable_Impl(const PythonPluginOutputVariable_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 31 | |||
| 32 | 23 | virtual ~PythonPluginOutputVariable_Impl() override = default; | |
| 33 | |||
| 34 | //@} | ||
| 35 | /** @name Virtual Methods */ | ||
| 36 | //@{ | ||
| 37 | |||
| 38 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 39 | |||
| 40 | virtual IddObjectType iddObjectType() const override; | ||
| 41 | |||
| 42 | //@} | ||
| 43 | /** @name Getters */ | ||
| 44 | //@{ | ||
| 45 | |||
| 46 | PythonPluginVariable pythonPluginVariable() const; | ||
| 47 | |||
| 48 | std::string typeofDatainVariable() const; | ||
| 49 | |||
| 50 | std::string updateFrequency() const; | ||
| 51 | |||
| 52 | boost::optional<std::string> units() const; | ||
| 53 | |||
| 54 | boost::optional<std::string> resourceType() const; | ||
| 55 | |||
| 56 | boost::optional<std::string> groupType() const; | ||
| 57 | |||
| 58 | boost::optional<std::string> endUseCategory() const; | ||
| 59 | |||
| 60 | boost::optional<std::string> endUseSubcategory() const; | ||
| 61 | |||
| 62 | //@} | ||
| 63 | /** @name Setters */ | ||
| 64 | //@{ | ||
| 65 | |||
| 66 | bool setPythonPluginVariable(const PythonPluginVariable& pythonPluginVariable); | ||
| 67 | |||
| 68 | bool setTypeofDatainVariable(const std::string& typeofDatainVariable); | ||
| 69 | |||
| 70 | bool setUpdateFrequency(const std::string& updateFrequency); | ||
| 71 | |||
| 72 | bool setUnits(const std::string& units); | ||
| 73 | |||
| 74 | void resetUnits(); | ||
| 75 | |||
| 76 | bool setResourceType(const std::string& resourceType); | ||
| 77 | |||
| 78 | void resetResourceType(); | ||
| 79 | |||
| 80 | bool setGroupType(const std::string& groupType); | ||
| 81 | |||
| 82 | void resetGroupType(); | ||
| 83 | |||
| 84 | bool setEndUseCategory(const std::string& endUseCategory); | ||
| 85 | |||
| 86 | void resetEndUseCategory(); | ||
| 87 | |||
| 88 | bool setEndUseSubcategory(const std::string& endUseSubcategory); | ||
| 89 | |||
| 90 | void resetEndUseSubcategory(); | ||
| 91 | |||
| 92 | //@} | ||
| 93 | /** @name Other */ | ||
| 94 | //@{ | ||
| 95 | |||
| 96 | //@} | ||
| 97 | protected: | ||
| 98 | private: | ||
| 99 | − | REGISTER_LOGGER("openstudio.model.PythonPluginOutputVariable"); | |
| 100 | |||
| 101 | // Optional getters for use by methods like children() so can remove() if the constructor fails. | ||
| 102 | // There are other ways for the public versions of these getters to fail--perhaps all required | ||
| 103 | // objects should be returned as boost::optionals | ||
| 104 | boost::optional<PythonPluginVariable> optionalPythonPluginVariable() const; | ||
| 105 | }; | ||
| 106 | |||
| 107 | } // namespace detail | ||
| 108 | |||
| 109 | } // namespace model | ||
| 110 | } // namespace openstudio | ||
| 111 | |||
| 112 | #endif // MODEL_PYTHONPLUGINOUTPUTVARIABLE_IMPL_HPP | ||
| 113 |