openstudio::WorkflowStepValue Class Reference

#include <WorkflowStepResult.hpp>

Public Member Functions
Getters
std::string	name () const
std::string	displayName () const
boost::optional< std::string >	units () const
VariantType	variantType () const
	get the variant value type More...
Variant	valueAsVariant () const
	get value as a Variant More...
bool	valueAsBoolean () const
	get value as a bool More...
int	valueAsInteger () const
	get value as int More...
double	valueAsDouble () const
	get value as double More...
std::string	valueAsString () const
	get value as string More...
Setters
void	setName (const std::string &name)
void	setDisplayName (const std::string &displayName)
void	resetDisplayName ()
void	setUnits (const std::string &units)
void	resetUnits ()

Protected Member Functions
	WorkflowStepValue (std::shared_ptr< detail::WorkflowStepValue_Impl > impl)
	Protected constructor from impl. More...

Constructors and Destructors
	WorkflowStepValue (const std::string &name, const Variant &value)
	WorkflowStepValue (const std::string &name, const std::string &value)
	WorkflowStepValue (const std::string &name, const char *value)
	WorkflowStepValue (const std::string &name, double value)
	WorkflowStepValue (const std::string &name, int value)
	WorkflowStepValue (const std::string &name, bool value)
std::string	string () const
	Serialize to JSON formatted string. More...
static boost::optional < WorkflowStepValue >	fromString (const std::string &s)
	Construct from JSON formatted string. More...

Detailed Description

Class for storing a value set by OSRunner::registerValue.

Constructor & Destructor Documentation

openstudio::WorkflowStepValue::WorkflowStepValue	(	const std::string &	name,
		const Variant &	value
	)

openstudio::WorkflowStepValue::WorkflowStepValue	(	const std::string &	name,
		const std::string &	value
	)

openstudio::WorkflowStepValue::WorkflowStepValue	(	const std::string &	name,
		const char *	value
	)

openstudio::WorkflowStepValue::WorkflowStepValue	(	const std::string &	name,
		double	value
	)

openstudio::WorkflowStepValue::WorkflowStepValue	(	const std::string &	name,
		int	value
	)

openstudio::WorkflowStepValue::WorkflowStepValue	(	const std::string &	name,
		bool	value
	)

openstudio::WorkflowStepValue::WorkflowStepValue ( std::shared_ptr< detail::WorkflowStepValue_Impl >  impl )

protected

Protected constructor from impl.

Member Function Documentation

std::string openstudio::WorkflowStepValue::displayName

(

)

const

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

static

Construct from JSON formatted string.

std::string openstudio::WorkflowStepValue::name

(

)

const

void openstudio::WorkflowStepValue::resetDisplayName

(

)

void openstudio::WorkflowStepValue::resetUnits

(

)

void openstudio::WorkflowStepValue::setDisplayName

(

const std::string &

displayName

)

void openstudio::WorkflowStepValue::setName

(

const std::string &

name

)

void openstudio::WorkflowStepValue::setUnits

(

const std::string &

units

)

std::string openstudio::WorkflowStepValue::string

(

)

const

Serialize to JSON formatted string.

boost::optional<std::string> openstudio::WorkflowStepValue::units

(

)

const

bool openstudio::WorkflowStepValue::valueAsBoolean

(

)

const

get value as a bool

double openstudio::WorkflowStepValue::valueAsDouble

(

)

const

get value as double

int openstudio::WorkflowStepValue::valueAsInteger

(

)

const

get value as int

std::string openstudio::WorkflowStepValue::valueAsString

(

)

const

get value as string

Variant openstudio::WorkflowStepValue::valueAsVariant

(

)

const

get value as a Variant

VariantType openstudio::WorkflowStepValue::variantType

(

)

const

get the variant value type