src/model/OutputTableSummaryReports_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_OUTPUTTABLESUMMARYREPORTS_IMPL_HPP | ||
| 7 | #define MODEL_OUTPUTTABLESUMMARYREPORTS_IMPL_HPP | ||
| 8 | |||
| 9 | #include <vector> | ||
| 10 | #include "ModelAPI.hpp" | ||
| 11 | #include "ModelObject_Impl.hpp" | ||
| 12 | |||
| 13 | namespace openstudio { | ||
| 14 | namespace model { | ||
| 15 | |||
| 16 | namespace detail { | ||
| 17 | |||
| 18 | /** OutputTableSummaryReports_Impl is a ModelObject_Impl that is the implementation class for OutputTableSummaryReports.*/ | ||
| 19 | class MODEL_API OutputTableSummaryReports_Impl : public ModelObject_Impl | ||
| 20 | { | ||
| 21 | |||
| 22 | public: | ||
| 23 | /** @name Constructors and Destructors */ | ||
| 24 | //@{ | ||
| 25 | |||
| 26 | OutputTableSummaryReports_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 27 | |||
| 28 | OutputTableSummaryReports_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 29 | |||
| 30 | OutputTableSummaryReports_Impl(const OutputTableSummaryReports_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 31 | |||
| 32 | 902 | virtual ~OutputTableSummaryReports_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 | std::vector<std::string> summaryReports() const; | ||
| 47 | |||
| 48 | unsigned int numberofSummaryReports() const; | ||
| 49 | |||
| 50 | boost::optional<unsigned> summaryReportIndex(const std::string& summaryReport) const; | ||
| 51 | |||
| 52 | boost::optional<std::string> getSummaryReport(unsigned groupIndex) const; | ||
| 53 | |||
| 54 | //@} | ||
| 55 | /** @name Setters */ | ||
| 56 | //@{ | ||
| 57 | |||
| 58 | bool addSummaryReport(const std::string& summaryReport); | ||
| 59 | |||
| 60 | bool addSummaryReports(const std::vector<std::string>& summaryReports); | ||
| 61 | |||
| 62 | bool removeSummaryReport(unsigned groupIndex); | ||
| 63 | |||
| 64 | void removeAllSummaryReports(); | ||
| 65 | |||
| 66 | // Just a convenience function to add 'AllSummary' as a key since it's so common | ||
| 67 | bool enableAllSummaryReport(); | ||
| 68 | |||
| 69 | //@} | ||
| 70 | /** @name Other */ | ||
| 71 | //@{ | ||
| 72 | |||
| 73 | //@} | ||
| 74 | protected: | ||
| 75 | private: | ||
| 76 | − | REGISTER_LOGGER("openstudio.model.OutputTableSummaryReports"); | |
| 77 | }; | ||
| 78 | |||
| 79 | } // namespace detail | ||
| 80 | |||
| 81 | } // namespace model | ||
| 82 | } // namespace openstudio | ||
| 83 | |||
| 84 | #endif // MODEL_OUTPUTTABLESUMMARYREPORTS_IMPL_HPP | ||
| 85 |