OpenStudio:utilities
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Static Public Member Functions | List of all members
openstudio::EpwDataPoint Class Reference

#include <EpwFile.hpp>

Public Member Functions

boost::optional< double > aerosolOpticalDepth () const
 If available, return the aerosol optical depth in thousandths. More...
 
boost::optional< AirStateairState () const
 Returns the air state specified by the EPW data. More...
 
boost::optional< double > albedo () const
 If available, return the albedo. More...
 
boost::optional< double > atmosphericStationPressure () const
 If available, return the atmospheric station pressure in Pa. More...
 
boost::optional< double > ceilingHeight () const
 If available, return the ceiling height in m. More...
 
std::string dataSourceandUncertaintyFlags () const
 Returns the data source and uncertainty flags. More...
 
Date date () const
 Returns the date in a Date object. More...
 
openstudio::DateTime dateTime () const
 Returns the date and time in a DateTime object. More...
 
int day () const
 Returns the day as an integer. More...
 
boost::optional< double > daysSinceLastSnowfall () const
 If available, return the days since last snowfall. More...
 
boost::optional< double > density () const
 If possible, compute and return the density kg/m3. More...
 
boost::optional< double > dewPointTemperature () const
 If available, return the dew point temperature in degrees C. More...
 
boost::optional< double > diffuseHorizontalIlluminance () const
 If available, return the diffuse horizontal illuminance in lux. More...
 
boost::optional< double > diffuseHorizontalRadiation () const
 If available, return the diffuse horizontal radiation in Wh/m2. More...
 
boost::optional< double > directNormalIlluminance () const
 If available, return the direct normal illuminance in lux. More...
 
boost::optional< double > directNormalRadiation () const
 If available, return direct normal radiation in Wh/m2. More...
 
boost::optional< double > dryBulbTemperature () const
 If available, return the dry bulb temperature in degrees C. More...
 
boost::optional< double > enthalpy () const
 If possible, compute and return the enthalpy in kJ/kg. More...
 
 EpwDataPoint ()
 Create an empty EpwDataPoint object. More...
 
 EpwDataPoint (int year, int month, int day, int hour, int minute, std::string dataSourceandUncertaintyFlags, double dryBulbTemperature, double dewPointTemperature, double relativeHumidity, double atmosphericStationPressure, double extraterrestrialHorizontalRadiation, double extraterrestrialDirectNormalRadiation, double horizontalInfraredRadiationIntensity, double globalHorizontalRadiation, double directNormalRadiation, double diffuseHorizontalRadiation, double globalHorizontalIlluminance, double directNormalIlluminance, double diffuseHorizontalIlluminance, double zenithLuminance, double windDirection, double windSpeed, int totalSkyCover, int opaqueSkyCover, double visibility, double ceilingHeight, int presentWeatherObservation, int presentWeatherCodes, double precipitableWater, double aerosolOpticalDepth, double snowDepth, double daysSinceLastSnowfall, double albedo, double liquidPrecipitationDepth, double liquidPrecipitationQuantity)
 Create an EpwDataPoint object with specified properties. More...
 
boost::optional< double > extraterrestrialDirectNormalRadiation () const
 If available, return the extraterrestrial direct normal radiation in Wh/m2. More...
 
boost::optional< double > extraterrestrialHorizontalRadiation () const
 If available, return the extraterrestrial horizontal radiation in Wh/m2. More...
 
boost::optional< double > getField (EpwDataField id)
 Returns the dobule value of the field specified by enumeration value. More...
 
boost::optional< double > getFieldByName (const std::string &name)
 Returns the double value of the named field if possible. More...
 
boost::optional< double > globalHorizontalIlluminance () const
 If available, return the global horizontal illuminance in lux. More...
 
boost::optional< double > globalHorizontalRadiation () const
 If available, return the global horizontal radiation in Wh/m2. More...
 
boost::optional< double > horizontalInfraredRadiationIntensity () const
 If available, return the horizontal infrared radiation intensity in Wh/m2. More...
 
int hour () const
 Returns the hour as an integer. More...
 
boost::optional< double > humidityRatio () const
 If possible, compute and return the humidity ratio. More...
 
boost::optional< double > liquidPrecipitationDepth () const
 If available, return the liquid precipitation depth in mm. More...
 
boost::optional< double > liquidPrecipitationQuantity () const
 If available, return the liquid precipitation quantity in hr. More...
 
int minute () const
 Returns the minute as an integer. More...
 
int month () const
 Returns the month as an integer. More...
 
int opaqueSkyCover () const
 Returns the opaque sky cover. More...
 
boost::optional< double > precipitableWater () const
 If available, return the precipitable water in mm. More...
 
int presentWeatherCodes () const
 Returns the presetn weather codes. More...
 
int presentWeatherObservation () const
 Returns the present weather observation. More...
 
boost::optional< double > relativeHumidity () const
 If available, return the relative humidity in %. More...
 
boost::optional< double > saturationPressure () const
 If possible, compute and return the saturation pressure in Pa. More...
 
boost::optional< double > snowDepth () const
 If available, return the snow depth in cm. More...
 
boost::optional< double > specificVolume () const
 If possible, compute and return the specific volume in m3/kg. More...
 
Time time () const
 Returns the time in a Time object. More...
 
std::vector< std::string > toEpwStrings () const
 Returns a list of strings containing the EPW data in the EpwDataPoint. More...
 
int totalSkyCover () const
 Returns the total sky cover. More...
 
boost::optional< std::string > toWthString () const
 Convert the EPW data into CONTAM's WTH format. More...
 
boost::optional< double > visibility () const
 If available, return the visibility in km. More...
 
boost::optional< double > wetbulb () const
 If possible, compute and return the wet bulb temperature in C. More...
 
boost::optional< double > windDirection () const
 If available, return the wind direction in degrees. More...
 
boost::optional< double > windSpeed () const
 If available, return the wind speed in m/s. More...
 
int year () const
 Returns the year as an integer. More...
 
boost::optional< double > zenithLuminance () const
 If available, return the zenith luminances Cd/m2. More...
 

Static Public Member Functions

static boost::optional
< EpwDataPoint
fromEpwString (const std::string &line)
 Create an EpwDataPoint from an EPW-formatted string. More...
 
static boost::optional
< EpwDataPoint
fromEpwStrings (const std::vector< std::string > &list, bool pedantic=true)
 Create an EpwDataPoint from a list of EPW data as strings. More...
 
static boost::optional
< EpwDataPoint
fromEpwStrings (int year, int month, int day, int hour, int minute, const std::vector< std::string > &list, bool pedantic=true)
 Create an EpwDataPoint from a list of EPW data as strings, overriding the date and time with the specified arguments. More...
 
static std::string getUnits (EpwDataField field)
 Returns the units of the field specified by enumeration value. More...
 
static std::string getUnits (EpwComputedField field)
 Returns the units of the computed value specified by enumeration value. More...
 
static boost::optional
< std::string > 
getUnitsByName (const std::string &name)
 Returns the units of the named field. More...
 

Detailed Description

EpwDataPoint is one line from the EPW file.

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

Constructor & Destructor Documentation

openstudio::EpwDataPoint::EpwDataPoint ( )

Create an empty EpwDataPoint object.

openstudio::EpwDataPoint::EpwDataPoint ( int  year,
int  month,
int  day,
int  hour,
int  minute,
std::string  dataSourceandUncertaintyFlags,
double  dryBulbTemperature,
double  dewPointTemperature,
double  relativeHumidity,
double  atmosphericStationPressure,
double  extraterrestrialHorizontalRadiation,
double  extraterrestrialDirectNormalRadiation,
double  horizontalInfraredRadiationIntensity,
double  globalHorizontalRadiation,
double  directNormalRadiation,
double  diffuseHorizontalRadiation,
double  globalHorizontalIlluminance,
double  directNormalIlluminance,
double  diffuseHorizontalIlluminance,
double  zenithLuminance,
double  windDirection,
double  windSpeed,
int  totalSkyCover,
int  opaqueSkyCover,
double  visibility,
double  ceilingHeight,
int  presentWeatherObservation,
int  presentWeatherCodes,
double  precipitableWater,
double  aerosolOpticalDepth,
double  snowDepth,
double  daysSinceLastSnowfall,
double  albedo,
double  liquidPrecipitationDepth,
double  liquidPrecipitationQuantity 
)

Create an EpwDataPoint object with specified properties.

Member Function Documentation

boost::optional<double> openstudio::EpwDataPoint::aerosolOpticalDepth ( ) const

If available, return the aerosol optical depth in thousandths.

boost::optional<AirState> openstudio::EpwDataPoint::airState ( ) const

Returns the air state specified by the EPW data.

If dry bulb, pressure, and relative humidity are available, then those values will be used to compute the air state. Otherwise, unless dry bulb, pressure, and dew point are available, then an empty optional will be returned. Note that the air state may not be consistend with the EPW data if all 4 parameters are in the EPW data.

boost::optional<double> openstudio::EpwDataPoint::albedo ( ) const

If available, return the albedo.

boost::optional<double> openstudio::EpwDataPoint::atmosphericStationPressure ( ) const

If available, return the atmospheric station pressure in Pa.

boost::optional<double> openstudio::EpwDataPoint::ceilingHeight ( ) const

If available, return the ceiling height in m.

std::string openstudio::EpwDataPoint::dataSourceandUncertaintyFlags ( ) const

Returns the data source and uncertainty flags.

Date openstudio::EpwDataPoint::date ( ) const

Returns the date in a Date object.

openstudio::DateTime openstudio::EpwDataPoint::dateTime ( ) const

Returns the date and time in a DateTime object.

int openstudio::EpwDataPoint::day ( ) const

Returns the day as an integer.

boost::optional<double> openstudio::EpwDataPoint::daysSinceLastSnowfall ( ) const

If available, return the days since last snowfall.

boost::optional<double> openstudio::EpwDataPoint::density ( ) const

If possible, compute and return the density kg/m3.

boost::optional<double> openstudio::EpwDataPoint::dewPointTemperature ( ) const

If available, return the dew point temperature in degrees C.

boost::optional<double> openstudio::EpwDataPoint::diffuseHorizontalIlluminance ( ) const

If available, return the diffuse horizontal illuminance in lux.

boost::optional<double> openstudio::EpwDataPoint::diffuseHorizontalRadiation ( ) const

If available, return the diffuse horizontal radiation in Wh/m2.

boost::optional<double> openstudio::EpwDataPoint::directNormalIlluminance ( ) const

If available, return the direct normal illuminance in lux.

boost::optional<double> openstudio::EpwDataPoint::directNormalRadiation ( ) const

If available, return direct normal radiation in Wh/m2.

boost::optional<double> openstudio::EpwDataPoint::dryBulbTemperature ( ) const

If available, return the dry bulb temperature in degrees C.

boost::optional<double> openstudio::EpwDataPoint::enthalpy ( ) const

If possible, compute and return the enthalpy in kJ/kg.

boost::optional<double> openstudio::EpwDataPoint::extraterrestrialDirectNormalRadiation ( ) const

If available, return the extraterrestrial direct normal radiation in Wh/m2.

boost::optional<double> openstudio::EpwDataPoint::extraterrestrialHorizontalRadiation ( ) const

If available, return the extraterrestrial horizontal radiation in Wh/m2.

static boost::optional<EpwDataPoint> openstudio::EpwDataPoint::fromEpwString ( const std::string &  line)
static

Create an EpwDataPoint from an EPW-formatted string.

static boost::optional<EpwDataPoint> openstudio::EpwDataPoint::fromEpwStrings ( const std::vector< std::string > &  list,
bool  pedantic = true 
)
static

Create an EpwDataPoint from a list of EPW data as strings.

The pedantic argument controls how strict the conversion is. If pedantic is true, the list should have 35 elements. If pedantic is false, lists with more or fewer elements may still result in an EpwDataPoint

static boost::optional<EpwDataPoint> openstudio::EpwDataPoint::fromEpwStrings ( int  year,
int  month,
int  day,
int  hour,
int  minute,
const std::vector< std::string > &  list,
bool  pedantic = true 
)
static

Create an EpwDataPoint from a list of EPW data as strings, overriding the date and time with the specified arguments.

The pedantic argument controls how strict the conversion is. If pedantic is true, the list should have 35 elements. If pedantic is false, lists with more or fewer elements may still result in an EpwDataPoint

boost::optional<double> openstudio::EpwDataPoint::getField ( EpwDataField  id)

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

boost::optional<double> openstudio::EpwDataPoint::getFieldByName ( const std::string &  name)

Returns the double value of the named field if possible.

static std::string openstudio::EpwDataPoint::getUnits ( EpwDataField  field)
static

Returns the units of the field specified by enumeration value.

static std::string openstudio::EpwDataPoint::getUnits ( EpwComputedField  field)
static

Returns the units of the computed value specified by enumeration value.

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

Returns the units of the named field.

boost::optional<double> openstudio::EpwDataPoint::globalHorizontalIlluminance ( ) const

If available, return the global horizontal illuminance in lux.

boost::optional<double> openstudio::EpwDataPoint::globalHorizontalRadiation ( ) const

If available, return the global horizontal radiation in Wh/m2.

boost::optional<double> openstudio::EpwDataPoint::horizontalInfraredRadiationIntensity ( ) const

If available, return the horizontal infrared radiation intensity in Wh/m2.

int openstudio::EpwDataPoint::hour ( ) const

Returns the hour as an integer.

boost::optional<double> openstudio::EpwDataPoint::humidityRatio ( ) const

If possible, compute and return the humidity ratio.

boost::optional<double> openstudio::EpwDataPoint::liquidPrecipitationDepth ( ) const

If available, return the liquid precipitation depth in mm.

boost::optional<double> openstudio::EpwDataPoint::liquidPrecipitationQuantity ( ) const

If available, return the liquid precipitation quantity in hr.

int openstudio::EpwDataPoint::minute ( ) const

Returns the minute as an integer.

int openstudio::EpwDataPoint::month ( ) const

Returns the month as an integer.

int openstudio::EpwDataPoint::opaqueSkyCover ( ) const

Returns the opaque sky cover.

boost::optional<double> openstudio::EpwDataPoint::precipitableWater ( ) const

If available, return the precipitable water in mm.

int openstudio::EpwDataPoint::presentWeatherCodes ( ) const

Returns the presetn weather codes.

int openstudio::EpwDataPoint::presentWeatherObservation ( ) const

Returns the present weather observation.

boost::optional<double> openstudio::EpwDataPoint::relativeHumidity ( ) const

If available, return the relative humidity in %.

boost::optional<double> openstudio::EpwDataPoint::saturationPressure ( ) const

If possible, compute and return the saturation pressure in Pa.

boost::optional<double> openstudio::EpwDataPoint::snowDepth ( ) const

If available, return the snow depth in cm.

boost::optional<double> openstudio::EpwDataPoint::specificVolume ( ) const

If possible, compute and return the specific volume in m3/kg.

Time openstudio::EpwDataPoint::time ( ) const

Returns the time in a Time object.

std::vector<std::string> openstudio::EpwDataPoint::toEpwStrings ( ) const

Returns a list of strings containing the EPW data in the EpwDataPoint.

int openstudio::EpwDataPoint::totalSkyCover ( ) const

Returns the total sky cover.

boost::optional<std::string> openstudio::EpwDataPoint::toWthString ( ) const

Convert the EPW data into CONTAM's WTH format.

boost::optional<double> openstudio::EpwDataPoint::visibility ( ) const

If available, return the visibility in km.

boost::optional<double> openstudio::EpwDataPoint::wetbulb ( ) const

If possible, compute and return the wet bulb temperature in C.

boost::optional<double> openstudio::EpwDataPoint::windDirection ( ) const

If available, return the wind direction in degrees.

boost::optional<double> openstudio::EpwDataPoint::windSpeed ( ) const

If available, return the wind speed in m/s.

int openstudio::EpwDataPoint::year ( ) const

Returns the year as an integer.

boost::optional<double> openstudio::EpwDataPoint::zenithLuminance ( ) const

If available, return the zenith luminances Cd/m2.