openstudio::model::SiteGroundTemperatureShallow Class Reference

#include <SiteGroundTemperatureShallow.hpp>

Inheritance diagram for openstudio::model::SiteGroundTemperatureShallow:

Public Member Functions
Constructors and Destructors
	SiteGroundTemperatureShallow (Model &model)
virtual	~SiteGroundTemperatureShallow ()
Getters
double	januarySurfaceGroundTemperature () const
bool	isJanuarySurfaceGroundTemperatureDefaulted () const
double	februarySurfaceGroundTemperature () const
bool	isFebruarySurfaceGroundTemperatureDefaulted () const
double	marchSurfaceGroundTemperature () const
bool	isMarchSurfaceGroundTemperatureDefaulted () const
double	aprilSurfaceGroundTemperature () const
bool	isAprilSurfaceGroundTemperatureDefaulted () const
double	maySurfaceGroundTemperature () const
bool	isMaySurfaceGroundTemperatureDefaulted () const
double	juneSurfaceGroundTemperature () const
bool	isJuneSurfaceGroundTemperatureDefaulted () const
double	julySurfaceGroundTemperature () const
bool	isJulySurfaceGroundTemperatureDefaulted () const
double	augustSurfaceGroundTemperature () const
bool	isAugustSurfaceGroundTemperatureDefaulted () const
double	septemberSurfaceGroundTemperature () const
bool	isSeptemberSurfaceGroundTemperatureDefaulted () const
double	octoberSurfaceGroundTemperature () const
bool	isOctoberSurfaceGroundTemperatureDefaulted () const
double	novemberSurfaceGroundTemperature () const
bool	isNovemberSurfaceGroundTemperatureDefaulted () const
double	decemberSurfaceGroundTemperature () const
bool	isDecemberSurfaceGroundTemperatureDefaulted () 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	setJanuarySurfaceGroundTemperature (double januarySurfaceGroundTemperature)
void	resetJanuarySurfaceGroundTemperature ()
bool	setFebruarySurfaceGroundTemperature (double februarySurfaceGroundTemperature)
void	resetFebruarySurfaceGroundTemperature ()
bool	setMarchSurfaceGroundTemperature (double marchSurfaceGroundTemperature)
void	resetMarchSurfaceGroundTemperature ()
bool	setAprilSurfaceGroundTemperature (double aprilSurfaceGroundTemperature)
void	resetAprilSurfaceGroundTemperature ()
bool	setMaySurfaceGroundTemperature (double maySurfaceGroundTemperature)
void	resetMaySurfaceGroundTemperature ()
bool	setJuneSurfaceGroundTemperature (double juneSurfaceGroundTemperature)
void	resetJuneSurfaceGroundTemperature ()
bool	setJulySurfaceGroundTemperature (double julySurfaceGroundTemperature)
void	resetJulySurfaceGroundTemperature ()
bool	setAugustSurfaceGroundTemperature (double augustSurfaceGroundTemperature)
void	resetAugustSurfaceGroundTemperature ()
bool	setSeptemberSurfaceGroundTemperature (double septemberSurfaceGroundTemperature)
void	resetSeptemberSurfaceGroundTemperature ()
bool	setOctoberSurfaceGroundTemperature (double octoberSurfaceGroundTemperature)
void	resetOctoberSurfaceGroundTemperature ()
bool	setNovemberSurfaceGroundTemperature (double novemberSurfaceGroundTemperature)
void	resetNovemberSurfaceGroundTemperature ()
bool	setDecemberSurfaceGroundTemperature (double decemberSurfaceGroundTemperature)
void	resetDecemberSurfaceGroundTemperature ()
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 ()
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...
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 ()

Related Functions
(Note that these are not member functions.)
typedef boost::optional < SiteGroundTemperatureShallow >	OptionalSiteGroundTemperatureShallow
typedef std::vector < SiteGroundTemperatureShallow >	SiteGroundTemperatureShallowVector
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...
typedef std::pair< std::string, std::string >	ScheduleTypeKey
	Typedef for ScheduleTypeRegistry key. More...
typedef std::pair< std::string, std::string >	ScheduleTypeKey
	Typedef for ScheduleTypeRegistry key. More...

Additional Inherited Members
Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl	ImplType
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

SiteGroundTemperatureShallow is a ModelObject that wraps the OpenStudio IDD object 'OS_Site_GroundTemperature_Shallow'.

Constructor & Destructor Documentation

openstudio::model::SiteGroundTemperatureShallow::SiteGroundTemperatureShallow ( Model &  model )

explicit

virtual openstudio::model::SiteGroundTemperatureShallow::~SiteGroundTemperatureShallow ( )

inlinevirtual

Member Function Documentation

double openstudio::model::SiteGroundTemperatureShallow::aprilSurfaceGroundTemperature

(

)

const

double openstudio::model::SiteGroundTemperatureShallow::augustSurfaceGroundTemperature

(

)

const

double openstudio::model::SiteGroundTemperatureShallow::decemberSurfaceGroundTemperature

(

)

const

double openstudio::model::SiteGroundTemperatureShallow::februarySurfaceGroundTemperature

(

)

const

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

(

)

const

double openstudio::model::SiteGroundTemperatureShallow::getTemperatureByMonth

(

int

month

)

const

double openstudio::model::SiteGroundTemperatureShallow::getTemperatureByMonth

(

const openstudio::MonthOfYear &

month

)

const

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

static

bool openstudio::model::SiteGroundTemperatureShallow::isAprilSurfaceGroundTemperatureDefaulted

(

)

const

bool openstudio::model::SiteGroundTemperatureShallow::isAugustSurfaceGroundTemperatureDefaulted

(

)

const

bool openstudio::model::SiteGroundTemperatureShallow::isDecemberSurfaceGroundTemperatureDefaulted

(

)

const

bool openstudio::model::SiteGroundTemperatureShallow::isFebruarySurfaceGroundTemperatureDefaulted

(

)

const

bool openstudio::model::SiteGroundTemperatureShallow::isJanuarySurfaceGroundTemperatureDefaulted

(

)

const

bool openstudio::model::SiteGroundTemperatureShallow::isJulySurfaceGroundTemperatureDefaulted

(

)

const

bool openstudio::model::SiteGroundTemperatureShallow::isJuneSurfaceGroundTemperatureDefaulted

(

)

const

bool openstudio::model::SiteGroundTemperatureShallow::isMarchSurfaceGroundTemperatureDefaulted

(

)

const

bool openstudio::model::SiteGroundTemperatureShallow::isMaySurfaceGroundTemperatureDefaulted

(

)

const

bool openstudio::model::SiteGroundTemperatureShallow::isMonthDefaulted

(

int

month

)

const

bool openstudio::model::SiteGroundTemperatureShallow::isMonthDefaulted

(

const openstudio::MonthOfYear &

month

)

const

bool openstudio::model::SiteGroundTemperatureShallow::isNovemberSurfaceGroundTemperatureDefaulted

(

)

const

bool openstudio::model::SiteGroundTemperatureShallow::isOctoberSurfaceGroundTemperatureDefaulted

(

)

const

bool openstudio::model::SiteGroundTemperatureShallow::isSeptemberSurfaceGroundTemperatureDefaulted

(

)

const

double openstudio::model::SiteGroundTemperatureShallow::januarySurfaceGroundTemperature

(

)

const

double openstudio::model::SiteGroundTemperatureShallow::julySurfaceGroundTemperature

(

)

const

double openstudio::model::SiteGroundTemperatureShallow::juneSurfaceGroundTemperature

(

)

const

double openstudio::model::SiteGroundTemperatureShallow::marchSurfaceGroundTemperature

(

)

const

double openstudio::model::SiteGroundTemperatureShallow::maySurfaceGroundTemperature

(

)

const

double openstudio::model::SiteGroundTemperatureShallow::novemberSurfaceGroundTemperature

(

)

const

double openstudio::model::SiteGroundTemperatureShallow::octoberSurfaceGroundTemperature

(

)

const

void openstudio::model::SiteGroundTemperatureShallow::resetAllMonths

(

)

void openstudio::model::SiteGroundTemperatureShallow::resetAprilSurfaceGroundTemperature

(

)

void openstudio::model::SiteGroundTemperatureShallow::resetAugustSurfaceGroundTemperature

(

)

void openstudio::model::SiteGroundTemperatureShallow::resetDecemberSurfaceGroundTemperature

(

)

void openstudio::model::SiteGroundTemperatureShallow::resetFebruarySurfaceGroundTemperature

(

)

void openstudio::model::SiteGroundTemperatureShallow::resetJanuarySurfaceGroundTemperature

(

)

void openstudio::model::SiteGroundTemperatureShallow::resetJulySurfaceGroundTemperature

(

)

void openstudio::model::SiteGroundTemperatureShallow::resetJuneSurfaceGroundTemperature

(

)

void openstudio::model::SiteGroundTemperatureShallow::resetMarchSurfaceGroundTemperature

(

)

void openstudio::model::SiteGroundTemperatureShallow::resetMaySurfaceGroundTemperature

(

)

void openstudio::model::SiteGroundTemperatureShallow::resetNovemberSurfaceGroundTemperature

(

)

void openstudio::model::SiteGroundTemperatureShallow::resetOctoberSurfaceGroundTemperature

(

)

void openstudio::model::SiteGroundTemperatureShallow::resetSeptemberSurfaceGroundTemperature

(

)

void openstudio::model::SiteGroundTemperatureShallow::resetTemperatureByMonth

(

int

month

)

void openstudio::model::SiteGroundTemperatureShallow::resetTemperatureByMonth

(

const openstudio::MonthOfYear &

month

)

double openstudio::model::SiteGroundTemperatureShallow::septemberSurfaceGroundTemperature

(

)

const

bool openstudio::model::SiteGroundTemperatureShallow::setAllMonthlyTemperatures

(

const std::vector< double > &

monthly_temperatures

)

bool openstudio::model::SiteGroundTemperatureShallow::setAprilSurfaceGroundTemperature

(

double

aprilSurfaceGroundTemperature

)

bool openstudio::model::SiteGroundTemperatureShallow::setAugustSurfaceGroundTemperature

(

double

augustSurfaceGroundTemperature

)

bool openstudio::model::SiteGroundTemperatureShallow::setDecemberSurfaceGroundTemperature

(

double

decemberSurfaceGroundTemperature

)

bool openstudio::model::SiteGroundTemperatureShallow::setFebruarySurfaceGroundTemperature

(

double

februarySurfaceGroundTemperature

)

bool openstudio::model::SiteGroundTemperatureShallow::setJanuarySurfaceGroundTemperature

(

double

januarySurfaceGroundTemperature

)

bool openstudio::model::SiteGroundTemperatureShallow::setJulySurfaceGroundTemperature

(

double

julySurfaceGroundTemperature

)

bool openstudio::model::SiteGroundTemperatureShallow::setJuneSurfaceGroundTemperature

(

double

juneSurfaceGroundTemperature

)

bool openstudio::model::SiteGroundTemperatureShallow::setMarchSurfaceGroundTemperature

(

double

marchSurfaceGroundTemperature

)

bool openstudio::model::SiteGroundTemperatureShallow::setMaySurfaceGroundTemperature

(

double

maySurfaceGroundTemperature

)

bool openstudio::model::SiteGroundTemperatureShallow::setNovemberSurfaceGroundTemperature

(

double

novemberSurfaceGroundTemperature

)

bool openstudio::model::SiteGroundTemperatureShallow::setOctoberSurfaceGroundTemperature

(

double

octoberSurfaceGroundTemperature

)

bool openstudio::model::SiteGroundTemperatureShallow::setSeptemberSurfaceGroundTemperature

(

double

septemberSurfaceGroundTemperature

)

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

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

Friends And Related Function Documentation

typedef boost::optional<SiteGroundTemperatureShallow> OptionalSiteGroundTemperatureShallow

related

typedef std::vector<SiteGroundTemperatureShallow> SiteGroundTemperatureShallowVector

related