OpenStudioCore:runmanager/lib
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Public Member Functions | Public Attributes | List of all members
openstudio::runmanager::ToolInfo Struct Reference

#include <ToolInfo.hpp>

Public Member Functions

bool operator< (const ToolInfo &ti) const
 
bool operator== (const ToolInfo &t_rhs) const
 
 ToolInfo ()
 Default constructor, not really a valid ToolInfo object. More...
 
 ToolInfo (const std::string &t_name, const ToolVersion &t_version, const openstudio::path &t_localBinPath, const boost::regex &t_outFileFilter)
 Create a ToolInfo object. More...
 
 ToolInfo (const std::string &t_name, const openstudio::path &t_localBinPath)
 Create a ToolInfo object. More...
 
 ToolInfo (const std::string &t_name, const ToolVersion &t_version, const openstudio::path &t_localBinPath)
 Create a ToolInfo object. More...
 
 ToolInfo (const openstudio::path &t_localBinPath)
 Simplest ToolInfo constructor, useful only for locally executing jobs. More...
 

Public Attributes

openstudio::path localBinPath
 
std::string name
 
boost::regex outFileFilter
 
ToolVersion version
 

Detailed Description

Used for holding details about a tool binary location.

Constructor & Destructor Documentation

openstudio::runmanager::ToolInfo::ToolInfo ( )
inline

Default constructor, not really a valid ToolInfo object.

openstudio::runmanager::ToolInfo::ToolInfo ( const std::string &  t_name,
const ToolVersion t_version,
const openstudio::path &  t_localBinPath,
const boost::regex &  t_outFileFilter 
)
inline

Create a ToolInfo object.

Parameters
[in]t_nameName of tool
[in]t_versionTool version identifier
[in]t_localBinPathBinary location for running locally
[in]t_outFileFilterFilter to use when determining which files were generated by this tool
openstudio::runmanager::ToolInfo::ToolInfo ( const std::string &  t_name,
const openstudio::path &  t_localBinPath 
)
inline

Create a ToolInfo object.

Useful only for locally executing jobs

Parameters
[in]t_nameName of tool
[in]t_localBinPathBinary location for running locally
openstudio::runmanager::ToolInfo::ToolInfo ( const std::string &  t_name,
const ToolVersion t_version,
const openstudio::path &  t_localBinPath 
)
inline

Create a ToolInfo object.

Useful only for locally executing jobs

Parameters
[in]t_nameName of tool
[in]t_versionVersion info
[in]t_localBinPathBinary location for running locally
openstudio::runmanager::ToolInfo::ToolInfo ( const openstudio::path &  t_localBinPath)
inline

Simplest ToolInfo constructor, useful only for locally executing jobs.

Parameters
[in]t_localBinPathBinary location for running locally

Member Function Documentation

bool openstudio::runmanager::ToolInfo::operator< ( const ToolInfo ti) const
inline
bool openstudio::runmanager::ToolInfo::operator== ( const ToolInfo t_rhs) const
inline

Member Data Documentation

openstudio::path openstudio::runmanager::ToolInfo::localBinPath
std::string openstudio::runmanager::ToolInfo::name
boost::regex openstudio::runmanager::ToolInfo::outFileFilter
ToolVersion openstudio::runmanager::ToolInfo::version