GCC Code Coverage Report


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

src/model/ComponentCostAdjustments.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_COMPONENTCOSTADJUSTMENTS_HPP
7 #define MODEL_COMPONENTCOSTADJUSTMENTS_HPP
8
9 #include "ModelAPI.hpp"
10 #include "ParentObject.hpp"
11
12 #include "../utilities/core/Optional.hpp"
13
14 namespace openstudio {
15 namespace model {
16
17 namespace detail {
18 class ComponentCostAdjustments_Impl;
19 }
20
21 /** ComponentCostAdjustments derives from ParentObject and is an interface to the OpenStudio IDD object named "OS:ComponentCost:Adjustments".
22 *
23 * ComponentCostAdjustments is a unique object which modifies the construction costs calculated by ComponentCost_LineItem
24 * objects.
25 *
26 * \todo The IDD object "OS:ComponentCost:Adjustments" should be marked as unique
27 *
28 */
29 class MODEL_API ComponentCostAdjustments : public ParentObject
30 {
31 public:
32 /** @name Constructors and Destructors */
33 //@{
34
35 ✗ virtual ~ComponentCostAdjustments() override = default;
36 // Default the copy and move operators because the virtual dtor is explicit
37 ComponentCostAdjustments(const ComponentCostAdjustments& other) = default;
38 ComponentCostAdjustments(ComponentCostAdjustments&& other) = default;
39 ComponentCostAdjustments& operator=(const ComponentCostAdjustments&) = default;
40 ComponentCostAdjustments& operator=(ComponentCostAdjustments&&) = default;
41
42 //@}
43 /** @name Getters */
44 //@{
45
46 boost::optional<double> miscellaneousCostPerConditionedArea() const;
47
48 boost::optional<double> designAndEngineeringFees() const;
49
50 boost::optional<double> contractorFee() const;
51
52 boost::optional<double> contingency() const;
53
54 boost::optional<double> permitsBondingAndInsurance() const;
55
56 boost::optional<double> commissioningFee() const;
57
58 boost::optional<double> regionalAdjustmentFactor() const;
59
60 //@}
61 /** @name Setters */
62 //@{
63
64 bool setMiscellaneousCostPerConditionedArea(double miscellaneousCostPerConditionedArea);
65
66 bool setDesignAndEngineeringFees(double designAndEngineeringFees);
67
68 bool setContractorFee(double contractorFee);
69
70 bool setContingency(double contingency);
71
72 bool setPermitsBondingAndInsurance(double permitsBondingAndInsurance);
73
74 bool setCommissioningFee(double commissioningFee);
75
76 bool setRegionalAdjustmentFactor(double regionalAdjustmentFactor);
77
78 //@}
79
80 /// Returns the IddObjectType.
81 static IddObjectType iddObjectType();
82
83 protected:
84 /// @cond
85
86 using ImplType = detail::ComponentCostAdjustments_Impl;
87
88 friend class Model;
89 friend class IdfObject;
90
91 /// Constructs a new ComponentCostAdjustments object in the model.
92 explicit ComponentCostAdjustments(const Model& model);
93
94 // constructor
95 explicit ComponentCostAdjustments(std::shared_ptr<detail::ComponentCostAdjustments_Impl> impl);
96
97 private:
98 REGISTER_LOGGER("openstudio.model.ComponentCostAdjustments");
99
100 /// @endcond
101 };
102
103 /** \relates ComponentCostAdjustments */
104 using OptionalComponentCostAdjustments = boost::optional<ComponentCostAdjustments>;
105
106 /** \relates ComponentCostAdjustments */
107 using ComponentCostAdjustmentsVector = std::vector<ComponentCostAdjustments>;
108
109 } // namespace model
110 } // namespace openstudio
111
112 #endif // MODEL_COMPONENTCOSTADJUSTMENTS_HPP
113