openstudio::model::SiteGroundTemperatureBuildingSurface Class Reference

#include <SiteGroundTemperatureBuildingSurface.hpp>

Inheritance diagram for openstudio::model::SiteGroundTemperatureBuildingSurface:

Public Member Functions
Constructors and Destructors
	SiteGroundTemperatureBuildingSurface (Model &model)
virtual	~SiteGroundTemperatureBuildingSurface ()=default
	SiteGroundTemperatureBuildingSurface (const SiteGroundTemperatureBuildingSurface &other)=default
	SiteGroundTemperatureBuildingSurface (SiteGroundTemperatureBuildingSurface &&other)=default
SiteGroundTemperatureBuildingSurface &	operator= (const SiteGroundTemperatureBuildingSurface &)=default
SiteGroundTemperatureBuildingSurface &	operator= (SiteGroundTemperatureBuildingSurface &&)=default
Getters
double	januaryGroundTemperature () const
bool	isJanuaryGroundTemperatureDefaulted () const
double	februaryGroundTemperature () const
bool	isFebruaryGroundTemperatureDefaulted () const
double	marchGroundTemperature () const
bool	isMarchGroundTemperatureDefaulted () const
double	aprilGroundTemperature () const
bool	isAprilGroundTemperatureDefaulted () const
double	mayGroundTemperature () const
bool	isMayGroundTemperatureDefaulted () const
double	juneGroundTemperature () const
bool	isJuneGroundTemperatureDefaulted () const
double	julyGroundTemperature () const
bool	isJulyGroundTemperatureDefaulted () const
double	augustGroundTemperature () const
bool	isAugustGroundTemperatureDefaulted () const
double	septemberGroundTemperature () const
bool	isSeptemberGroundTemperatureDefaulted () const
double	octoberGroundTemperature () const
bool	isOctoberGroundTemperatureDefaulted () const
double	novemberGroundTemperature () const
bool	isNovemberGroundTemperatureDefaulted () const
double	decemberGroundTemperature () const
bool	isDecemberGroundTemperatureDefaulted () const
double	getTemperatureByMonth (int month) const
double	getTemperatureByMonth (const openstudio::MonthOfYear &month) const
bool	isMonthDefaulted (int month) const
bool	isMonthDefaulted (const openstudio::MonthOfYear &month) const
std::vector< double >	getAllMonthlyTemperatures () const
Setters
bool	setJanuaryGroundTemperature (double januaryGroundTemperature)
void	resetJanuaryGroundTemperature ()
bool	setFebruaryGroundTemperature (double februaryGroundTemperature)
void	resetFebruaryGroundTemperature ()
bool	setMarchGroundTemperature (double marchGroundTemperature)
void	resetMarchGroundTemperature ()
bool	setAprilGroundTemperature (double aprilGroundTemperature)
void	resetAprilGroundTemperature ()
bool	setMayGroundTemperature (double mayGroundTemperature)
void	resetMayGroundTemperature ()
bool	setJuneGroundTemperature (double juneGroundTemperature)
void	resetJuneGroundTemperature ()
bool	setJulyGroundTemperature (double julyGroundTemperature)
void	resetJulyGroundTemperature ()
bool	setAugustGroundTemperature (double augustGroundTemperature)
void	resetAugustGroundTemperature ()
bool	setSeptemberGroundTemperature (double septemberGroundTemperature)
void	resetSeptemberGroundTemperature ()
bool	setOctoberGroundTemperature (double octoberGroundTemperature)
void	resetOctoberGroundTemperature ()
bool	setNovemberGroundTemperature (double novemberGroundTemperature)
void	resetNovemberGroundTemperature ()
bool	setDecemberGroundTemperature (double decemberGroundTemperature)
void	resetDecemberGroundTemperature ()
bool	setTemperatureByMonth (int month, double temperature)
bool	setTemperatureByMonth (const openstudio::MonthOfYear &month, double temperature)
void	resetTemperatureByMonth (int month)
void	resetTemperatureByMonth (const openstudio::MonthOfYear &month)
void	resetAllMonths ()
bool	setAllMonthlyTemperatures (const std::vector< double > &monthly_temperatures)
Public Member Functions inherited from openstudio::model::ModelObject
virtual	~ModelObject ()=default
	ModelObject (const ModelObject &other)=default
	ModelObject (ModelObject &&other)=default
ModelObject &	operator= (const ModelObject &)=default
ModelObject &	operator= (ModelObject &&)=default
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 (const std::string &valueName, const std::string &units) 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 ()

Related Functions
(Note that these are not member functions.)
using	OptionalSiteGroundTemperatureBuildingSurface = boost::optional< SiteGroundTemperatureBuildingSurface >
using	SiteGroundTemperatureBuildingSurfaceVector = std::vector< SiteGroundTemperatureBuildingSurface >
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
using	ImplType = detail::ModelObject_Impl
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)

Detailed Description

SiteGroundTemperatureBuildingSurface is a ModelObject that wraps the OpenStudio IDD object 'OS_Site_GroundTemperature_BuildingSurface'.

Constructor & Destructor Documentation

openstudio::model::SiteGroundTemperatureBuildingSurface::SiteGroundTemperatureBuildingSurface ( Model &  model )

explicit

virtual openstudio::model::SiteGroundTemperatureBuildingSurface::~SiteGroundTemperatureBuildingSurface ( )

virtualdefault

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

default

openstudio::model::SiteGroundTemperatureBuildingSurface::SiteGroundTemperatureBuildingSurface ( SiteGroundTemperatureBuildingSurface &&  other )

default

Member Function Documentation

double openstudio::model::SiteGroundTemperatureBuildingSurface::aprilGroundTemperature

(

)

const

double openstudio::model::SiteGroundTemperatureBuildingSurface::augustGroundTemperature

(

)

const

double openstudio::model::SiteGroundTemperatureBuildingSurface::decemberGroundTemperature

(

)

const

double openstudio::model::SiteGroundTemperatureBuildingSurface::februaryGroundTemperature

(

)

const

std::vector<double> openstudio::model::SiteGroundTemperatureBuildingSurface::getAllMonthlyTemperatures

(

)

const

double openstudio::model::SiteGroundTemperatureBuildingSurface::getTemperatureByMonth

(

int

month

)

const

double openstudio::model::SiteGroundTemperatureBuildingSurface::getTemperatureByMonth

(

const openstudio::MonthOfYear &

month

)

const

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

static

bool openstudio::model::SiteGroundTemperatureBuildingSurface::isAprilGroundTemperatureDefaulted

(

)

const

bool openstudio::model::SiteGroundTemperatureBuildingSurface::isAugustGroundTemperatureDefaulted

(

)

const

bool openstudio::model::SiteGroundTemperatureBuildingSurface::isDecemberGroundTemperatureDefaulted

(

)

const

bool openstudio::model::SiteGroundTemperatureBuildingSurface::isFebruaryGroundTemperatureDefaulted

(

)

const

bool openstudio::model::SiteGroundTemperatureBuildingSurface::isJanuaryGroundTemperatureDefaulted

(

)

const

bool openstudio::model::SiteGroundTemperatureBuildingSurface::isJulyGroundTemperatureDefaulted

(

)

const

bool openstudio::model::SiteGroundTemperatureBuildingSurface::isJuneGroundTemperatureDefaulted

(

)

const

bool openstudio::model::SiteGroundTemperatureBuildingSurface::isMarchGroundTemperatureDefaulted

(

)

const

bool openstudio::model::SiteGroundTemperatureBuildingSurface::isMayGroundTemperatureDefaulted

(

)

const

bool openstudio::model::SiteGroundTemperatureBuildingSurface::isMonthDefaulted

(

int

month

)

const

bool openstudio::model::SiteGroundTemperatureBuildingSurface::isMonthDefaulted

(

const openstudio::MonthOfYear &

month

)

const

bool openstudio::model::SiteGroundTemperatureBuildingSurface::isNovemberGroundTemperatureDefaulted

(

)

const

bool openstudio::model::SiteGroundTemperatureBuildingSurface::isOctoberGroundTemperatureDefaulted

(

)

const

bool openstudio::model::SiteGroundTemperatureBuildingSurface::isSeptemberGroundTemperatureDefaulted

(

)

const

double openstudio::model::SiteGroundTemperatureBuildingSurface::januaryGroundTemperature

(

)

const

double openstudio::model::SiteGroundTemperatureBuildingSurface::julyGroundTemperature

(

)

const

double openstudio::model::SiteGroundTemperatureBuildingSurface::juneGroundTemperature

(

)

const

double openstudio::model::SiteGroundTemperatureBuildingSurface::marchGroundTemperature

(

)

const

double openstudio::model::SiteGroundTemperatureBuildingSurface::mayGroundTemperature

(

)

const

double openstudio::model::SiteGroundTemperatureBuildingSurface::novemberGroundTemperature

(

)

const

double openstudio::model::SiteGroundTemperatureBuildingSurface::octoberGroundTemperature

(

)

const

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

default

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

default

void openstudio::model::SiteGroundTemperatureBuildingSurface::resetAllMonths

(

)

void openstudio::model::SiteGroundTemperatureBuildingSurface::resetAprilGroundTemperature

(

)

void openstudio::model::SiteGroundTemperatureBuildingSurface::resetAugustGroundTemperature

(

)

void openstudio::model::SiteGroundTemperatureBuildingSurface::resetDecemberGroundTemperature

(

)

void openstudio::model::SiteGroundTemperatureBuildingSurface::resetFebruaryGroundTemperature

(

)

void openstudio::model::SiteGroundTemperatureBuildingSurface::resetJanuaryGroundTemperature

(

)

void openstudio::model::SiteGroundTemperatureBuildingSurface::resetJulyGroundTemperature

(

)

void openstudio::model::SiteGroundTemperatureBuildingSurface::resetJuneGroundTemperature

(

)

void openstudio::model::SiteGroundTemperatureBuildingSurface::resetMarchGroundTemperature

(

)

void openstudio::model::SiteGroundTemperatureBuildingSurface::resetMayGroundTemperature

(

)

void openstudio::model::SiteGroundTemperatureBuildingSurface::resetNovemberGroundTemperature

(

)

void openstudio::model::SiteGroundTemperatureBuildingSurface::resetOctoberGroundTemperature

(

)

void openstudio::model::SiteGroundTemperatureBuildingSurface::resetSeptemberGroundTemperature

(

)

void openstudio::model::SiteGroundTemperatureBuildingSurface::resetTemperatureByMonth

(

int

month

)

void openstudio::model::SiteGroundTemperatureBuildingSurface::resetTemperatureByMonth

(

const openstudio::MonthOfYear &

month

)

double openstudio::model::SiteGroundTemperatureBuildingSurface::septemberGroundTemperature

(

)

const

bool openstudio::model::SiteGroundTemperatureBuildingSurface::setAllMonthlyTemperatures

(

const std::vector< double > &

monthly_temperatures

)

bool openstudio::model::SiteGroundTemperatureBuildingSurface::setAprilGroundTemperature

(

double

aprilGroundTemperature

)

bool openstudio::model::SiteGroundTemperatureBuildingSurface::setAugustGroundTemperature

(

double

augustGroundTemperature

)

bool openstudio::model::SiteGroundTemperatureBuildingSurface::setDecemberGroundTemperature

(

double

decemberGroundTemperature

)

bool openstudio::model::SiteGroundTemperatureBuildingSurface::setFebruaryGroundTemperature

(

double

februaryGroundTemperature

)

bool openstudio::model::SiteGroundTemperatureBuildingSurface::setJanuaryGroundTemperature

(

double

januaryGroundTemperature

)

bool openstudio::model::SiteGroundTemperatureBuildingSurface::setJulyGroundTemperature

(

double

julyGroundTemperature

)

bool openstudio::model::SiteGroundTemperatureBuildingSurface::setJuneGroundTemperature

(

double

juneGroundTemperature

)

bool openstudio::model::SiteGroundTemperatureBuildingSurface::setMarchGroundTemperature

(

double

marchGroundTemperature

)

bool openstudio::model::SiteGroundTemperatureBuildingSurface::setMayGroundTemperature

(

double

mayGroundTemperature

)

bool openstudio::model::SiteGroundTemperatureBuildingSurface::setNovemberGroundTemperature

(

double

novemberGroundTemperature

)

bool openstudio::model::SiteGroundTemperatureBuildingSurface::setOctoberGroundTemperature

(

double

octoberGroundTemperature

)

bool openstudio::model::SiteGroundTemperatureBuildingSurface::setSeptemberGroundTemperature

(

double

septemberGroundTemperature

)

bool openstudio::model::SiteGroundTemperatureBuildingSurface::setTemperatureByMonth	(	int	month,
		double	temperature
	)

bool openstudio::model::SiteGroundTemperatureBuildingSurface::setTemperatureByMonth	(	const openstudio::MonthOfYear &	month,
		double	temperature
	)

Friends And Related Function Documentation

using OptionalSiteGroundTemperatureBuildingSurface = boost::optional<SiteGroundTemperatureBuildingSurface>

related

using SiteGroundTemperatureBuildingSurfaceVector = std::vector<SiteGroundTemperatureBuildingSurface>

related