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/CurrencyType.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_CURRENCYTYPE_HPP
7 #define MODEL_CURRENCYTYPE_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 CurrencyType_Impl;
19 }
20
21 /** CurrencyType derives from ParentObject and is an interface to the OpenStudio IDD object named "OS:CurrencyType".
22 *
23 * CurrencyType is a unique object used to specify the currency that cost data are entered and presented in for this Model.
24 */
25 class MODEL_API CurrencyType : public ParentObject
26 {
27
28 public:
29 ✗ virtual ~CurrencyType() override = default;
30 // Default the copy and move operators because the virtual dtor is explicit
31 CurrencyType(const CurrencyType& other) = default;
32 CurrencyType(CurrencyType&& other) = default;
33 CurrencyType& operator=(const CurrencyType&) = default;
34 CurrencyType& operator=(CurrencyType&&) = default;
35
36 /** @name Getters */
37 //@{
38
39 boost::optional<std::string> monetaryUnit() const;
40
41 //@}
42 /** @name Setters */
43 //@{
44
45 bool setMonetaryUnit(const std::string& monetaryUnit);
46
47 //@}
48
49 /// Returns the IddObjectType.
50 static IddObjectType iddObjectType();
51
52 protected:
53 /** @name Constructors and Destructors */
54 //@{
55
56 /// Constructs a new CurrencyType object in the model.
57 explicit CurrencyType(const Model& model);
58
59 //@}
60
61 /// @cond
62
63 using ImplType = detail::CurrencyType_Impl;
64
65 friend class Model;
66 friend class IdfObject;
67
68 // constructor
69 explicit CurrencyType(std::shared_ptr<detail::CurrencyType_Impl> impl);
70
71 private:
72 REGISTER_LOGGER("openstudio.model.CurrencyType");
73
74 /// @endcond
75 };
76
77 /** \relates CurrencyType */
78 using OptionalCurrencyType = boost::optional<CurrencyType>;
79
80 /** \relates CurrencyType */
81 using CurrencyTypeVector = std::vector<CurrencyType>;
82
83 } // namespace model
84 } // namespace openstudio
85
86 #endif // MODEL_CURRENCYTYPE_HPP
87