openstudio::measure::OSMeasureInfo Class Reference

#include <OSMeasureInfoGetter.hpp>

Public Member Functions
std::vector< OSArgument >	arguments () const
	result of measure's arguments method called with empty model if information was successfully extracted from the script, otherwise empty More...
std::string	className () const
	name of measure class if information was successfully extracted from the script, otherwise empty More...
std::string	description () const
	result of measure's description method if information was successfully extracted from the script, otherwise empty More...
boost::optional< std::string >	error () const
	will be empty if information was successfully extracted from the script, otherwise includes error information More...
MeasureType	measureType () const
	type of measure if information was successfully extracted from the script, otherwise undefined More...
std::string	modelerDescription () const
	result of measure's modeler_description method if information was successfully extracted from the script, otherwise empty More...
std::string	name () const
	result of measure's name method if information was successfully extracted from the script, otherwise empty More...
	OSMeasureInfo (const std::string &error)
	Constructor used when Ruby interpreter fails to get information about the script. More...
	OSMeasureInfo (const MeasureType &measureType, const std::string &className, const std::string &name, const std::string &description, const std::string &taxonomy, const std::string &modelerDescription, const std::vector< OSArgument > &arguments, const std::vector< OSOutput > &outputs)
	Constructor used when Ruby interpreter succeeds to get information about the script. More...
std::vector< OSOutput >	outputs () const
	result of measure's outputs method called with empty model if information was successfully extracted from the script, otherwise empty More...
std::string	taxonomy () const
	result of measure's taxonomy method if information was successfully extracted from the script, otherwise empty More...
bool	update (BCLMeasure &measure) const
	Compares the measure's information from the xml with information extracted from the ruby measure Updates the measure if needed, returns true if an update was performed. More...

Detailed Description

OSMeasureInfo contains information that can be extracted from an OSMeasure by a parser.

Constructor & Destructor Documentation

openstudio::measure::OSMeasureInfo::OSMeasureInfo

(

const std::string &

error

)

Constructor used when Ruby interpreter fails to get information about the script.

openstudio::measure::OSMeasureInfo::OSMeasureInfo	(	const MeasureType &	measureType,
		const std::string &	className,
		const std::string &	name,
		const std::string &	description,
		const std::string &	taxonomy,
		const std::string &	modelerDescription,
		const std::vector< OSArgument > &	arguments,
		const std::vector< OSOutput > &	outputs
	)

Constructor used when Ruby interpreter succeeds to get information about the script.

Member Function Documentation

std::vector<OSArgument> openstudio::measure::OSMeasureInfo::arguments

(

)

const

result of measure's arguments method called with empty model if information was successfully extracted from the script, otherwise empty

std::string openstudio::measure::OSMeasureInfo::className

(

)

const

name of measure class if information was successfully extracted from the script, otherwise empty

std::string openstudio::measure::OSMeasureInfo::description

(

)

const

result of measure's description method if information was successfully extracted from the script, otherwise empty

boost::optional<std::string> openstudio::measure::OSMeasureInfo::error

(

)

const

will be empty if information was successfully extracted from the script, otherwise includes error information

MeasureType openstudio::measure::OSMeasureInfo::measureType

(

)

const

type of measure if information was successfully extracted from the script, otherwise undefined

std::string openstudio::measure::OSMeasureInfo::modelerDescription

(

)

const

result of measure's modeler_description method if information was successfully extracted from the script, otherwise empty

std::string openstudio::measure::OSMeasureInfo::name

(

)

const

result of measure's name method if information was successfully extracted from the script, otherwise empty

std::vector<OSOutput> openstudio::measure::OSMeasureInfo::outputs

(

)

const

result of measure's outputs method called with empty model if information was successfully extracted from the script, otherwise empty

std::string openstudio::measure::OSMeasureInfo::taxonomy

(

)

const

result of measure's taxonomy method if information was successfully extracted from the script, otherwise empty

bool openstudio::measure::OSMeasureInfo::update

(

BCLMeasure &

measure

)

const

Compares the measure's information from the xml with information extracted from the ruby measure Updates the measure if needed, returns true if an update was performed.