openstudio::MeasureStep Class Reference

#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
boost::optional< std::string >	measureId () const
	MeasureStep (const std::string &measureDirName)
boost::optional< MeasureType >	measureType () const
boost::optional< UUID >	measureUUID () const
boost::optional< std::string >	modelerDescription () const
boost::optional< std::string >	name () const
void	removeArgument (const std::string &name)
void	resetDescription ()
void	resetMeasureId ()
void	resetMeasureType ()
void	resetMeasureUUID ()
void	resetModelerDescription ()
void	resetName ()
void	resetTaxonomy ()
void	resetVersionId ()
void	resetVersionUUID ()
void	setArgument (const std::string &name, const Variant &value)
void	setArgument (const std::string &name, bool value)
void	setArgument (const std::string &name, double value)
void	setArgument (const std::string &name, int value)
void	setArgument (const std::string &name, const char *value)
void	setArgument (const std::string &name, const std::string &value)
bool	setDescription (const std::string &description)
bool	setMeasureId (const std::string &id)
bool	setMeasureType (const MeasureType &measureType)
bool	setMeasureUUID (const UUID &uuid)
bool	setModelerDescription (const std::string &modelerDescription)
bool	setName (const std::string &name)
bool	setTaxonomy (const std::string &taxonomy)
bool	setVersionId (const std::string &id)
bool	setVersionUUID (const UUID &uuid)
boost::optional< std::string >	taxonomy () const
boost::optional< std::string >	versionId () const
boost::optional< UUID >	versionUUID () const
Public Member Functions inherited from openstudio::WorkflowStep
template<typename T >
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...
virtual	~WorkflowStep ()

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. More...

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. More...

Detailed Description

Base class for defining a step in an OpenStudio Workflow.

Constructor & Destructor Documentation

openstudio::MeasureStep::MeasureStep

(

const std::string &

measureDirName

)

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

protected

Member Function Documentation

std::map<std::string, Variant> openstudio::MeasureStep::arguments

(

)

const

void openstudio::MeasureStep::clearArguments

(

)

boost::optional<std::string> openstudio::MeasureStep::description

(

)

const

boost::optional<Variant> openstudio::MeasureStep::getArgument

(

const std::string &

name

)

const

std::string openstudio::MeasureStep::measureDirName

(

)

const

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

(

)

const

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

(

)

const

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

(

)

const

boost::optional<std::string> openstudio::MeasureStep::modelerDescription

(

)

const

boost::optional<std::string> openstudio::MeasureStep::name

(

)

const

void openstudio::MeasureStep::removeArgument

(

const std::string &

name

)

void openstudio::MeasureStep::resetDescription

(

)

void openstudio::MeasureStep::resetMeasureId

(

)

void openstudio::MeasureStep::resetMeasureType

(

)

void openstudio::MeasureStep::resetMeasureUUID

(

)

void openstudio::MeasureStep::resetModelerDescription

(

)

void openstudio::MeasureStep::resetName

(

)

void openstudio::MeasureStep::resetTaxonomy

(

)

void openstudio::MeasureStep::resetVersionId

(

)

void openstudio::MeasureStep::resetVersionUUID

(

)

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

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

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

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

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

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

bool openstudio::MeasureStep::setDescription

(

const std::string &

description

)

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

protected

bool openstudio::MeasureStep::setMeasureId

(

const std::string &

id

)

bool openstudio::MeasureStep::setMeasureType

(

const MeasureType &

measureType

)

bool openstudio::MeasureStep::setMeasureUUID

(

const UUID &

uuid

)

bool openstudio::MeasureStep::setModelerDescription

(

const std::string &

modelerDescription

)

bool openstudio::MeasureStep::setName

(

const std::string &

name

)

bool openstudio::MeasureStep::setTaxonomy

(

const std::string &

taxonomy

)

bool openstudio::MeasureStep::setVersionId

(

const std::string &

id

)

bool openstudio::MeasureStep::setVersionUUID

(

const UUID &

uuid

)

boost::optional<std::string> openstudio::MeasureStep::taxonomy

(

)

const

boost::optional<std::string> openstudio::MeasureStep::versionId

(

)

const

boost::optional<UUID> openstudio::MeasureStep::versionUUID

(

)

const