OpenStudio:utilities
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
openstudio::WorkflowStep Class Reference

#include <WorkflowStep.hpp>

+ Inheritance diagram for openstudio::WorkflowStep:

Public Member Functions

template<typename T >
cast () const
 cast to type T, can throw std::bad_cast More...
 
bool operator== (const WorkflowStep &other) const
 Tests pointer equality. More...
 
template<typename T >
boost::optional< T > optionalCast () const
 cast to optional of type T More...
 
void resetResult ()
 Resets the optional WorkflowStepResult. More...
 
boost::optional
< WorkflowStepResult
result () const
 Returns the optional WorkflowStepResult. More...
 
void setResult (const WorkflowStepResult &result)
 Sets the optional WorkflowStepResult. More...
 
std::string string () const
 Serialize to JSON formatted string. More...
 
Json::Value toJSON () const
 
virtual ~WorkflowStep ()=default
 

Static Public Member Functions

static boost::optional
< WorkflowStep
fromString (const std::string &s)
 Construct from JSON formatted string. More...
 

Protected Member Functions

 WorkflowStep (std::shared_ptr< detail::WorkflowStep_Impl > impl)
 Protected constructor from impl. More...
 

Detailed Description

Base class for defining a step in an OpenStudio Workflow.

Constructor & Destructor Documentation

virtual openstudio::WorkflowStep::~WorkflowStep ( )
virtualdefault
openstudio::WorkflowStep::WorkflowStep ( std::shared_ptr< detail::WorkflowStep_Impl >  impl)
protected

Protected constructor from impl.

Member Function Documentation

template<typename T >
T openstudio::WorkflowStep::cast ( ) const
inline

cast to type T, can throw std::bad_cast

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

Construct from JSON formatted string.

bool openstudio::WorkflowStep::operator== ( const WorkflowStep other) const

Tests pointer equality.

template<typename T >
boost::optional<T> openstudio::WorkflowStep::optionalCast ( ) const
inline

cast to optional of type T

void openstudio::WorkflowStep::resetResult ( )

Resets the optional WorkflowStepResult.

boost::optional<WorkflowStepResult> openstudio::WorkflowStep::result ( ) const

Returns the optional WorkflowStepResult.

void openstudio::WorkflowStep::setResult ( const WorkflowStepResult result)

Sets the optional WorkflowStepResult.

std::string openstudio::WorkflowStep::string ( ) const

Serialize to JSON formatted string.

Json::Value openstudio::WorkflowStep::toJSON ( ) const