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

#include <ToolInfo.hpp>

Public Member Functions

void append (const ToolInfo &fi)
 Appends a ToolInfo object to this collection of ToolInfo objects. More...
 
void append (const Tools &f)
 Appends the collection of ToolInfo objects in the Tools parameters to this collection of ToolInfo objects. More...
 
Tools getAllByName (const std::string &t_name) const
 Returns all ToolInfo objects in the collection that match the given name. More...
 
Tools getAllByVersion (const ToolVersion &t_version) const
 Returns all ToolInfo objects in the collection that match the given name. More...
 
ToolInfo getLastByName (const std::string &t_name) const
 Returns the last ToolInfo in the collection matching the given name. More...
 
ToolInfo getLastByVersion (const ToolVersion &t_version) const
 Returns the last ToolInfo object in the collection that match the given name. More...
 
ToolInfo getTool (const std::string &t_name) const
 Returns the tool with the given name and the highest version number. More...
 
ToolInfo getTool (const std::string &t_name, const ToolVersion &t_requirements) const
 Returns the tool with the given name and the highest version number that matches the passed in requirements. More...
 
bool operator== (const Tools &t_rhs) const
 
 Tools ()
 
 Tools (const std::vector< ToolInfo > &t_tools)
 Constructs a Tools object with the given vector of ToolInfo objects. More...
 
std::vector< ToolInfotools () const
 Returns the collection of ToolInfo objects in this object as a vector. More...
 

Detailed Description

Represents a collection of ToolInfo objects.

Constructor & Destructor Documentation

openstudio::runmanager::Tools::Tools ( )
inline
openstudio::runmanager::Tools::Tools ( const std::vector< ToolInfo > &  t_tools)
inline

Constructs a Tools object with the given vector of ToolInfo objects.

Member Function Documentation

void openstudio::runmanager::Tools::append ( const ToolInfo fi)
inline

Appends a ToolInfo object to this collection of ToolInfo objects.

void openstudio::runmanager::Tools::append ( const Tools f)
inline

Appends the collection of ToolInfo objects in the Tools parameters to this collection of ToolInfo objects.

Tools openstudio::runmanager::Tools::getAllByName ( const std::string &  t_name) const

Returns all ToolInfo objects in the collection that match the given name.

Tools openstudio::runmanager::Tools::getAllByVersion ( const ToolVersion t_version) const

Returns all ToolInfo objects in the collection that match the given name.

See also
openstudio::runmanager::ToolVersion for information on how ToolVersion objects are compared
ToolInfo openstudio::runmanager::Tools::getLastByName ( const std::string &  t_name) const

Returns the last ToolInfo in the collection matching the given name.

ToolInfo openstudio::runmanager::Tools::getLastByVersion ( const ToolVersion t_version) const

Returns the last ToolInfo object in the collection that match the given name.

See also
openstudio::runmanager::ToolVersion for information on how ToolVersion objects are compared
ToolInfo openstudio::runmanager::Tools::getTool ( const std::string &  t_name) const
inline

Returns the tool with the given name and the highest version number.

ToolInfo openstudio::runmanager::Tools::getTool ( const std::string &  t_name,
const ToolVersion t_requirements 
) const
inline

Returns the tool with the given name and the highest version number that matches the passed in requirements.

bool openstudio::runmanager::Tools::operator== ( const Tools t_rhs) const
inline
std::vector<ToolInfo> openstudio::runmanager::Tools::tools ( ) const
inline

Returns the collection of ToolInfo objects in this object as a vector.