src/model/AirflowNetworkDistributionLinkage_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_AIRFLOWNETWORKDISTRIBUTIONLINKAGE_IMPL_HPP | ||
| 7 | #define MODEL_AIRFLOWNETWORKDISTRIBUTIONLINKAGE_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | |||
| 11 | #include "AirflowNetworkLinkage_Impl.hpp" | ||
| 12 | |||
| 13 | namespace openstudio { | ||
| 14 | namespace model { | ||
| 15 | |||
| 16 | // TODO: Check the following class names against object getters and setters. | ||
| 17 | class AirflowNetworkNode; | ||
| 18 | class AirflowNetworkComponent; | ||
| 19 | class ThermalZone; | ||
| 20 | |||
| 21 | namespace detail { | ||
| 22 | |||
| 23 | /** AirflowNetworkDistributionLinkage_Impl is a AirflowNetworkLinkage_Impl that is the implementation class for AirflowNetworkDistributionLinkage.*/ | ||
| 24 | class MODEL_API AirflowNetworkDistributionLinkage_Impl : public AirflowNetworkLinkage_Impl | ||
| 25 | { | ||
| 26 | public: | ||
| 27 | /** @name Constructors and Destructors */ | ||
| 28 | //@{ | ||
| 29 | |||
| 30 | AirflowNetworkDistributionLinkage_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 31 | |||
| 32 | AirflowNetworkDistributionLinkage_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 33 | |||
| 34 | AirflowNetworkDistributionLinkage_Impl(const AirflowNetworkDistributionLinkage_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 35 | |||
| 36 | 6 | virtual ~AirflowNetworkDistributionLinkage_Impl() override = default; | |
| 37 | |||
| 38 | //@} | ||
| 39 | /** @name Virtual Methods */ | ||
| 40 | //@{ | ||
| 41 | |||
| 42 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 43 | |||
| 44 | virtual IddObjectType iddObjectType() const override; | ||
| 45 | |||
| 46 | //@} | ||
| 47 | /** @name Getters */ | ||
| 48 | //@{ | ||
| 49 | |||
| 50 | // TODO: Check return type. From object lists, some candidates are: AirflowNetworkNodeAndZone. | ||
| 51 | AirflowNetworkNode node1() const; | ||
| 52 | |||
| 53 | // TODO: Check return type. From object lists, some candidates are: AirflowNetworkNodeAndZone. | ||
| 54 | AirflowNetworkNode node2() const; | ||
| 55 | |||
| 56 | // TODO: Check return type. From object lists, some candidates are: AirflowNetworkComponent. | ||
| 57 | AirflowNetworkComponent component() const; | ||
| 58 | |||
| 59 | // TODO: Check return type. From object lists, some candidates are: Zone. | ||
| 60 | boost::optional<ThermalZone> thermalZone() const; | ||
| 61 | |||
| 62 | //@} | ||
| 63 | /** @name Setters */ | ||
| 64 | //@{ | ||
| 65 | |||
| 66 | /* | ||
| 67 | template <typename T> bool setNode1(const T& airflowNetworkNode) | ||
| 68 | { | ||
| 69 | bool result = setPointer(OS_AirflowNetworkDistributionLinkageFields::Node1Name, airflowNetworkNode.handle()); | ||
| 70 | return result; | ||
| 71 | } | ||
| 72 | |||
| 73 | template <typename T> bool setNode2(const T& airflowNetworkNode) | ||
| 74 | { | ||
| 75 | bool result = setPointer(OS_AirflowNetworkDistributionLinkageFields::Node2Name, airflowNetworkNode.handle()); | ||
| 76 | return result; | ||
| 77 | } | ||
| 78 | |||
| 79 | template <typename T> bool setComponent(const T& airflowNetworkComponent) | ||
| 80 | { | ||
| 81 | bool result = setPointer(OS_AirflowNetworkDistributionLinkageFields::ComponentName, airflowNetworkComponent.handle()); | ||
| 82 | return result; | ||
| 83 | } | ||
| 84 | */ | ||
| 85 | |||
| 86 | bool setNode1(const AirflowNetworkNode& airflowNetworkNode); | ||
| 87 | |||
| 88 | bool setNode2(const AirflowNetworkNode& airflowNetworkNode); | ||
| 89 | |||
| 90 | bool setComponent(const AirflowNetworkComponent& airflowNetworkComponent); | ||
| 91 | |||
| 92 | // TODO: Check argument type. From object lists, some candidates are: Zone. | ||
| 93 | bool setThermalZone(const ThermalZone& zone); | ||
| 94 | |||
| 95 | void resetThermalZone(); | ||
| 96 | |||
| 97 | //@} | ||
| 98 | /** @name Other */ | ||
| 99 | //@{ | ||
| 100 | |||
| 101 | //@} | ||
| 102 | protected: | ||
| 103 | private: | ||
| 104 | − | REGISTER_LOGGER("openstudio.model.AirflowNetworkDistributionLinkage"); | |
| 105 | |||
| 106 | // TODO: Check the return types of these methods. | ||
| 107 | // Optional getters for use by methods like children() so can remove() if the constructor fails. | ||
| 108 | // There are other ways for the public versions of these getters to fail--perhaps all required | ||
| 109 | // objects should be returned as boost::optionals | ||
| 110 | boost::optional<AirflowNetworkNode> optionalNode1() const; | ||
| 111 | boost::optional<AirflowNetworkNode> optionalNode2() const; | ||
| 112 | boost::optional<AirflowNetworkComponent> optionalComponent() const; | ||
| 113 | }; | ||
| 114 | |||
| 115 | } // namespace detail | ||
| 116 | |||
| 117 | } // namespace model | ||
| 118 | } // namespace openstudio | ||
| 119 | |||
| 120 | #endif // MODEL_AIRFLOWNETWORKDISTRIBUTIONLINKAGE_IMPL_HPP | ||
| 121 |