src/model/Site_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_SITE_IMPL_HPP | ||
| 7 | #define MODEL_SITE_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ParentObject_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | // forward declarations | ||
| 16 | class ClimateZones; | ||
| 17 | class WeatherFile; | ||
| 18 | class SiteGroundReflectance; | ||
| 19 | class SiteGroundTemperatureBuildingSurface; | ||
| 20 | class SiteGroundTemperatureDeep; | ||
| 21 | class SiteGroundTemperatureShallow; | ||
| 22 | class SiteGroundTemperatureFCfactorMethod; | ||
| 23 | class SiteWaterMainsTemperature; | ||
| 24 | class Facility; | ||
| 25 | class ShadingSurfaceGroup; | ||
| 26 | class Site; | ||
| 27 | |||
| 28 | namespace detail { | ||
| 29 | |||
| 30 | /** Site_Impl is a ParentObject_Impl that is the implementation class for Site.*/ | ||
| 31 | class MODEL_API Site_Impl : public ParentObject_Impl | ||
| 32 | { | ||
| 33 | // | ||
| 34 | // | ||
| 35 | public: | ||
| 36 | /** @name Constructors and Destructors */ | ||
| 37 | //@{ | ||
| 38 | |||
| 39 | Site_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 40 | |||
| 41 | Site_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 42 | |||
| 43 | Site_Impl(const Site_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 44 | |||
| 45 | 532 | virtual ~Site_Impl() override = default; | |
| 46 | |||
| 47 | //@} | ||
| 48 | |||
| 49 | // return the parent object in the hierarchy | ||
| 50 | virtual boost::optional<ParentObject> parent() const override; | ||
| 51 | |||
| 52 | // return any children objects in the hierarchy | ||
| 53 | virtual std::vector<ModelObject> children() const override; | ||
| 54 | |||
| 55 | /// get a vector of allowable children types | ||
| 56 | virtual std::vector<IddObjectType> allowableChildTypes() const override; | ||
| 57 | |||
| 58 | // Get all output variable names that could be associated with this object. | ||
| 59 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 60 | |||
| 61 | virtual IddObjectType iddObjectType() const override; | ||
| 62 | |||
| 63 | /** @name Getters */ | ||
| 64 | //@{ | ||
| 65 | |||
| 66 | double latitude() const; | ||
| 67 | |||
| 68 | bool isLatitudeDefaulted() const; | ||
| 69 | |||
| 70 | double longitude() const; | ||
| 71 | |||
| 72 | bool isLongitudeDefaulted() const; | ||
| 73 | |||
| 74 | double timeZone() const; | ||
| 75 | |||
| 76 | bool isTimeZoneDefaulted() const; | ||
| 77 | |||
| 78 | double elevation() const; | ||
| 79 | |||
| 80 | bool isElevationDefaulted() const; | ||
| 81 | |||
| 82 | std::string terrain() const; | ||
| 83 | |||
| 84 | bool isTerrainDefaulted() const; | ||
| 85 | |||
| 86 | bool keepSiteLocationInformation() const; | ||
| 87 | |||
| 88 | bool isKeepSiteLocationInformationDefaulted() const; | ||
| 89 | |||
| 90 | virtual std::vector<EMSActuatorNames> emsActuatorNames() const override; | ||
| 91 | |||
| 92 | virtual std::vector<std::string> emsInternalVariableNames() const override; | ||
| 93 | |||
| 94 | //@} | ||
| 95 | /** @name Setters */ | ||
| 96 | //@{ | ||
| 97 | |||
| 98 | bool setLatitude(double latitude); | ||
| 99 | |||
| 100 | void resetLatitude(); | ||
| 101 | |||
| 102 | bool setLongitude(double longitude); | ||
| 103 | |||
| 104 | void resetLongitude(); | ||
| 105 | |||
| 106 | bool setTimeZone(double timeZone); | ||
| 107 | |||
| 108 | void resetTimeZone(); | ||
| 109 | |||
| 110 | bool setElevation(double elevation); | ||
| 111 | |||
| 112 | void resetElevation(); | ||
| 113 | |||
| 114 | bool setTerrain(const std::string& terrain); | ||
| 115 | |||
| 116 | void resetTerrain(); | ||
| 117 | |||
| 118 | bool setKeepSiteLocationInformation(bool keepSiteLocationInformation); | ||
| 119 | |||
| 120 | void resetKeepSiteLocationInformation(); | ||
| 121 | |||
| 122 | //@} | ||
| 123 | |||
| 124 | /** Unique WeatherFile object parented by Site. */ | ||
| 125 | boost::optional<WeatherFile> weatherFile() const; | ||
| 126 | |||
| 127 | /** Unique SiteGroundReflectance object parented by Site. */ | ||
| 128 | boost::optional<SiteGroundReflectance> siteGroundReflectance() const; | ||
| 129 | |||
| 130 | /** Unique SiteGroundTemperatureBuildingSurface object parented by Site. */ | ||
| 131 | boost::optional<SiteGroundTemperatureBuildingSurface> siteGroundTemperatureBuildingSurface() const; | ||
| 132 | |||
| 133 | /** Unique SiteGroundTemperatureDeep object parented by Site. */ | ||
| 134 | boost::optional<SiteGroundTemperatureDeep> siteGroundTemperatureDeep() const; | ||
| 135 | |||
| 136 | /** Unique SiteGroundTemperatureShallow object parented by Site. */ | ||
| 137 | boost::optional<SiteGroundTemperatureShallow> siteGroundTemperatureShallow() const; | ||
| 138 | |||
| 139 | /** Unique SiteGroundTemperatureFCfactorMethod object parented by Site. */ | ||
| 140 | boost::optional<SiteGroundTemperatureFCfactorMethod> siteGroundTemperatureFCfactorMethod() const; | ||
| 141 | |||
| 142 | /** Unique SiteWaterMainsTemperature object parented by Site. */ | ||
| 143 | boost::optional<SiteWaterMainsTemperature> siteWaterMainsTemperature() const; | ||
| 144 | |||
| 145 | /** Unique ClimateZones object parented by Site. */ | ||
| 146 | boost::optional<ClimateZones> climateZones() const; | ||
| 147 | |||
| 148 | /** ShadingSurfaceGroup objects of type Site. */ | ||
| 149 | std::vector<ShadingSurfaceGroup> shadingSurfaceGroups() const; | ||
| 150 | |||
| 151 | /** The value of the active climate zone in the ClimateZones object. May be empty. */ | ||
| 152 | //std::string activeClimateZoneValue() const; | ||
| 153 | |||
| 154 | /** Set the value of the active climate zone. */ | ||
| 155 | //bool setActiveClimateZoneValue(const std::string& value); | ||
| 156 | |||
| 157 | /** The institution name of the active climate zone in the ClimateZones object. May be empty. */ | ||
| 158 | //std::string activeClimateZoneInstitution() const; | ||
| 159 | |||
| 160 | /** Set the active climate zone institution to institution. */ | ||
| 161 | //bool setActiveClimateZoneInstitution(const std::string& institution); | ||
| 162 | |||
| 163 | protected: | ||
| 164 | private: | ||
| 165 | REGISTER_LOGGER("openstudio.model.Site"); | ||
| 166 | }; | ||
| 167 | |||
| 168 | } // namespace detail | ||
| 169 | |||
| 170 | } // namespace model | ||
| 171 | } // namespace openstudio | ||
| 172 | |||
| 173 | #endif // MODEL_SITE_IMPL_HPP | ||
| 174 |