src/model/OutputTableAnnual_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_OUTPUTTABLEANNUAL_IMPL_HPP | ||
| 7 | #define MODEL_OUTPUTTABLEANNUAL_IMPL_HPP | ||
| 8 | |||
| 9 | #include <model/ModelAPI.hpp> | ||
| 10 | #include "ModelObject_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class AnnualVariableGroup; | ||
| 16 | class Schedule; | ||
| 17 | |||
| 18 | namespace detail { | ||
| 19 | |||
| 20 | /** OutputTableAnnual_Impl is a ModelObject_Impl that is the implementation class for OutputTableAnnual.*/ | ||
| 21 | class MODEL_API OutputTableAnnual_Impl : public ModelObject_Impl | ||
| 22 | { | ||
| 23 | public: | ||
| 24 | /** @name Constructors and Destructors */ | ||
| 25 | //@{ | ||
| 26 | |||
| 27 | OutputTableAnnual_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 28 | |||
| 29 | OutputTableAnnual_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 30 | |||
| 31 | OutputTableAnnual_Impl(const OutputTableAnnual_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 32 | |||
| 33 | 7 | virtual ~OutputTableAnnual_Impl() override = default; | |
| 34 | |||
| 35 | //@} | ||
| 36 | /** @name Virtual Methods */ | ||
| 37 | //@{ | ||
| 38 | |||
| 39 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 40 | |||
| 41 | virtual IddObjectType iddObjectType() const override; | ||
| 42 | |||
| 43 | virtual std::vector<ScheduleTypeKey> getScheduleTypeKeys(const Schedule& schedule) const override; | ||
| 44 | |||
| 45 | //@} | ||
| 46 | /** @name Getters */ | ||
| 47 | //@{ | ||
| 48 | |||
| 49 | boost::optional<std::string> filter() const; | ||
| 50 | |||
| 51 | boost::optional<Schedule> schedule() const; | ||
| 52 | |||
| 53 | //@} | ||
| 54 | /** @name Setters */ | ||
| 55 | //@{ | ||
| 56 | |||
| 57 | bool setFilter(const std::string& filter); | ||
| 58 | |||
| 59 | void resetFilter(); | ||
| 60 | |||
| 61 | bool setSchedule(Schedule& schedule); | ||
| 62 | |||
| 63 | void resetSchedule(); | ||
| 64 | |||
| 65 | //@} | ||
| 66 | /** @name Other */ | ||
| 67 | //@{ | ||
| 68 | |||
| 69 | // Handle this object's extensible fields. | ||
| 70 | std::vector<AnnualVariableGroup> annualVariableGroups() const; | ||
| 71 | |||
| 72 | unsigned int numberofAnnualVariableGroups() const; | ||
| 73 | |||
| 74 | boost::optional<unsigned> annualVariableGroupIndex(const AnnualVariableGroup& annualVariableGroup) const; | ||
| 75 | boost::optional<AnnualVariableGroup> getAnnualVariableGroup(unsigned groupIndex) const; | ||
| 76 | |||
| 77 | bool addAnnualVariableGroup(const AnnualVariableGroup& annualVariableGroup); | ||
| 78 | bool addAnnualVariableGroups(const std::vector<AnnualVariableGroup>& annualVariableGroups); | ||
| 79 | bool removeAnnualVariableGroup(unsigned groupIndex); | ||
| 80 | void removeAllAnnualVariableGroups(); | ||
| 81 | |||
| 82 | //@} | ||
| 83 | protected: | ||
| 84 | private: | ||
| 85 | − | REGISTER_LOGGER("openstudio.model.OutputTableAnnual"); | |
| 86 | }; | ||
| 87 | |||
| 88 | } // namespace detail | ||
| 89 | |||
| 90 | } // namespace model | ||
| 91 | } // namespace openstudio | ||
| 92 | |||
| 93 | #endif // MODEL_OUTPUTTABLEANNUAL_IMPL_HPP | ||
| 94 |