EpwFile Class Reference

#include "EpwFile.hpp"

Public Member Functions
std::string	checksum () const
std::string	city () const
std::string	country () const
std::vector< EpwDataPoint >	data ()
std::string	dataSource () const
std::vector< EpwDesignCondition >	designConditions ()
double	elevation () const
Date	endDate () const
boost::optional< int >	endDateActualYear () const
	EpwFile (const openstudio::path &p, bool storeData=false)
boost::optional< TimeSeries >	getComputedTimeSeries (const std::string &field)
boost::optional< TimeSeries >	getTimeSeries (const std::string &field)
bool	isActual () const
double	latitude () const
double	longitude () const
bool	minutesMatch () const
openstudio::path	path () const
int	recordsPerHour () const
Date	startDate () const
boost::optional< int >	startDateActualYear () const
DayOfWeek	startDayOfWeek () const
std::string	stateProvinceRegion () const
Time	timeStep () const
double	timeZone () const
bool	translateToWth (openstudio::path path, std::string description=std::string())
std::string	wmoNumber () const

Static Public Member Functions
static boost::optional< EpwFile >	load (const openstudio::path &p, bool storeData=false)
static boost::optional< EpwFile >	loadFromString (const std::string &str, bool storeData=false)

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