#include <WorkflowStep.hpp>

Inheritance diagram for openstudio::MeasureStep:

Public Member Functions
std::map< std::string, Variant >	arguments () const

void	clearArguments ()

boost::optional< std::string >	description () const

boost::optional< Variant >	getArgument (const std::string &name) const

std::string	measureDirName () const

	MeasureStep ()

	MeasureStep (const std::string &measureDirName)

boost::optional< std::string >	modelerDescription () const

boost::optional< std::string >	name () const

void	removeArgument (const std::string &name)

void	resetDescription ()

void	resetModelerDescription ()

void	resetName ()

void	setArgument (const std::string &name, bool value)

void	setArgument (const std::string &name, const char *value)

void	setArgument (const std::string &name, const std::string &value)

void	setArgument (const std::string &name, const Variant &value)

void	setArgument (const std::string &name, double value)

void	setArgument (const std::string &name, int value)

bool	setDescription (const std::string &description)

bool	setModelerDescription (const std::string &modelerDescription)

bool	setName (const std::string &name)

Public Member Functions inherited from openstudio::WorkflowStep
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

Protected Member Functions
	MeasureStep (std::shared_ptr< detail::MeasureStep_Impl > impl)

bool	setMeasureDirName (const std::string &measureDirName)

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

Additional Inherited Members
Static Public Member Functions inherited from openstudio::WorkflowStep
static boost::optional< WorkflowStep >	fromString (const std::string &s)
	Construct from JSON formatted string.

Detailed Description

Base class for defining a step in an OpenStudio Workflow.

Constructor & Destructor Documentation

◆ MeasureStep() [1/3]

openstudio::MeasureStep::MeasureStep ( )

◆ MeasureStep() [2/3]

openstudio::MeasureStep::MeasureStep ( const std::string & measureDirName )

◆ MeasureStep() [3/3]

openstudio::MeasureStep::MeasureStep ( std::shared_ptr< detail::MeasureStep_Impl > impl )

protected

Member Function Documentation

◆ arguments()

std::map< std::string, Variant > openstudio::MeasureStep::arguments ( ) const

◆ clearArguments()

void openstudio::MeasureStep::clearArguments ( )

◆ description()

boost::optional< std::string > openstudio::MeasureStep::description ( ) const

◆ getArgument()

boost::optional< Variant > openstudio::MeasureStep::getArgument ( const std::string & name ) const

◆ measureDirName()

std::string openstudio::MeasureStep::measureDirName ( ) const

◆ modelerDescription()

boost::optional< std::string > openstudio::MeasureStep::modelerDescription ( ) const

◆ name()

boost::optional< std::string > openstudio::MeasureStep::name ( ) const

◆ removeArgument()

void openstudio::MeasureStep::removeArgument ( const std::string & name )

◆ resetDescription()

void openstudio::MeasureStep::resetDescription ( )

◆ resetModelerDescription()

void openstudio::MeasureStep::resetModelerDescription ( )

◆ resetName()

void openstudio::MeasureStep::resetName ( )

◆ setArgument() [1/6]

void openstudio::MeasureStep::setArgument	(	const std::string &	name,
		bool	value )

◆ setArgument() [2/6]

void openstudio::MeasureStep::setArgument	(	const std::string &	name,
		const char *	value )

◆ setArgument() [3/6]

void openstudio::MeasureStep::setArgument	(	const std::string &	name,
		const std::string &	value )

◆ setArgument() [4/6]

void openstudio::MeasureStep::setArgument	(	const std::string &	name,
		const Variant &	value )

◆ setArgument() [5/6]

void openstudio::MeasureStep::setArgument	(	const std::string &	name,
		double	value )

◆ setArgument() [6/6]

void openstudio::MeasureStep::setArgument	(	const std::string &	name,
		int	value )

◆ setDescription()

bool openstudio::MeasureStep::setDescription ( const std::string & description )

◆ setMeasureDirName()

bool openstudio::MeasureStep::setMeasureDirName ( const std::string & measureDirName )