OpenStudioCore:runmanager/lib
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Static Public Member Functions | List of all members
openstudio::runmanager::WeatherFileFinder Class Reference

#include <WeatherFileFinder.hpp>

Static Public Member Functions

static void extractDetails (const IdfFile &t_idffile, ToolVersion &t_version, boost::optional< std::string > &t_filelocationname, boost::optional< std::string > &t_weatherfilename)
 Extracts the details of the IDF needed for simulation and weather file finding. More...
 
static openstudio::path find (const JobParams &t_params, const boost::optional< std::string > &t_filelocationname, const boost::optional< std::string > &t_weatherfilename)
 Returns the path to the weather file that should be used for the EnergyPlus simulation. More...
 

Detailed Description

Used to determine the weather file that needs to be used with a given IDF.

Member Function Documentation

static void openstudio::runmanager::WeatherFileFinder::extractDetails ( const IdfFile &  t_idffile,
ToolVersion t_version,
boost::optional< std::string > &  t_filelocationname,
boost::optional< std::string > &  t_weatherfilename 
)
static

Extracts the details of the IDF needed for simulation and weather file finding.

Parameters
[in]t_idffileIDF to extract details form
[out]t_versionToolVersion information extracted from IdfFile
[out]t_filelocationnameWeather file location name if provided in the IDf
[out]t_weatherfilenameWeather file name, if provided by the IDF
static openstudio::path openstudio::runmanager::WeatherFileFinder::find ( const JobParams t_params,
const boost::optional< std::string > &  t_filelocationname,
const boost::optional< std::string > &  t_weatherfilename 
)
static

Returns the path to the weather file that should be used for the EnergyPlus simulation.

Parameters
[in]t_paramsChecked for epwdir param to look for weather file search path
[in]t_filelocationnameLocation name returned from extractDetails
[in]t_weatherfilenameWeather file name returned from extractDetails