#include <Site.hpp>
Public Member Functions | |
boost::optional< ClimateZones > | climateZones () const |
Unique ClimateZones object parented by Site. More... | |
std::vector< ShadingSurfaceGroup > | shadingSurfaceGroups () const |
ShadingSurfaceGroup objects of type Site. More... | |
boost::optional < SiteGroundReflectance > | siteGroundReflectance () const |
Unique SiteGroundReflectance object parented by Site. More... | |
boost::optional < SiteGroundTemperatureBuildingSurface > | siteGroundTemperatureBuildingSurface () const |
Unique SiteGroundTemperatureBuildingSurface object parented by Site. More... | |
boost::optional < SiteGroundTemperatureDeep > | siteGroundTemperatureDeep () const |
Unique SiteGroundTemperatureDeep object parented by Site. More... | |
boost::optional < SiteGroundTemperatureFCfactorMethod > | siteGroundTemperatureFCfactorMethod () const |
Unique SiteGroundTemperatureFCfactorMethod object parented by Site. More... | |
boost::optional < SiteGroundTemperatureShallow > | siteGroundTemperatureShallow () const |
Unique SiteGroundTemperatureShallow object parented by Site. More... | |
boost::optional < SiteWaterMainsTemperature > | siteWaterMainsTemperature () const |
Unique SiteWaterMainsTemperature object parented by Site. More... | |
boost::optional< WeatherFile > | weatherFile () const |
Unique WeatherFile object parented by Site. More... | |
Constructors and Destructors | |
virtual | ~Site () |
Getters | |
double | latitude () const |
bool | isLatitudeDefaulted () const |
double | longitude () const |
bool | isLongitudeDefaulted () const |
double | timeZone () const |
bool | isTimeZoneDefaulted () const |
double | elevation () const |
bool | isElevationDefaulted () const |
std::string | terrain () const |
bool | isTerrainDefaulted () const |
Setters | |
bool | setLatitude (double latitude) |
void | resetLatitude () |
bool | setLongitude (double longitude) |
void | resetLongitude () |
bool | setTimeZone (double timeZone) |
void | resetTimeZone () |
bool | setElevation (double elevation) |
void | resetElevation () |
bool | setTerrain (std::string terrain) |
void | resetTerrain () |
Public Member Functions inherited from openstudio::model::ParentObject | |
std::vector< IddObjectType > | allowableChildTypes () const |
Returns a vector of allowable children types. More... | |
std::vector< ModelObject > | children () const |
Return direct child objects in the Model. More... | |
virtual | ~ParentObject () |
Public Member Functions inherited from openstudio::model::ModelObject | |
virtual | ~ModelObject () |
ModelObject | clone () const |
Creates a deep copy of this object, placing it in this object's model(). More... | |
ModelObject | clone (Model model) const |
Creates a deep copy of this object, placing it in model. More... | |
Component | createComponent () const |
Method for creating sharable Model snippets. More... | |
Model | model () const |
Returns the Model that contains this object. More... | |
boost::optional< ParentObject > | parent () const |
Return this object's parent in the hierarchy, if it has one. More... | |
std::vector< ResourceObject > | resources () const |
Get the resources directly used by this ModelObject. More... | |
template<typename T > | |
std::vector< T > | getModelObjectSources () const |
Get all objects of type T that point to this object. More... | |
template<typename T > | |
std::vector< T > | getModelObjectSources (IddObjectType iddObjectType) const |
Get all objects of type T that point to this object. More... | |
template<typename T > | |
boost::optional< T > | getModelObjectTarget (unsigned index) const |
Get the object of type T pointed to by this object from field index. More... | |
template<typename T > | |
std::vector< T > | getModelObjectTargets () const |
Get all objects of type T to which this object points. More... | |
const std::vector< std::string > & | outputVariableNames () const |
Get all output variables names that could be associated with this object. More... | |
std::vector< OutputVariable > | outputVariables () const |
Get all output variables associated with this object, must run simulation to generate data. More... | |
boost::optional < openstudio::TimeSeries > | getData (const OutputVariable &variable, const std::string &envPeriod) const |
Get data associated with this output variable and this object. More... | |
std::vector< LifeCycleCost > | lifeCycleCosts () const |
Returns the list of all LifeCycleCosts that refer to this object. More... | |
std::vector< IdfObject > | removeLifeCycleCosts () |
Removes all LifeCycleCosts that refer to this object. More... | |
IddObjectType | iddObjectType () const |
This is a virtual function that will tell you the type of iddObject you are dealing with. More... | |
AdditionalProperties | additionalProperties () const |
Returns this object's additional properties, constructing a new object if necessary. More... | |
bool | hasAdditionalProperties () const |
Returns true if this object has additional properties. More... | |
std::vector< IdfObject > | removeAdditionalProperties () |
Removes all additional properties that refer to this object. More... | |
boost::optional< std::string > | cadObjectId () const |
bool | setCADObjectId (const std::string &cadObjectId) |
boost::optional< std::string > | gbXMLId () const |
bool | setGBXMLId (const std::string &gbXMLId) |
boost::optional< std::string > | displayName () const |
bool | setDisplayName (const std::string &displayName) |
bool | setParent (ParentObject &newParent) |
set the parent, child may have to call non-const methods on the parent More... | |
bool | operator< (const ModelObject &right) const |
bool | operator== (const ModelObject &other) const |
equality test More... | |
bool | operator!= (const ModelObject &other) const |
inequality test More... | |
std::vector< ScheduleTypeKey > | getScheduleTypeKeys (const Schedule &schedule) const |
Return the ScheduleTypeKeys indicating how schedule is used in this object. More... | |
boost::optional< double > | getAutosizedValue (std::string valueName, std::string unitString) const |
Gets the autosized component value from the sql file. More... | |
virtual std::vector < EMSActuatorNames > | emsActuatorNames () const |
Return the names of the available ems actuators. More... | |
virtual std::vector< std::string > | emsInternalVariableNames () const |
Return the names of the available ems internal variables. More... | |
boost::optional< ModelObject > | connectedObject (unsigned port) const |
boost::optional< unsigned > | connectedObjectPort (unsigned port) const |
Static Public Member Functions | |
Static Methods | |
static IddObjectType | iddObjectType () |
static std::vector< std::string > | validTerrainValues () |
Related Functions | |
(Note that these are not member functions.) | |
typedef boost::optional< Site > | OptionalSite |
typedef std::vector< Site > | SiteVector |
Related Functions inherited from openstudio::model::ParentObject | |
std::vector< ModelObject > | getRecursiveChildren (const ParentObject &object, bool includeLifeCycleCostsAndAdditionalProperties=false, bool includeUsedResources=true) |
Returns object and all other objects accessible by calling children() on encountered ParentObjects . More... | |
std::vector< ModelObject > | getRecursiveChildrenAndResources (const ModelObject &object) |
Returns object and all other objects accessible by calling children() and resources() on encountered ModelObjects . More... | |
Related Functions inherited from openstudio::model::ModelObject | |
std::vector< ResourceObject > | getRecursiveResources (const ModelObject &object) |
Returns all ResourceObjects accessible by recursively calling .resources() starting from object. More... | |
Additional Inherited Members | |
Protected Types inherited from openstudio::model::ModelObject | |
typedef detail::ModelObject_Impl | ImplType |
Protected Member Functions inherited from openstudio::model::ParentObject | |
ParentObject (IddObjectType type, const Model &model) | |
Constructs a new ParentObject object in the model. More... | |
Protected Member Functions inherited from openstudio::model::ModelObject | |
ModelObject (IddObjectType type, const Model &model, bool fastName=false) | |
ModelObject (std::shared_ptr< detail::ModelObject_Impl > impl) | |
Site is a ParentObject that wraps the OpenStudio IDD object 'OS_Site'.
|
inlinevirtual |
boost::optional<ClimateZones> openstudio::model::Site::climateZones | ( | ) | const |
Unique ClimateZones object parented by Site.
double openstudio::model::Site::elevation | ( | ) | const |
|
static |
bool openstudio::model::Site::isElevationDefaulted | ( | ) | const |
bool openstudio::model::Site::isLatitudeDefaulted | ( | ) | const |
bool openstudio::model::Site::isLongitudeDefaulted | ( | ) | const |
bool openstudio::model::Site::isTerrainDefaulted | ( | ) | const |
bool openstudio::model::Site::isTimeZoneDefaulted | ( | ) | const |
double openstudio::model::Site::latitude | ( | ) | const |
double openstudio::model::Site::longitude | ( | ) | const |
void openstudio::model::Site::resetElevation | ( | ) |
void openstudio::model::Site::resetLatitude | ( | ) |
void openstudio::model::Site::resetLongitude | ( | ) |
void openstudio::model::Site::resetTerrain | ( | ) |
void openstudio::model::Site::resetTimeZone | ( | ) |
bool openstudio::model::Site::setElevation | ( | double | elevation | ) |
bool openstudio::model::Site::setLatitude | ( | double | latitude | ) |
bool openstudio::model::Site::setLongitude | ( | double | longitude | ) |
bool openstudio::model::Site::setTerrain | ( | std::string | terrain | ) |
bool openstudio::model::Site::setTimeZone | ( | double | timeZone | ) |
std::vector<ShadingSurfaceGroup> openstudio::model::Site::shadingSurfaceGroups | ( | ) | const |
ShadingSurfaceGroup objects of type Site.
boost::optional<SiteGroundReflectance> openstudio::model::Site::siteGroundReflectance | ( | ) | const |
Unique SiteGroundReflectance object parented by Site.
boost::optional<SiteGroundTemperatureBuildingSurface> openstudio::model::Site::siteGroundTemperatureBuildingSurface | ( | ) | const |
Unique SiteGroundTemperatureBuildingSurface object parented by Site.
boost::optional<SiteGroundTemperatureDeep> openstudio::model::Site::siteGroundTemperatureDeep | ( | ) | const |
Unique SiteGroundTemperatureDeep object parented by Site.
boost::optional<SiteGroundTemperatureFCfactorMethod> openstudio::model::Site::siteGroundTemperatureFCfactorMethod | ( | ) | const |
Unique SiteGroundTemperatureFCfactorMethod object parented by Site.
boost::optional<SiteGroundTemperatureShallow> openstudio::model::Site::siteGroundTemperatureShallow | ( | ) | const |
Unique SiteGroundTemperatureShallow object parented by Site.
boost::optional<SiteWaterMainsTemperature> openstudio::model::Site::siteWaterMainsTemperature | ( | ) | const |
Unique SiteWaterMainsTemperature object parented by Site.
std::string openstudio::model::Site::terrain | ( | ) | const |
double openstudio::model::Site::timeZone | ( | ) | const |
|
static |
boost::optional<WeatherFile> openstudio::model::Site::weatherFile | ( | ) | const |
Unique WeatherFile object parented by Site.
|
related |
|
related |