#include <JobParam.hpp>

Public Member Functions
void	append (const JobParams &p)
	Append a collection of JobParams to this JobParams object. More...

void	append (const JobParam &p)
	Append a JobParam to this JobParams object. More...

void	append (const std::string &t_key, const std::string &t_value)
	Shortcut for appending a new JobParam to this collection. More...

void	append (const std::string &t_key, const JobParams &t_params)

JobParam	get (const std::string &value) const
	returns the JobParam with the given value if it exists More...

bool	has (const std::string &value) const

	JobParams ()
	Default constructor. More...

	JobParams (const std::vector< JobParam > &t_params)
	Create a JobParams object from a vector of JobParam. More...

bool	operator== (const JobParams &t_rhs) const

std::vector< JobParam >	params () const
	Returns the vector of params contained. More...

void	remove (const std::string &value)
	removes the JobParam with the given value if it exists More...

Detailed Description

Represents a collection of JobParam.

Constructor & Destructor Documentation

openstudio::runmanager::JobParams::JobParams ( )

inline

Default constructor.

openstudio::runmanager::JobParams::JobParams ( const std::vector< JobParam > & t_params )

inline

Create a JobParams object from a vector of JobParam.

void openstudio::runmanager::JobParams::append ( const JobParams & p )

inline

Append a collection of JobParams to this JobParams object.

void openstudio::runmanager::JobParams::append ( const JobParam & p )

inline

Append a JobParam to this JobParams object.

void openstudio::runmanager::JobParams::append	(	const std::string &	t_key,
		const std::string &	t_value
	)

inline

Shortcut for appending a new JobParam to this collection.

This function generates two JobParam objects. The first is the t_key value and the second is a child of the first, containing the t_value.

Parameters

[in]	t_key	Param key
[in]	t_value	Param value

void openstudio::runmanager::JobParams::append	(	const std::string &	t_key,
		const JobParams &	t_params
	)

inline

JobParam openstudio::runmanager::JobParams::get ( const std::string & value ) const

inline

returns the JobParam with the given value if it exists

Exceptions

std::runtime_error if the value does not exist

bool openstudio::runmanager::JobParams::has ( const std::string & value ) const

inline

bool openstudio::runmanager::JobParams::operator== ( const JobParams & t_rhs ) const

inline

std::vector<JobParam> openstudio::runmanager::JobParams::params ( ) const

inline

Returns the vector of params contained.

void openstudio::runmanager::JobParams::remove ( const std::string & value )

inline

removes the JobParam with the given value if it exists