openstudio::WorkflowStepResult Class Reference

#include <WorkflowStepResult.hpp>

Public Member Functions
Getters
boost::optional< DateTime >	startedAt () const
boost::optional< DateTime >	completedAt () const
boost::optional< StepResult >	stepResult () const
boost::optional< std::string >	stepInitialCondition () const
boost::optional< std::string >	stepFinalCondition () const
std::vector< std::string >	stepErrors () const
std::vector< std::string >	stepWarnings () const
std::vector< std::string >	stepInfo () const
std::vector< WorkflowStepValue >	stepValues () const
std::vector< openstudio::path >	stepFiles () const
boost::optional< std::string >	stdOut () const
boost::optional< std::string >	stdErr () const
StepResult	value () const
std::vector< LogMessage >	errors () const
std::vector< LogMessage >	warnings () const
std::vector< LogMessage >	info () const
boost::optional< LogMessage >	initialCondition () const
boost::optional< LogMessage >	finalCondition () const
std::vector< Attribute >	attributes () const
Setters
void	setStartedAt (const DateTime &dateTime)
void	resetStartedAt ()
void	setCompletedAt (const DateTime &dateTime)
void	resetCompletedAt ()
void	setStepResult (const StepResult &result)
void	resetStepResult ()
void	setStepInitialCondition (const std::string &initialCondition)
void	resetStepInitialCondition ()
void	setStepFinalCondition (const std::string &finalCondition)
void	resetStepFinalCondition ()
void	addStepError (const std::string &error)
void	resetStepErrors ()
void	addStepWarning (const std::string &warning)
void	resetStepWarnings ()
void	addStepInfo (const std::string &info)
void	resetStepInfo ()
void	addStepValue (const WorkflowStepValue &value)
void	resetStepValues ()
void	addStepFile (const openstudio::path &path)
void	resetStepFiles ()
void	setStdOut (const std::string &stdOut)
void	resetStdOut ()
void	setStdErr (const std::string &stdErr)
void	resetStdErr ()

Protected Member Functions
	WorkflowStepResult (std::shared_ptr< detail::WorkflowStepResult_Impl > impl)
	Protected constructor from impl. More...

Constructors and Destructors
	WorkflowStepResult ()
	Default constructor. More...
	WorkflowStepResult (const WorkflowStepResult &other)
	Copy constructor. More...
std::string	string () const
	Serialize to JSON formatted string. More...
static boost::optional < WorkflowStepResult >	fromString (const std::string &s)
	Construct from JSON formatted string. More...

Detailed Description

Class for documenting the outcome of running a UserScript or a Ruleset.

There is an overall result flag (available from value()), and a number of message types.

Constructor & Destructor Documentation

openstudio::WorkflowStepResult::WorkflowStepResult

(

)

Default constructor.

openstudio::WorkflowStepResult::WorkflowStepResult

(

const WorkflowStepResult &

other

)

Copy constructor.

openstudio::WorkflowStepResult::WorkflowStepResult ( std::shared_ptr< detail::WorkflowStepResult_Impl >  impl )

protected

Protected constructor from impl.

Member Function Documentation

void openstudio::WorkflowStepResult::addStepError

(

const std::string &

error

)

void openstudio::WorkflowStepResult::addStepFile

(

const openstudio::path &

path

)

void openstudio::WorkflowStepResult::addStepInfo

(

const std::string &

info

)

void openstudio::WorkflowStepResult::addStepValue

(

const WorkflowStepValue &

value

)

void openstudio::WorkflowStepResult::addStepWarning

(

const std::string &

warning

)

std::vector<Attribute> openstudio::WorkflowStepResult::attributes

(

)

const

boost::optional<DateTime> openstudio::WorkflowStepResult::completedAt

(

)

const

std::vector<LogMessage> openstudio::WorkflowStepResult::errors

(

)

const

boost::optional<LogMessage> openstudio::WorkflowStepResult::finalCondition

(

)

const

static boost::optional<WorkflowStepResult> openstudio::WorkflowStepResult::fromString ( const std::string &  s )

static

Construct from JSON formatted string.

std::vector<LogMessage> openstudio::WorkflowStepResult::info

(

)

const

boost::optional<LogMessage> openstudio::WorkflowStepResult::initialCondition

(

)

const

void openstudio::WorkflowStepResult::resetCompletedAt

(

)

void openstudio::WorkflowStepResult::resetStartedAt

(

)

void openstudio::WorkflowStepResult::resetStdErr

(

)

void openstudio::WorkflowStepResult::resetStdOut

(

)

void openstudio::WorkflowStepResult::resetStepErrors

(

)

void openstudio::WorkflowStepResult::resetStepFiles

(

)

void openstudio::WorkflowStepResult::resetStepFinalCondition

(

)

void openstudio::WorkflowStepResult::resetStepInfo

(

)

void openstudio::WorkflowStepResult::resetStepInitialCondition

(

)

void openstudio::WorkflowStepResult::resetStepResult

(

)

void openstudio::WorkflowStepResult::resetStepValues

(

)

void openstudio::WorkflowStepResult::resetStepWarnings

(

)

void openstudio::WorkflowStepResult::setCompletedAt

(

const DateTime &

dateTime

)

void openstudio::WorkflowStepResult::setStartedAt

(

const DateTime &

dateTime

)

void openstudio::WorkflowStepResult::setStdErr

(

const std::string &

stdErr

)

void openstudio::WorkflowStepResult::setStdOut

(

const std::string &

stdOut

)

void openstudio::WorkflowStepResult::setStepFinalCondition

(

const std::string &

finalCondition

)

void openstudio::WorkflowStepResult::setStepInitialCondition

(

const std::string &

initialCondition

)

void openstudio::WorkflowStepResult::setStepResult

(

const StepResult &

result

)

boost::optional<DateTime> openstudio::WorkflowStepResult::startedAt

(

)

const

boost::optional<std::string> openstudio::WorkflowStepResult::stdErr

(

)

const

boost::optional<std::string> openstudio::WorkflowStepResult::stdOut

(

)

const

std::vector<std::string> openstudio::WorkflowStepResult::stepErrors

(

)

const

std::vector<openstudio::path> openstudio::WorkflowStepResult::stepFiles

(

)

const

boost::optional<std::string> openstudio::WorkflowStepResult::stepFinalCondition

(

)

const

std::vector<std::string> openstudio::WorkflowStepResult::stepInfo

(

)

const

boost::optional<std::string> openstudio::WorkflowStepResult::stepInitialCondition

(

)

const

boost::optional<StepResult> openstudio::WorkflowStepResult::stepResult

(

)

const

std::vector<WorkflowStepValue> openstudio::WorkflowStepResult::stepValues

(

)

const

std::vector<std::string> openstudio::WorkflowStepResult::stepWarnings

(

)

const

std::string openstudio::WorkflowStepResult::string

(

)

const

Serialize to JSON formatted string.

StepResult openstudio::WorkflowStepResult::value

(

)

const

std::vector<LogMessage> openstudio::WorkflowStepResult::warnings

(

)

const