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

#include <EpwFile.hpp>

Public Member Functions

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

Static Public Member Functions

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

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

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

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

get the file's checksum

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

get the city

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

get the country

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

get the weather data

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

get the data source

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

get the design conditions

double openstudio::EpwFile::elevation ( ) const

get the elevation

Date openstudio::EpwFile::endDate ( ) const

get the end date

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

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

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

get a time series of a computed quantity

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

get a time series of a particular weather field

bool openstudio::EpwFile::isActual ( ) const

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

double openstudio::EpwFile::latitude ( ) const

get the latitude in degrees

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

static load method

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

static load method

double openstudio::EpwFile::longitude ( ) const

get the longitude in degrees

bool openstudio::EpwFile::minutesMatch ( ) const

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

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

get the path

int openstudio::EpwFile::recordsPerHour ( ) const

get the records per hour

Date openstudio::EpwFile::startDate ( ) const

get the start date

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

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

DayOfWeek openstudio::EpwFile::startDayOfWeek ( ) const

get the start day of the week

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

get the state, province, or region

Time openstudio::EpwFile::timeStep ( ) const

get the time step

double openstudio::EpwFile::timeZone ( ) const

get the time zone relative to GMT

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

export to CONTAM WTH file

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

get the WMO number