openstudio::BCLMeasureArgument Class Reference

#include <BCLMeasureArgument.hpp>

Public Member Functions
	BCLMeasureArgument (const pugi::xml_node &element)
	BCLMeasureArgument (const std::string &name, const std::string &displayName, const boost::optional< std::string > &description, const std::string &type, const boost::optional< std::string > &units, bool required, bool modelDependent, const boost::optional< std::string > &defaultValue, const std::vector< std::string > &choiceValues, const std::vector< std::string > &choiceDisplayNames, const boost::optional< std::string > &minValue, const boost::optional< std::string > &maxValue)
std::vector< std::string >	choiceDisplayNames () const
std::vector< std::string >	choiceValues () const
boost::optional< std::string >	defaultValue () const
boost::optional< std::string >	description () const
std::string	displayName () const
boost::optional< std::string >	maxValue () const
boost::optional< std::string >	minValue () const
bool	modelDependent () const
std::string	name () const
bool	operator== (const BCLMeasureArgument &other) const
bool	required () const
Json::Value	toJSON () const
std::string	toJSONString () const
std::string	type () const
boost::optional< std::string >	units () const
void	writeValues (pugi::xml_node &element) const

Related Symbols
(Note that these are not member symbols.)
std::ostream &	operator<< (std::ostream &os, const BCLMeasureArgument &argument)
	Prints BCLMeasureArgument to os.

Detailed Description

BCLMeasureArgument is a class representing an argument of a measure.

This class does not hold the particular value of any argument, it simply declares that the BCLMeasure has this argument.

Constructor & Destructor Documentation

BCLMeasureArgument() [1/2]

openstudio::BCLMeasureArgument::BCLMeasureArgument

(

const pugi::xml_node &

element

)

BCLMeasureArgument() [2/2]

openstudio::BCLMeasureArgument::BCLMeasureArgument	(	const std::string &	name,
		const std::string &	displayName,
		const boost::optional< std::string > &	description,
		const std::string &	type,
		const boost::optional< std::string > &	units,
		bool	required,
		bool	modelDependent,
		const boost::optional< std::string > &	defaultValue,
		const std::vector< std::string > &	choiceValues,
		const std::vector< std::string > &	choiceDisplayNames,
		const boost::optional< std::string > &	minValue,
		const boost::optional< std::string > &	maxValue )

Member Function Documentation

choiceDisplayNames()

std::vector< std::string > openstudio::BCLMeasureArgument::choiceDisplayNames

(

)

const

choiceValues()

std::vector< std::string > openstudio::BCLMeasureArgument::choiceValues

(

)

const

defaultValue()

boost::optional< std::string > openstudio::BCLMeasureArgument::defaultValue

(

)

const

description()

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

(

)

const

displayName()

std::string openstudio::BCLMeasureArgument::displayName

(

)

const

maxValue()

boost::optional< std::string > openstudio::BCLMeasureArgument::maxValue

(

)

const

minValue()

boost::optional< std::string > openstudio::BCLMeasureArgument::minValue

(

)

const

modelDependent()

bool openstudio::BCLMeasureArgument::modelDependent

(

)

const

name()

std::string openstudio::BCLMeasureArgument::name

(

)

const

operator==()

bool openstudio::BCLMeasureArgument::operator==

(

const BCLMeasureArgument &

other

)

const

required()

bool openstudio::BCLMeasureArgument::required

(

)

const

toJSON()

Json::Value openstudio::BCLMeasureArgument::toJSON

(

)

const

toJSONString()

std::string openstudio::BCLMeasureArgument::toJSONString

(

)

const

type()

std::string openstudio::BCLMeasureArgument::type

(

)

const

units()

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

(

)

const

writeValues()

void openstudio::BCLMeasureArgument::writeValues

(

pugi::xml_node &

element

)

const

Friends And Related Symbol Documentation

operator<<()

std::ostream & operator<< ( std::ostream & os, const BCLMeasureArgument & argument )

related

Prints BCLMeasureArgument to os.