Site Class Reference

#include "Site.hpp"

Inheritance diagram for openstudio::model::Site:

Public Member Functions
boost::optional< ClimateZones >	climateZones () const
std::vector< ShadingSurfaceGroup >	shadingSurfaceGroups () const
boost::optional < SiteGroundReflectance >	siteGroundReflectance () const
boost::optional < SiteGroundTemperatureBuildingSurface >	siteGroundTemperatureBuildingSurface () const
boost::optional < SiteGroundTemperatureDeep >	siteGroundTemperatureDeep () const
boost::optional < SiteGroundTemperatureFCfactorMethod >	siteGroundTemperatureFCfactorMethod () const
boost::optional < SiteGroundTemperatureShallow >	siteGroundTemperatureShallow () const
boost::optional < SiteWaterMainsTemperature >	siteWaterMainsTemperature () const
boost::optional< WeatherFile >	weatherFile () const
virtual	~Site ()=default
	Site (const Site &other)=default
	Site (Site &&other)=default
Site &	operator= (const Site &)=default
Site &	operator= (Site &&)=default
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
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 (const std::string &terrain)
void	resetTerrain ()

Static Public Member Functions
static IddObjectType	iddObjectType ()
static std::vector< std::string >	validTerrainValues ()

Related Functions
using	OptionalSite = boost::optional< Site >
using	SiteVector = std::vector< Site >

Detailed Description

Site is a ParentObject that wraps the OpenStudio IDD object 'OS_Site'.

Constructor & Destructor Documentation

virtual openstudio::model::Site::~Site ( )

virtualdefault

openstudio::model::Site::Site ( const Site &  other )

default

openstudio::model::Site::Site ( Site &&  other )

default

Member Function Documentation

boost::optional<ClimateZones> openstudio::model::Site::climateZones

(

)

const

Unique ClimateZones object parented by Site.

double openstudio::model::Site::elevation

(

)

const

static IddObjectType openstudio::model::Site::iddObjectType ( )

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

Site& openstudio::model::Site::operator= ( const Site &  )

default

Site& openstudio::model::Site::operator= ( Site &&  )

default

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

(

const 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 std::vector<std::string> openstudio::model::Site::validTerrainValues ( )

static

boost::optional<WeatherFile> openstudio::model::Site::weatherFile

(

)

const

Unique WeatherFile object parented by Site.

Friends And Related Function Documentation

using OptionalSite = boost::optional<Site>

related

using SiteVector = std::vector<Site>

related