openstudio::runmanager::JobErrors Struct Reference

#include <JobErrors.hpp>

Public Member Functions
void	addError (ErrorType t_et, const std::string &t_value)
std::vector< std::string >	errors () const
std::vector< std::string >	errorsByType (const ErrorType &t_et) const
std::vector< std::pair< int, std::string > >	errorsByTypeWithCount (const ErrorType &t_et) const
std::vector< std::string >	finalConditions () const
std::vector< std::string >	infos () const
std::vector< std::string >	initialConditions () const
	JobErrors ()
	Default constructor Defaults to succeeded = false. More...
	JobErrors (openstudio::ruleset::OSResultValue t_result, const std::vector< std::pair< ErrorType, std::string > > &t_errors)
	Constructor. More...
JobErrors	operator+ (const JobErrors &t_rhs) const
	Add a JobErrors object to this one. More...
bool	operator== (const JobErrors &t_rhs) const
bool	succeeded () const
int	totalCountByType (const ErrorType &t_et) const
std::vector< std::string >	warnings () const

Public Attributes
std::vector< std::pair < ErrorType, std::string > >	allErrors
unsigned	numNAs
openstudio::ruleset::OSResultValue	result

Detailed Description

Holds a vector of errors and warnings descriptions generated during a job execution plus a flag indicating if the job could be considered a success regardless of errors.

Constructor & Destructor Documentation

openstudio::runmanager::JobErrors::JobErrors ( )

inline

Default constructor Defaults to succeeded = false.

openstudio::runmanager::JobErrors::JobErrors ( openstudio::ruleset::OSResultValue  t_result, const std::vector< std::pair< ErrorType, std::string > > &  t_errors  )

inline

Constructor.

Parameters

[in]	t_result	Set to true if the job was considered a success regardless of errors generated
[in]	t_errors	The vector of error description strings to set

Member Function Documentation

void openstudio::runmanager::JobErrors::addError ( ErrorType  t_et, const std::string &  t_value  )

inline

std::vector<std::string> openstudio::runmanager::JobErrors::errors ( ) const

inline

std::vector<std::string> openstudio::runmanager::JobErrors::errorsByType ( const ErrorType &  t_et ) const

inline

std::vector<std::pair<int, std::string> > openstudio::runmanager::JobErrors::errorsByTypeWithCount

(

const ErrorType &

t_et

)

const

std::vector<std::string> openstudio::runmanager::JobErrors::finalConditions ( ) const

inline

std::vector<std::string> openstudio::runmanager::JobErrors::infos ( ) const

inline

std::vector<std::string> openstudio::runmanager::JobErrors::initialConditions ( ) const

inline

JobErrors openstudio::runmanager::JobErrors::operator+ ( const JobErrors &  t_rhs ) const

inline

Add a JobErrors object to this one.

Parameters

[in]

t_rhs

Right hand side of operation

Returns

a new JobErrors object consisting of the set of warnings and errors from the RHS concatenated to the end of the warnings and errors from the LHS. Succeeded is set to true in the result only if both lhs and rhs result.

bool openstudio::runmanager::JobErrors::operator==

(

const JobErrors &

t_rhs

)

const

bool openstudio::runmanager::JobErrors::succeeded ( ) const

inline

int openstudio::runmanager::JobErrors::totalCountByType

(

const ErrorType &

t_et

)

const

std::vector<std::string> openstudio::runmanager::JobErrors::warnings ( ) const

inline

Member Data Documentation

std::vector<std::pair<ErrorType, std::string> > openstudio::runmanager::JobErrors::allErrors

unsigned openstudio::runmanager::JobErrors::numNAs

openstudio::ruleset::OSResultValue openstudio::runmanager::JobErrors::result