GCC Code Coverage Report


Directory: ./
Coverage: low: ≥ 0% medium: ≥ 75.0% high: ≥ 90.0%
Coverage Exec / Excl / Total
Lines: 20.0% 1 / 1 / 6
Functions: 20.0% 1 / 1 / 6
Branches: -% 0 / 1 / 1

src/model/ExternalInterfaceActuator.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_EXTERNALINTERFACEACTUATOR_HPP
7 #define MODEL_EXTERNALINTERFACEACTUATOR_HPP
8
9 #include "ModelAPI.hpp"
10 #include "ModelObject.hpp"
11
12 namespace openstudio {
13
14 namespace model {
15
16 namespace detail {
17
18 class ExternalInterfaceActuator_Impl;
19
20 } // namespace detail
21
22 /** ExternalInterfaceActuator is a ModelObject that wraps the OpenStudio IDD object 'OS:ExternalInterface:Actuator'. */
23 class MODEL_API ExternalInterfaceActuator : public ModelObject
24 {
25 public:
26 /** @name Constructors and Destructors */
27 //@{
28
29 explicit ExternalInterfaceActuator(const ModelObject& modelObject);
30
31 explicit ExternalInterfaceActuator(const ModelObject& modelObject, const std::string actuatedComponentType,
32 const std::string actuatedComponentControlType);
33
34 4 virtual ~ExternalInterfaceActuator() override = default;
35 // Default the copy and move operators because the virtual dtor is explicit
36 ✗ ExternalInterfaceActuator(const ExternalInterfaceActuator& other) = default;
37 ✗ ExternalInterfaceActuator(ExternalInterfaceActuator&& other) = default;
38 ✗ ExternalInterfaceActuator& operator=(const ExternalInterfaceActuator&) = default;
39 ✗ ExternalInterfaceActuator& operator=(ExternalInterfaceActuator&&) = default;
40
41 //@}
42
43 static IddObjectType iddObjectType();
44
45 /** @name Getters */
46 //@{
47
48 ModelObject actuatedComponentUnique() const;
49
50 std::string actuatedComponentType() const;
51
52 std::string actuatedComponentControlType() const;
53
54 boost::optional<double> optionalInitialValue() const;
55
56 bool exportToBCVTB() const;
57
58 bool isExportToBCVTBDefaulted() const;
59
60 //@}
61 /** @name Setters */
62 //@{
63
64 bool setActuatedComponentUnique(const ModelObject& modelObject);
65
66 bool setActuatedComponentType(const std::string& actuatedComponentType);
67
68 bool setActuatedComponentControlType(const std::string& actuatedComponentControlType);
69
70 bool setOptionalInitialValue(double optionalInitialValue);
71
72 void resetOptionalInitialValue();
73
74 bool setExportToBCVTB(bool exportToBCVTB);
75
76 void resetExportToBCVTB();
77
78 //@}
79 /** @name Other */
80 //@{
81
82 //@}
83 protected:
84 /// @cond
85 using ImplType = detail::ExternalInterfaceActuator_Impl;
86
87 explicit ExternalInterfaceActuator(std::shared_ptr<detail::ExternalInterfaceActuator_Impl> impl);
88
89 friend class detail::ExternalInterfaceActuator_Impl;
90 friend class Model;
91 friend class IdfObject;
92 friend class openstudio::detail::IdfObject_Impl;
93 /// @endcond
94 private:
95 − REGISTER_LOGGER("openstudio.model.ExternalInterfaceActuator");
96 };
97
98 /** \relates ExternalInterfaceActuator*/
99 using OptionalExternalInterfaceActuator = boost::optional<ExternalInterfaceActuator>;
100
101 /** \relates ExternalInterfaceActuator*/
102 using ExternalInterfaceActuatorVector = std::vector<ExternalInterfaceActuator>;
103
104 } // namespace model
105 } // namespace openstudio
106
107 #endif // MODEL_EXTERNALINTERFACEACTUATOR_HPP
108