openstudio::WorkflowStepResult Class Reference

#include <WorkflowStepResult.hpp>

Public Member Functions
Getters
boost::optional< DateTime >	startedAt () const
boost::optional< DateTime >	completedAt () const
boost::optional< MeasureType >	measureType () const
boost::optional< std::string >	measureName () const
boost::optional< std::string >	measureId () const
boost::optional< UUID >	measureUUID () const
boost::optional< std::string >	measureVersionId () const
boost::optional< UUID >	measureVersionUUID () const
boost::optional< DateTime >	measureVersionModified () const
boost::optional< std::string >	measureXmlChecksum () const
boost::optional< std::string >	measureClassName () const
boost::optional< std::string >	measureDisplayName () const
boost::optional< std::string >	measureTaxonomy () 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

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

Setters
void	setStartedAt (const DateTime &dateTime)
void	resetStartedAt ()
void	setCompletedAt (const DateTime &dateTime)
void	resetCompletedAt ()
bool	setMeasureType (const MeasureType &measureType)
void	resetMeasureType ()
bool	setMeasureName (const std::string &name)
void	resetMeasureName ()
bool	setMeasureId (const std::string &id)
void	resetMeasureId ()
bool	setMeasureUUID (const UUID &uuid)
void	resetMeasureUUID ()
bool	setMeasureVersionId (const std::string &id)
void	resetMeasureVersionId ()
bool	setMeasureVersionUUID (const UUID &uuid)
void	resetMeasureVersionUUID ()
bool	setMeasureVersionModified (const DateTime &versionModified)
void	resetMeasureVersionModified ()
bool	setMeasureXmlChecksum (const std::string &checksum)
void	resetMeasureXmlChecksum ()
bool	setMeasureClassName (const std::string &className)
void	resetMeasureClassName ()
bool	setMeasureDisplayName (const std::string &displayName)
void	resetMeasureDisplayName ()
bool	setMeasureTaxonomy (const std::string &taxonomy)
void	resetMeasureTaxonomy ()
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 ()
	WorkflowStepResult (std::shared_ptr< detail::WorkflowStepResult_Impl > impl)
	Protected constructor from impl.

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

WorkflowStepResult() [1/3]

openstudio::WorkflowStepResult::WorkflowStepResult

(

)

Default constructor.

WorkflowStepResult() [2/3]

openstudio::WorkflowStepResult::WorkflowStepResult

(

const WorkflowStepResult &

other

)

Copy constructor.

WorkflowStepResult() [3/3]

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

protected

Protected constructor from impl.

Member Function Documentation

addStepError()

void openstudio::WorkflowStepResult::addStepError

(

const std::string &

error

)

addStepFile()

void openstudio::WorkflowStepResult::addStepFile

(

const openstudio::path &

path

)

addStepInfo()

void openstudio::WorkflowStepResult::addStepInfo

(

const std::string &

info

)

addStepValue()

void openstudio::WorkflowStepResult::addStepValue

(

const WorkflowStepValue &

value

)

addStepWarning()

void openstudio::WorkflowStepResult::addStepWarning

(

const std::string &

warning

)

attributes()

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

(

)

const

completedAt()

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

(

)

const

errors()

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

(

)

const

finalCondition()

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

(

)

const

fromString()

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

static

Construct from JSON formatted string.

info()

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

(

)

const

initialCondition()

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

(

)

const

measureClassName()

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

(

)

const

measureDisplayName()

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

(

)

const

measureId()

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

(

)

const

measureName()

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

(

)

const

measureTaxonomy()

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

(

)

const

measureType()

boost::optional< MeasureType > openstudio::WorkflowStepResult::measureType

(

)

const

measureUUID()

boost::optional< UUID > openstudio::WorkflowStepResult::measureUUID

(

)

const

measureVersionId()

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

(

)

const

measureVersionModified()

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

(

)

const

measureVersionUUID()

boost::optional< UUID > openstudio::WorkflowStepResult::measureVersionUUID

(

)

const

measureXmlChecksum()

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

(

)

const

resetCompletedAt()

void openstudio::WorkflowStepResult::resetCompletedAt

(

)

resetMeasureClassName()

void openstudio::WorkflowStepResult::resetMeasureClassName

(

)

resetMeasureDisplayName()

void openstudio::WorkflowStepResult::resetMeasureDisplayName

(

)

resetMeasureId()

void openstudio::WorkflowStepResult::resetMeasureId

(

)

resetMeasureName()

void openstudio::WorkflowStepResult::resetMeasureName

(

)

resetMeasureTaxonomy()

void openstudio::WorkflowStepResult::resetMeasureTaxonomy

(

)

resetMeasureType()

void openstudio::WorkflowStepResult::resetMeasureType

(

)

resetMeasureUUID()

void openstudio::WorkflowStepResult::resetMeasureUUID

(

)

resetMeasureVersionId()

void openstudio::WorkflowStepResult::resetMeasureVersionId

(

)

resetMeasureVersionModified()

void openstudio::WorkflowStepResult::resetMeasureVersionModified

(

)

resetMeasureVersionUUID()

void openstudio::WorkflowStepResult::resetMeasureVersionUUID

(

)

resetMeasureXmlChecksum()

void openstudio::WorkflowStepResult::resetMeasureXmlChecksum

(

)

resetStartedAt()

void openstudio::WorkflowStepResult::resetStartedAt

(

)

resetStdErr()

void openstudio::WorkflowStepResult::resetStdErr

(

)

resetStdOut()

void openstudio::WorkflowStepResult::resetStdOut

(

)

resetStepErrors()

void openstudio::WorkflowStepResult::resetStepErrors

(

)

resetStepFiles()

void openstudio::WorkflowStepResult::resetStepFiles

(

)

resetStepFinalCondition()

void openstudio::WorkflowStepResult::resetStepFinalCondition

(

)

resetStepInfo()

void openstudio::WorkflowStepResult::resetStepInfo

(

)

resetStepInitialCondition()

void openstudio::WorkflowStepResult::resetStepInitialCondition

(

)

resetStepResult()

void openstudio::WorkflowStepResult::resetStepResult

(

)

resetStepValues()

void openstudio::WorkflowStepResult::resetStepValues

(

)

resetStepWarnings()

void openstudio::WorkflowStepResult::resetStepWarnings

(

)

setCompletedAt()

void openstudio::WorkflowStepResult::setCompletedAt

(

const DateTime &

dateTime

)

setMeasureClassName()

bool openstudio::WorkflowStepResult::setMeasureClassName

(

const std::string &

className

)

setMeasureDisplayName()

bool openstudio::WorkflowStepResult::setMeasureDisplayName

(

const std::string &

displayName

)

setMeasureId()

bool openstudio::WorkflowStepResult::setMeasureId

(

const std::string &

id

)

setMeasureName()

bool openstudio::WorkflowStepResult::setMeasureName

(

const std::string &

name

)

setMeasureTaxonomy()

bool openstudio::WorkflowStepResult::setMeasureTaxonomy

(

const std::string &

taxonomy

)

setMeasureType()

bool openstudio::WorkflowStepResult::setMeasureType

(

const MeasureType &

measureType

)

setMeasureUUID()

bool openstudio::WorkflowStepResult::setMeasureUUID

(

const UUID &

uuid

)

setMeasureVersionId()

bool openstudio::WorkflowStepResult::setMeasureVersionId

(

const std::string &

id

)

setMeasureVersionModified()

bool openstudio::WorkflowStepResult::setMeasureVersionModified

(

const DateTime &

versionModified

)

setMeasureVersionUUID()

bool openstudio::WorkflowStepResult::setMeasureVersionUUID

(

const UUID &

uuid

)

setMeasureXmlChecksum()

bool openstudio::WorkflowStepResult::setMeasureXmlChecksum

(

const std::string &

checksum

)

setStartedAt()

void openstudio::WorkflowStepResult::setStartedAt

(

const DateTime &

dateTime

)

setStdErr()

void openstudio::WorkflowStepResult::setStdErr

(

const std::string &

stdErr

)

setStdOut()

void openstudio::WorkflowStepResult::setStdOut

(

const std::string &

stdOut

)

setStepFinalCondition()

void openstudio::WorkflowStepResult::setStepFinalCondition

(

const std::string &

finalCondition

)

setStepInitialCondition()

void openstudio::WorkflowStepResult::setStepInitialCondition

(

const std::string &

initialCondition

)

setStepResult()

void openstudio::WorkflowStepResult::setStepResult

(

const StepResult &

result

)

startedAt()

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

(

)

const

stdErr()

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

(

)

const

stdOut()

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

(

)

const

stepErrors()

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

(

)

const

stepFiles()

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

(

)

const

stepFinalCondition()

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

(

)

const

stepInfo()

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

(

)

const

stepInitialCondition()

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

(

)

const

stepResult()

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

(

)

const

stepValues()

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

(

)

const

stepWarnings()

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

(

)

const

string()

std::string openstudio::WorkflowStepResult::string

(

)

const

Serialize to JSON formatted string.

toJSON()

Json::Value openstudio::WorkflowStepResult::toJSON

(

)

const

value()

StepResult openstudio::WorkflowStepResult::value

(

)

const

warnings()

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

(

)

const