#include <OutputAttributeVariable.hpp>

Inheritance diagram for openstudio::analysis::OutputAttributeVariable:

Public Member Functions
Constructors and Destructors
	OutputAttributeVariable (const std::string &name, const std::string &attributeName)

	OutputAttributeVariable (const UUID &uuid, const UUID &versionUUID, const std::string &name, const std::string &displayName, const std::string &description, const std::string &attributeName)
	Constructor provided for deserialization; not for general use. More...

virtual	~OutputAttributeVariable ()

Getters and Queries
std::string	attributeName () const

Setters
void	setAttributeName (const std::string &attributeName)

Public Member Functions inherited from openstudio::analysis::OutputVariable
virtual	~OutputVariable ()

Public Member Functions inherited from openstudio::analysis::Variable
virtual	~Variable ()

double	getValue (const DataPoint &dataPoint) const
	Get the variable value from a dataPoint. More...

Public Member Functions inherited from openstudio::analysis::AnalysisObject
virtual	~AnalysisObject ()

AnalysisObject	clone () const
	Deep copy. More...

std::string	name () const

std::string	displayName () const

std::string	description () const

openstudio::UUID	uuid () const

openstudio::UUID	versionUUID () const

bool	isDirty () const
	Returns true if this object has been changed since its dirty flag was last cleared. More...

bool	operator== (const AnalysisObject &other) const
	Compare impls. More...

bool	operator!= (const AnalysisObject &other) const

bool	uuidEqual (const AnalysisObject &other) const

bool	uuidAndVersionEqual (const AnalysisObject &other) const

boost::optional< AnalysisObject >	parent () const

void	setName (const std::string &newName)

void	setDisplayName (const std::string &newDisplayName)

void	setDescription (const std::string &newDescription)

bool	clearDirtyFlag ()
	Call this method to reset the dirty flag of this object and all its children. More...

bool	connect (const char signal, const QObject receiver, const char *slot, Qt::ConnectionType type=Qt::AutoConnection) const
	Connect signal from this AnalysisObject to slot on receiver. More...

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *slot=nullptr) const

template<typename T >
T	cast () const
	Cast to type T. More...

template<typename T >
boost::optional< T >	optionalCast () const
	Cast to boost::optional<T>. More...

Related Functions
(Note that these are not member functions.)
typedef boost::optional < OutputAttributeVariable >	OptionalOutputAttributeContinuousVariable

typedef boost::optional < OutputAttributeVariable >	OptionalOutputAttributeVariable

typedef OutputAttributeVariable	OutputAttributeContinuousVariable

typedef std::vector < OutputAttributeVariable >	OutputAttributeContinuousVariableVector

typedef std::vector < OutputAttributeVariable >	OutputAttributeVariableVector

Related Functions inherited from openstudio::analysis::OutputVariable
typedef boost::optional < OutputVariable >	OptionalOutputVariable

typedef std::vector < OutputVariable >	OutputVariableVector

Related Functions inherited from openstudio::analysis::Variable
typedef boost::optional< Variable >	OptionalVariable

typedef std::vector< Variable >	VariableVector

Related Functions inherited from openstudio::analysis::AnalysisObject
typedef std::vector < AnalysisObject >	AnalysisObjectVector

typedef boost::optional < AnalysisObject >	OptionalAnalysisObject

Detailed Description

OutputAttributeVariable is an OutputVariable that accesses attributes written to XML as part of a simulation post-processing step.

For instance, add an EnergyPlusPostProcess job or one of the Ruby post-process scripts (in ruby/openstudio/runmanager/rubyscripts) to your Problem's workflow and take a look at the resulting report.xml files. The value of an OutputAttributeVariable can be retrieved, but not set, and it cannot be retrieved until the DataPoint of interest has been successfully simulated. Therefore, OutputAttributeVariables can be used in Functions , but not in Problem workflows.

Constructor & Destructor Documentation

openstudio::analysis::OutputAttributeVariable::OutputAttributeVariable	(	const std::string &	name,
		const std::string &	attributeName
	)

openstudio::analysis::OutputAttributeVariable::OutputAttributeVariable	(	const UUID &	uuid,
		const UUID &	versionUUID,
		const std::string &	name,
		const std::string &	displayName,
		const std::string &	description,
		const std::string &	attributeName
	)