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

#include <ToolFinder.hpp>

Public Member Functions

void addSearchPath (const openstudio::path &t_searchPath)
 Adds a search path. More...
 
std::vector< std::pair
< ToolVersion,
ToolLocationInfo > > 
findTools (bool t_showProgressDialog=false) const
 Searches for tools installed at the already defined search paths. More...
 
 ToolFinder ()
 Default constructor. More...
 
 ToolFinder (const std::vector< openstudio::path > &t_searchPaths)
 Constructor taking a vector of paths to search for tools. More...
 

Static Public Member Functions

static std::vector< std::pair
< ToolVersion,
ToolLocationInfo > > 
findTools (const std::vector< openstudio::path > &t_searchPaths, bool t_showProgressDialog=false)
 Static convenience function that searches for tools in the given set of locations. More...
 
static void mergeTools (std::vector< std::pair< ToolVersion, ToolLocationInfo > > &t_tools, const std::vector< std::pair< ToolVersion, ToolLocationInfo > > &t_newtools)
 
static ToolVersion parseToolVersion (const openstudio::path &t_path)
 

Detailed Description

Class for finding Tools installed on the local system.

Used internally by openstudio::runmanager::ConfigOptions::findTools and openstudio::runmanager::ConfigOptions::fastFindEnergyPlus.

Constructor & Destructor Documentation

openstudio::runmanager::ToolFinder::ToolFinder ( )

Default constructor.

openstudio::runmanager::ToolFinder::ToolFinder ( const std::vector< openstudio::path > &  t_searchPaths)

Constructor taking a vector of paths to search for tools.

Member Function Documentation

void openstudio::runmanager::ToolFinder::addSearchPath ( const openstudio::path &  t_searchPath)

Adds a search path.

static std::vector<std::pair<ToolVersion, ToolLocationInfo> > openstudio::runmanager::ToolFinder::findTools ( const std::vector< openstudio::path > &  t_searchPaths,
bool  t_showProgressDialog = false 
)
static

Static convenience function that searches for tools in the given set of locations.

Parameters
[in]t_searchPathspaths to search for known tools
[in]t_showProgressDialogif true, display a progress dialog during searching
std::vector<std::pair<ToolVersion, ToolLocationInfo> > openstudio::runmanager::ToolFinder::findTools ( bool  t_showProgressDialog = false) const

Searches for tools installed at the already defined search paths.

Parameters
[in]t_showProgressDialogif true, display a progress dialog during searching
See also
openstudio::runmanager::ToolFinder::addSearchPath
static void openstudio::runmanager::ToolFinder::mergeTools ( std::vector< std::pair< ToolVersion, ToolLocationInfo > > &  t_tools,
const std::vector< std::pair< ToolVersion, ToolLocationInfo > > &  t_newtools 
)
static
static ToolVersion openstudio::runmanager::ToolFinder::parseToolVersion ( const openstudio::path &  t_path)
static