#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 |
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 &modified) |
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 () |
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... | |
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.
openstudio::WorkflowStepResult::WorkflowStepResult | ( | ) |
Default constructor.
openstudio::WorkflowStepResult::WorkflowStepResult | ( | const WorkflowStepResult & | other | ) |
Copy constructor.
|
protected |
Protected constructor from impl.
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 |
Construct from JSON formatted string.
std::vector<LogMessage> openstudio::WorkflowStepResult::info | ( | ) | const |
boost::optional<LogMessage> openstudio::WorkflowStepResult::initialCondition | ( | ) | const |
boost::optional<std::string> openstudio::WorkflowStepResult::measureClassName | ( | ) | const |
boost::optional<std::string> openstudio::WorkflowStepResult::measureDisplayName | ( | ) | const |
boost::optional<std::string> openstudio::WorkflowStepResult::measureId | ( | ) | const |
boost::optional<std::string> openstudio::WorkflowStepResult::measureName | ( | ) | const |
boost::optional<std::string> openstudio::WorkflowStepResult::measureTaxonomy | ( | ) | const |
boost::optional<MeasureType> openstudio::WorkflowStepResult::measureType | ( | ) | const |
boost::optional<UUID> openstudio::WorkflowStepResult::measureUUID | ( | ) | const |
boost::optional<std::string> openstudio::WorkflowStepResult::measureVersionId | ( | ) | const |
boost::optional<DateTime> openstudio::WorkflowStepResult::measureVersionModified | ( | ) | const |
boost::optional<UUID> openstudio::WorkflowStepResult::measureVersionUUID | ( | ) | const |
boost::optional<std::string> openstudio::WorkflowStepResult::measureXmlChecksum | ( | ) | const |
void openstudio::WorkflowStepResult::resetCompletedAt | ( | ) |
void openstudio::WorkflowStepResult::resetMeasureClassName | ( | ) |
void openstudio::WorkflowStepResult::resetMeasureDisplayName | ( | ) |
void openstudio::WorkflowStepResult::resetMeasureId | ( | ) |
void openstudio::WorkflowStepResult::resetMeasureName | ( | ) |
void openstudio::WorkflowStepResult::resetMeasureTaxonomy | ( | ) |
void openstudio::WorkflowStepResult::resetMeasureType | ( | ) |
void openstudio::WorkflowStepResult::resetMeasureUUID | ( | ) |
void openstudio::WorkflowStepResult::resetMeasureVersionId | ( | ) |
void openstudio::WorkflowStepResult::resetMeasureVersionModified | ( | ) |
void openstudio::WorkflowStepResult::resetMeasureVersionUUID | ( | ) |
void openstudio::WorkflowStepResult::resetMeasureXmlChecksum | ( | ) |
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 | ) |
bool openstudio::WorkflowStepResult::setMeasureClassName | ( | const std::string & | className | ) |
bool openstudio::WorkflowStepResult::setMeasureDisplayName | ( | const std::string & | displayName | ) |
bool openstudio::WorkflowStepResult::setMeasureId | ( | const std::string & | id | ) |
bool openstudio::WorkflowStepResult::setMeasureName | ( | const std::string & | name | ) |
bool openstudio::WorkflowStepResult::setMeasureTaxonomy | ( | const std::string & | taxonomy | ) |
bool openstudio::WorkflowStepResult::setMeasureType | ( | const MeasureType & | measureType | ) |
bool openstudio::WorkflowStepResult::setMeasureUUID | ( | const UUID & | uuid | ) |
bool openstudio::WorkflowStepResult::setMeasureVersionId | ( | const std::string & | id | ) |
bool openstudio::WorkflowStepResult::setMeasureVersionModified | ( | const DateTime & | modified | ) |
bool openstudio::WorkflowStepResult::setMeasureVersionUUID | ( | const UUID & | uuid | ) |
bool openstudio::WorkflowStepResult::setMeasureXmlChecksum | ( | const std::string & | checksum | ) |
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 |