openstudio::WorkflowStep Class Reference

#include <WorkflowStep.hpp>

Inheritance diagram for openstudio::WorkflowStep:

Public Member Functions
template<typename T >
T	cast () const
	cast to type T, can throw std::bad_cast
bool	operator== (const WorkflowStep &other) const
	Tests pointer equality.
template<typename T >
boost::optional< T >	optionalCast () const
	cast to optional of type T
void	resetResult ()
	Resets the optional WorkflowStepResult.
boost::optional< WorkflowStepResult >	result () const
	Returns the optional WorkflowStepResult.
void	setResult (const WorkflowStepResult &result)
	Sets the optional WorkflowStepResult.
std::string	string () const
	Serialize to JSON formatted string.
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.

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

Detailed Description

Base class for defining a step in an OpenStudio Workflow.

Constructor & Destructor Documentation

~WorkflowStep()

virtual openstudio::WorkflowStep::~WorkflowStep ( )

virtualdefault

WorkflowStep()

openstudio::WorkflowStep::WorkflowStep ( std::shared_ptr< detail::WorkflowStep_Impl > impl )

protected

Protected constructor from impl.

Member Function Documentation

cast()

template<typename T >

T openstudio::WorkflowStep::cast ( ) const

inline

cast to type T, can throw std::bad_cast

fromString()

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

static

Construct from JSON formatted string.

operator==()

bool openstudio::WorkflowStep::operator==

(

const WorkflowStep &

other

)

const

Tests pointer equality.

optionalCast()

template<typename T >

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

inline

cast to optional of type T

resetResult()

void openstudio::WorkflowStep::resetResult

(

)

Resets the optional WorkflowStepResult.

result()

boost::optional< WorkflowStepResult > openstudio::WorkflowStep::result

(

)

const

Returns the optional WorkflowStepResult.

setResult()

void openstudio::WorkflowStep::setResult

(

const WorkflowStepResult &

result

)

Sets the optional WorkflowStepResult.

string()

std::string openstudio::WorkflowStep::string

(

)

const

Serialize to JSON formatted string.

toJSON()

Json::Value openstudio::WorkflowStep::toJSON

(

)

const