openstudio::EpwGroundTemperatureDepth Class Reference

#include <EpwFile.hpp>

Public Member Functions
double	aprGroundTemperature () const
	Returns the Apr undisturbed ground temperature in degrees C.
double	augGroundTemperature () const
	Returns the Aug undisturbed ground temperature in degrees C.
double	decGroundTemperature () const
	Returns the Dec undisturbed ground temperature in degrees C.
	EpwGroundTemperatureDepth ()=default
	Create an empty EpwGroundTemperatureDepth object.
	EpwGroundTemperatureDepth (double groundTemperatureDepth, double janGroundTemperature, double febGroundTemperature, double marGroundTemperature, double aprGroundTemperature, double mayGroundTemperature, double junGroundTemperature, double julGroundTemperature, double augGroundTemperature, double sepGroundTemperature, double octGroundTemperature, double novGroundTemperature, double decGroundTemperature, boost::optional< double > soilConductivity_=boost::none, boost::optional< double > soilDensity_=boost::none, boost::optional< double > soilSpecificHeat_=boost::none)
	Create an EpwGroundTemperatureDepth object with specified properties.
double	febGroundTemperature () const
	Returns the Feb undisturbed ground temperature in degrees C.
boost::optional< double >	getField (EpwDepthField id)
	Returns the dobule value of the field specified by enumeration value.
boost::optional< double >	getFieldByName (const std::string &name)
	Returns the double value of the named field if possible.
double	groundTemperatureDepth () const
	Returns the depth of ground temperature in m.
double	janGroundTemperature () const
	Returns the Jan undisturbed ground temperature in degrees C.
double	julGroundTemperature () const
	Returns the Jul undisturbed ground temperature in degrees C.
double	junGroundTemperature () const
	Returns the Jun undisturbed ground temperature in degrees C.
double	marGroundTemperature () const
	Returns the Mar undisturbed ground temperature in degrees C.
double	mayGroundTemperature () const
	Returns the May undisturbed ground temperature in degrees C.
double	novGroundTemperature () const
	Returns the Nov undisturbed ground temperature in degrees C.
double	octGroundTemperature () const
	Returns the Oct undisturbed ground temperature in degrees C.
double	sepGroundTemperature () const
	Returns the Sep undisturbed ground temperature in degrees C.
boost::optional< double >	soilConductivity () const
	Returns the soil conductivity in W/m-K.
boost::optional< double >	soilDensity () const
	Returns the soil density in kg/m3.
boost::optional< double >	soilSpecificHeat () const
	Returns the soil specific heat in J/kg-K.

Static Public Member Functions
static boost::optional< EpwGroundTemperatureDepth >	fromGroundTemperatureDepthsString (const std::string &line)
	Create an EpwGroundTemperatureDepth from an EPW-formatted string.
static boost::optional< EpwGroundTemperatureDepth >	fromGroundTemperatureDepthsStrings (const std::vector< std::string > &strings)
	Create an EpwGroundTemperatureDepth from a list of EPW depths as strings.
static std::string	getUnits (EpwDepthField field)
	Returns the units of the field specified by enumeration value.
static boost::optional< std::string >	getUnitsByName (const std::string &name)
	Returns the units of the named field.

Detailed Description

EpwGroundTemperatureDepth is one line from the EPW file.

All floating point numbers are stored as strings, but are checked as numbers.

Constructor & Destructor Documentation

EpwGroundTemperatureDepth() [1/2]

openstudio::EpwGroundTemperatureDepth::EpwGroundTemperatureDepth ( )

default

Create an empty EpwGroundTemperatureDepth object.

EpwGroundTemperatureDepth() [2/2]

openstudio::EpwGroundTemperatureDepth::EpwGroundTemperatureDepth	(	double	groundTemperatureDepth,
		double	janGroundTemperature,
		double	febGroundTemperature,
		double	marGroundTemperature,
		double	aprGroundTemperature,
		double	mayGroundTemperature,
		double	junGroundTemperature,
		double	julGroundTemperature,
		double	augGroundTemperature,
		double	sepGroundTemperature,
		double	octGroundTemperature,
		double	novGroundTemperature,
		double	decGroundTemperature,
		boost::optional< double >	soilConductivity_ = boost::none,
		boost::optional< double >	soilDensity_ = boost::none,
		boost::optional< double >	soilSpecificHeat_ = boost::none )

Create an EpwGroundTemperatureDepth object with specified properties.

Member Function Documentation

aprGroundTemperature()

double openstudio::EpwGroundTemperatureDepth::aprGroundTemperature

(

)

const

Returns the Apr undisturbed ground temperature in degrees C.

augGroundTemperature()

double openstudio::EpwGroundTemperatureDepth::augGroundTemperature

(

)

const

Returns the Aug undisturbed ground temperature in degrees C.

decGroundTemperature()

double openstudio::EpwGroundTemperatureDepth::decGroundTemperature

(

)

const

Returns the Dec undisturbed ground temperature in degrees C.

febGroundTemperature()

double openstudio::EpwGroundTemperatureDepth::febGroundTemperature

(

)

const

Returns the Feb undisturbed ground temperature in degrees C.

fromGroundTemperatureDepthsString()

static boost::optional< EpwGroundTemperatureDepth > openstudio::EpwGroundTemperatureDepth::fromGroundTemperatureDepthsString ( const std::string & line )

static

Create an EpwGroundTemperatureDepth from an EPW-formatted string.

fromGroundTemperatureDepthsStrings()

static boost::optional< EpwGroundTemperatureDepth > openstudio::EpwGroundTemperatureDepth::fromGroundTemperatureDepthsStrings ( const std::vector< std::string > & strings )

static

Create an EpwGroundTemperatureDepth from a list of EPW depths as strings.

getField()

boost::optional< double > openstudio::EpwGroundTemperatureDepth::getField

(

EpwDepthField

id

)

Returns the dobule value of the field specified by enumeration value.

getFieldByName()

boost::optional< double > openstudio::EpwGroundTemperatureDepth::getFieldByName

(

const std::string &

name

)

Returns the double value of the named field if possible.

getUnits()

static std::string openstudio::EpwGroundTemperatureDepth::getUnits ( EpwDepthField field )

static

Returns the units of the field specified by enumeration value.

getUnitsByName()

static boost::optional< std::string > openstudio::EpwGroundTemperatureDepth::getUnitsByName ( const std::string & name )

static

Returns the units of the named field.

groundTemperatureDepth()

double openstudio::EpwGroundTemperatureDepth::groundTemperatureDepth

(

)

const

Returns the depth of ground temperature in m.

janGroundTemperature()

double openstudio::EpwGroundTemperatureDepth::janGroundTemperature

(

)

const

Returns the Jan undisturbed ground temperature in degrees C.

julGroundTemperature()

double openstudio::EpwGroundTemperatureDepth::julGroundTemperature

(

)

const

Returns the Jul undisturbed ground temperature in degrees C.

junGroundTemperature()

double openstudio::EpwGroundTemperatureDepth::junGroundTemperature

(

)

const

Returns the Jun undisturbed ground temperature in degrees C.

marGroundTemperature()

double openstudio::EpwGroundTemperatureDepth::marGroundTemperature

(

)

const

Returns the Mar undisturbed ground temperature in degrees C.

mayGroundTemperature()

double openstudio::EpwGroundTemperatureDepth::mayGroundTemperature

(

)

const

Returns the May undisturbed ground temperature in degrees C.

novGroundTemperature()

double openstudio::EpwGroundTemperatureDepth::novGroundTemperature

(

)

const

Returns the Nov undisturbed ground temperature in degrees C.

octGroundTemperature()

double openstudio::EpwGroundTemperatureDepth::octGroundTemperature

(

)

const

Returns the Oct undisturbed ground temperature in degrees C.

sepGroundTemperature()

double openstudio::EpwGroundTemperatureDepth::sepGroundTemperature

(

)

const

Returns the Sep undisturbed ground temperature in degrees C.

soilConductivity()

boost::optional< double > openstudio::EpwGroundTemperatureDepth::soilConductivity

(

)

const

Returns the soil conductivity in W/m-K.

soilDensity()

boost::optional< double > openstudio::EpwGroundTemperatureDepth::soilDensity

(

)

const

Returns the soil density in kg/m3.

soilSpecificHeat()

boost::optional< double > openstudio::EpwGroundTemperatureDepth::soilSpecificHeat

(

)

const

Returns the soil specific heat in J/kg-K.