OpenStudio:utilities
Loading...
Searching...
No Matches
openstudio::EpwFile Class Reference

#include <EpwFile.hpp>

Public Member Functions

std::string checksum () const
 get the file's checksum
 
std::string city () const
 get the city
 
std::string country () const
 get the country
 
std::vector< EpwDataPointdata ()
 get the weather data
 
std::string dataSource () const
 get the data source
 
boost::optional< DatedaylightSavingEndDate () const
 
boost::optional< DatedaylightSavingStartDate () const
 
std::vector< EpwDesignConditiondesignConditions ()
 get the design conditions
 
double elevation () const
 get the elevation
 
Date endDate () const
 get the end date
 
boost::optional< intendDateActualYear () const
 get the actual year of the end date if there is one
 
 EpwFile (const openstudio::path &p, bool storeData=false)
 constructor with path will throw if path does not exist or file is incorrect
 
boost::optional< TimeSeriesgetComputedTimeSeries (const std::string &field)
 get a time series of a computed quantity
 
boost::optional< TimeSeriesgetTimeSeries (const std::string &field)
 get a time series of a particular weather field
 
std::vector< EpwGroundTemperatureDepthgroundTemperatureDepths ()
 get the ground temperature depths
 
std::vector< EpwHolidayholidays () const
 
bool isActual () const
 Returns true if the file appears to be AMY (as opposed to TMY)
 
double latitude () const
 get the latitude in degrees
 
double longitude () const
 get the longitude in degrees
 
bool minutesMatch () const
 Returns true if the data period "records per hour" input matches the data point values.
 
openstudio::path path () const
 get the path
 
int recordsPerHour () const
 get the records per hour
 
Date startDate () const
 get the start date
 
boost::optional< intstartDateActualYear () const
 get the actual year of the start date if there is one
 
DayOfWeek startDayOfWeek () const
 get the start day of the week
 
std::string stateProvinceRegion () const
 get the state, province, or region
 
Time timeStep () const
 get the time step
 
double timeZone () const
 get the time zone relative to GMT
 
bool translateToWth (openstudio::path path, std::string description=std::string())
 export to CONTAM WTH file
 
std::string wmoNumber () const
 get the WMO number
 

Static Public Member Functions

static boost::optional< EpwFileload (const openstudio::path &p, bool storeData=false)
 static load method
 
static boost::optional< EpwFileloadFromString (const std::string &str, bool storeData=false)
 static load method
 

Detailed Description

EpwFile parses a weather file in EPW format.

Later it may provide methods for writing and converting other weather files to EPW format.

Constructor & Destructor Documentation

◆ EpwFile()

openstudio::EpwFile::EpwFile ( const openstudio::path & p,
bool storeData = false )

constructor with path will throw if path does not exist or file is incorrect

Member Function Documentation

◆ checksum()

std::string openstudio::EpwFile::checksum ( ) const

get the file's checksum

◆ city()

std::string openstudio::EpwFile::city ( ) const

get the city

◆ country()

std::string openstudio::EpwFile::country ( ) const

get the country

◆ data()

std::vector< EpwDataPoint > openstudio::EpwFile::data ( )

get the weather data

◆ dataSource()

std::string openstudio::EpwFile::dataSource ( ) const

get the data source

◆ daylightSavingEndDate()

boost::optional< Date > openstudio::EpwFile::daylightSavingEndDate ( ) const

◆ daylightSavingStartDate()

boost::optional< Date > openstudio::EpwFile::daylightSavingStartDate ( ) const

◆ designConditions()

std::vector< EpwDesignCondition > openstudio::EpwFile::designConditions ( )

get the design conditions

◆ elevation()

double openstudio::EpwFile::elevation ( ) const

get the elevation

◆ endDate()

Date openstudio::EpwFile::endDate ( ) const

get the end date

◆ endDateActualYear()

boost::optional< int > openstudio::EpwFile::endDateActualYear ( ) const

get the actual year of the end date if there is one

◆ getComputedTimeSeries()

boost::optional< TimeSeries > openstudio::EpwFile::getComputedTimeSeries ( const std::string & field)

get a time series of a computed quantity

◆ getTimeSeries()

boost::optional< TimeSeries > openstudio::EpwFile::getTimeSeries ( const std::string & field)

get a time series of a particular weather field

◆ groundTemperatureDepths()

std::vector< EpwGroundTemperatureDepth > openstudio::EpwFile::groundTemperatureDepths ( )

get the ground temperature depths

◆ holidays()

std::vector< EpwHoliday > openstudio::EpwFile::holidays ( ) const

◆ isActual()

bool openstudio::EpwFile::isActual ( ) const

Returns true if the file appears to be AMY (as opposed to TMY)

◆ latitude()

double openstudio::EpwFile::latitude ( ) const

get the latitude in degrees

◆ load()

static boost::optional< EpwFile > openstudio::EpwFile::load ( const openstudio::path & p,
bool storeData = false )
static

static load method

◆ loadFromString()

static boost::optional< EpwFile > openstudio::EpwFile::loadFromString ( const std::string & str,
bool storeData = false )
static

static load method

◆ longitude()

double openstudio::EpwFile::longitude ( ) const

get the longitude in degrees

◆ minutesMatch()

bool openstudio::EpwFile::minutesMatch ( ) const

Returns true if the data period "records per hour" input matches the data point values.

◆ path()

openstudio::path openstudio::EpwFile::path ( ) const

get the path

◆ recordsPerHour()

int openstudio::EpwFile::recordsPerHour ( ) const

get the records per hour

◆ startDate()

Date openstudio::EpwFile::startDate ( ) const

get the start date

◆ startDateActualYear()

boost::optional< int > openstudio::EpwFile::startDateActualYear ( ) const

get the actual year of the start date if there is one

◆ startDayOfWeek()

DayOfWeek openstudio::EpwFile::startDayOfWeek ( ) const

get the start day of the week

◆ stateProvinceRegion()

std::string openstudio::EpwFile::stateProvinceRegion ( ) const

get the state, province, or region

◆ timeStep()

Time openstudio::EpwFile::timeStep ( ) const

get the time step

◆ timeZone()

double openstudio::EpwFile::timeZone ( ) const

get the time zone relative to GMT

◆ translateToWth()

bool openstudio::EpwFile::translateToWth ( openstudio::path path,
std::string description = std::string() )

export to CONTAM WTH file

◆ wmoNumber()

std::string openstudio::EpwFile::wmoNumber ( ) const

get the WMO number