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

#include <JobParam.hpp>

Public Member Functions

 JobParam (const std::string &t_value)
 
bool operator== (const JobParam &t_rhs) const
 

Static Public Member Functions

static bool hasByValue (const std::vector< JobParam > &t_params, const std::string &t_value)
 
static JobParam paramByValue (const std::vector< JobParam > &t_params, const std::string &t_value)
 
static void removeByValue (std::vector< JobParam > &t_params, const std::string &t_value)
 

Public Attributes

std::vector< JobParamchildren
 
std::string value
 

Detailed Description

Hierarchical list of named parameters to be used when passing advanced options to a Job The WorkflowJob currently makes use of this.

Constructor & Destructor Documentation

openstudio::runmanager::JobParam::JobParam ( const std::string &  t_value)
inline
Parameters
[in]t_valueThe value to assign the newly constructed JobParam

Member Function Documentation

static bool openstudio::runmanager::JobParam::hasByValue ( const std::vector< JobParam > &  t_params,
const std::string &  t_value 
)
inlinestatic
Parameters
[in]t_paramsthe list of params to search
[in]t_valuethe value to search for
Returns
the JobParam matching the given value. Throws an exception if it is not found
bool openstudio::runmanager::JobParam::operator== ( const JobParam t_rhs) const
inline
static JobParam openstudio::runmanager::JobParam::paramByValue ( const std::vector< JobParam > &  t_params,
const std::string &  t_value 
)
inlinestatic
Parameters
[in]t_paramsthe list of params to search
[in]t_valuethe value to search for
Returns
the JobParam matching the given value. Throws an exception if it is not found
static void openstudio::runmanager::JobParam::removeByValue ( std::vector< JobParam > &  t_params,
const std::string &  t_value 
)
inlinestatic
Parameters
[in]t_paramsthe list of params to search
[in]t_valuethe value to remove Erases the JobParam with the given value if it exists

Member Data Documentation

std::vector<JobParam> openstudio::runmanager::JobParam::children
std::string openstudio::runmanager::JobParam::value