#include <OutputVariable.hpp>

Inheritance diagram for openstudio::model::OutputVariable:

Public Member Functions
virtual	~OutputVariable ()

Constructors and Destructors
	OutputVariable (const std::string &variableName, const Model &model)
	Constructs a new OutputVariable object in the model. More...

virtual std::vector < openstudio::IdfObject >	remove ()

Getters
std::string	keyValue () const

bool	isKeyValueDefaulted () const

std::string	variableName () const

std::string	reportingFrequency () const

bool	isReportingFrequencyDefaulted () const

boost::optional< Schedule >	schedule () const

Setters
bool	setKeyValue (const std::string &keyValue)

void	resetKeyValue ()

bool	setVariableName (const std::string &variableName)

bool	setReportingFrequency (const std::string &reportingFrequency)

void	resetReportingFrequency ()

bool	setSchedule (Schedule &schedule)

void	resetSchedule ()

Public Member Functions inherited from openstudio::model::ModelObject
virtual	~ModelObject ()

ModelObject	clone () const
	Creates a deep copy of this object, placing it in this object's model(). More...

ModelObject	clone (Model model) const
	Creates a deep copy of this object, placing it in model. More...

Component	createComponent () const
	Method for creating sharable Model snippets. More...

Model	model () const
	Returns the Model that contains this object. More...

boost::optional< ParentObject >	parent () const
	Return this object's parent in the hierarchy, if it has one. More...

std::vector< ResourceObject >	resources () const
	Get the resources directly used by this ModelObject. More...

template<typename T >
std::vector< T >	getModelObjectSources () const
	Get all objects of type T that point to this object. More...

template<typename T >
std::vector< T >	getModelObjectSources (IddObjectType iddObjectType) const
	Get all objects of type T that point to this object. More...

template<typename T >
boost::optional< T >	getModelObjectTarget (unsigned index) const
	Get the object of type T pointed to by this object from field index. More...

template<typename T >
std::vector< T >	getModelObjectTargets () const
	Get all objects of type T to which this object points. More...

const std::vector< std::string > &	outputVariableNames () const
	Get all output variables names that could be associated with this object. More...

std::vector< OutputVariable >	outputVariables () const
	Get all output variables associated with this object, must run simulation to generate data. More...

boost::optional < openstudio::TimeSeries >	getData (const OutputVariable &variable, const std::string &envPeriod) const
	Get data associated with this output variable and this object. More...

std::vector< LifeCycleCost >	lifeCycleCosts () const
	Returns the list of all LifeCycleCosts that refer to this object. More...

std::vector< IdfObject >	removeLifeCycleCosts ()
	Removes all LifeCycleCosts that refer to this object. More...

IddObjectType	iddObjectType () const
	This is a virtual function that will tell you the type of iddObject you are dealing with. More...

bool	setParent (ParentObject &newParent)
	set the parent, child may have to call non-const methods on the parent More...

bool	operator< (const ModelObject &right) const

bool	operator== (const ModelObject &other) const
	equality test More...

bool	operator!= (const ModelObject &other) const
	inequality test More...

std::vector< ScheduleTypeKey >	getScheduleTypeKeys (const Schedule &schedule) const
	Return the ScheduleTypeKeys indicating how schedule is used in this object. More...

boost::optional< ModelObject >	connectedObject (unsigned port) const

boost::optional< unsigned >	connectedObjectPort (unsigned port) const

Public Member Functions inherited from openstudio::WorkspaceObject
bool	canBeSource () const

bool	canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const

std::vector< std::string >	canBeTarget () const

std::vector< unsigned >	getSourceIndices (const Handle &targetHandle) const

std::vector< WorkspaceObject >	getSources (IddObjectType type) const

boost::optional< WorkspaceObject >	getTarget (unsigned index) const

IdfObject	idfObject ()

IdfObject	idfObject () const

bool	initialized () const

bool	isSource () const

bool	isTarget () const

unsigned	numSources () const

bool	objectListFieldsEqual (const WorkspaceObject &other) const

bool	objectListFieldsNonConflicting (const WorkspaceObject &other) const

bool	operator< (const WorkspaceObject &right) const

std::ostream &	operator<< (std::ostream &os, const WorkspaceObject &workspaceObject)

std::vector < openstudio::IdfObject >	remove ()

bool	setPointer (unsigned index, const Handle &targetHandle)

std::vector< WorkspaceObject >	sources () const

std::vector< WorkspaceObject >	targets () const

Workspace	workspace () const

virtual	~WorkspaceObject ()

Public Member Functions inherited from openstudio::IdfObject
std::string	briefDescription () const

T	cast () const

std::vector< T >	castVector (const std::vector< U > &objects)

std::vector< std::vector < std::string > >	clearExtensibleGroups ()

IdfObject	clone (bool keepHandle=false) const

std::string	comment () const

boost::optional< std::string >	createName (bool overwrite=true)

std::vector< unsigned >	dataFields () const

bool	dataFieldsEqual (const IdfObject &other) const

std::vector< std::string >	eraseExtensibleGroup (unsigned groupIndex)

std::vector< IdfExtensibleGroup >	extensibleGroups () const

boost::optional< std::string >	fieldComment (unsigned index, bool returnDefault=false) const

boost::optional< double >	getDouble (unsigned index, bool returnDefault=false) const

IdfExtensibleGroup	getExtensibleGroup (unsigned groupIndex) const

std::vector< Handle >	getHandles (const std::vector< T > &objects)

boost::optional< int >	getInt (unsigned index, bool returnDefault=false) const

OSOptionalQuantity	getQuantity (unsigned index, bool returnDefault=false, bool returnIP=false) const

boost::optional< std::string >	getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const

boost::optional< unsigned >	getUnsigned (unsigned index, bool returnDefault=false) const

boost::optional< QUrl >	getURL (unsigned index, bool returnDefault=false) const

Handle	handle () const

IddObject	iddObject () const

	IdfObject (IddObjectType type, bool fastName=false)

	IdfObject (const IddObject &, bool fastName=false)

	IdfObject (const IdfObject &other)

IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex)

IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)

bool	isDataField (unsigned index) const

bool	isEmpty (unsigned index) const

bool	isObjectListField (unsigned index) const

bool	isValid (StrictnessLevel level) const

boost::optional< unsigned >	maxExtensibleGroups () const

boost::optional< unsigned >	maxFields () const

unsigned	minExtensibleGroups () const

unsigned	minFields () const

boost::optional< std::string >	name (bool returnDefault=false) const

std::string	nameString (bool returnDefault=false) const

unsigned	numExtensibleGroups () const

unsigned	numFields () const

unsigned	numNonextensibleFields () const

std::vector< unsigned >	objectListFields () const

bool	objectListFieldsEqual (const IdfObject &other) const

bool	objectListFieldsNonConflicting (const IdfObject &other) const

bool	operator!= (const IdfObject &other) const

std::ostream &	operator<< (std::ostream &os, const IdfObject &IdfObject)

bool	operator== (const IdfObject &other) const

boost::optional< T >	optionalCast () const

std::vector< std::string >	popExtensibleGroup ()

std::ostream &	print (std::ostream &os) const

std::ostream &	printField (std::ostream &os, unsigned index, bool isLastField=false) const

std::ostream &	printName (std::ostream &os, bool hasFields=true) const

IdfExtensibleGroup	pushExtensibleGroup ()

IdfExtensibleGroup	pushExtensibleGroup (const std::vector< std::string > &values)

std::vector< unsigned >	requiredFields () const

void	setComment (const std::string &msg)

bool	setDouble (unsigned index, double value)

bool	setFieldComment (unsigned index, const std::string &cmnt)

bool	setInt (unsigned index, int value)

boost::optional< std::string >	setName (const std::string &newName)

bool	setQuantity (unsigned index, const Quantity &q)

bool	setString (unsigned index, const std::string &value)

bool	setUnsigned (unsigned index, unsigned value)

std::vector< T >	subsetCastVector (const std::vector< U > &original)

ValidityReport	validityReport (StrictnessLevel level, bool checkNames=true) const

virtual	~IdfObject ()

Static Public Member Functions
static IddObjectType	iddObjectType ()

static std::vector< std::string >	reportingFrequencyValues ()

Static Public Member Functions inherited from openstudio::IdfObject
static boost::optional< IdfObject >	load (const std::string &text)

static boost::optional< IdfObject >	load (const std::string &text, const IddObject &iddObject)

static int	printedFieldSpace ()

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

typedef std::vector < OutputVariable >	OutputVariableVector

Related Functions inherited from openstudio::model::ModelObject
std::vector< ResourceObject >	getRecursiveResources (const ModelObject &object)
	Returns all ResourceObjects accessible by recursively calling .resources() starting from object. More...

typedef std::pair< std::string, std::string >	ScheduleTypeKey
	Typedef for ScheduleTypeRegistry key. More...

Additional Inherited Members
Public Types inherited from openstudio::WorkspaceObject
typedef boost::optional < WorkspaceObject >	OptionalWorkspaceObject

typedef std::vector < WorkspaceObject >	WorkspaceObjectVector

Public Types inherited from openstudio::IdfObject
typedef std::pair< IdfObject, IdfObject >	IdfObjectPair

typedef std::vector< IdfObject >	IdfObjectVector

typedef boost::optional < IdfObject >	OptionalIdfObject

Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl	ImplType

Protected Types inherited from openstudio::WorkspaceObject
typedef detail::WorkspaceObject_Impl	ImplType

Protected Types inherited from openstudio::IdfObject
typedef detail::IdfObject_Impl	ImplType

Protected Member Functions inherited from openstudio::model::ModelObject
	ModelObject (IddObjectType type, const Model &model, bool fastName=false)

	ModelObject (std::shared_ptr< detail::ModelObject_Impl > impl)

Protected Member Functions inherited from openstudio::WorkspaceObject
	WorkspaceObject (std::shared_ptr< detail::WorkspaceObject_Impl > impl)

Protected Member Functions inherited from openstudio::IdfObject
	IdfObject (std::shared_ptr< detail::IdfObject_Impl > impl)

Detailed Description

OutputVariable derives from ModelObject and is an interface to the OpenStudio IDD object named "OS:Output:Variable".

OutputVariable is used to request output data from EnergyPlus simulations. Each ModelObject defines a list of available output variable names which can be used to create OutputVariable requests. An OutputVariable request can apply to all objects (e.g. if the 'Key Value' field is set to '*') or only a particular object (e.g. if the 'Key Value' field is set to an object's name). If an OutputVariable object refers to a particular ModelObject then it is parented by that ModelObject, otherwise it is unparented. If an OutputVariable object is present when a Model is simulated in EnergyPlus, the OutputVariable can be used to access simulation results for its parent ModelObject.

Constructor & Destructor Documentation

virtual openstudio::model::OutputVariable::~OutputVariable ( )

inlinevirtual

openstudio::model::OutputVariable::OutputVariable	(	const std::string &	variableName,
		const Model &	model
	)

explicit

Constructs a new OutputVariable object in the model.

Member Function Documentation

static IddObjectType openstudio::model::OutputVariable::iddObjectType ( )

static

bool openstudio::model::OutputVariable::isKeyValueDefaulted ( ) const

bool openstudio::model::OutputVariable::isReportingFrequencyDefaulted ( ) const

std::string openstudio::model::OutputVariable::keyValue ( ) const

virtual std::vector<openstudio::IdfObject> openstudio::model::OutputVariable::remove ( )

virtual

std::string openstudio::model::OutputVariable::reportingFrequency ( ) const

static std::vector<std::string> openstudio::model::OutputVariable::reportingFrequencyValues ( )

static

void openstudio::model::OutputVariable::resetKeyValue ( )

void openstudio::model::OutputVariable::resetReportingFrequency ( )

void openstudio::model::OutputVariable::resetSchedule ( )

boost::optional<Schedule> openstudio::model::OutputVariable::schedule ( ) const

bool openstudio::model::OutputVariable::setKeyValue ( const std::string & keyValue )

bool openstudio::model::OutputVariable::setReportingFrequency ( const std::string & reportingFrequency )

bool openstudio::model::OutputVariable::setSchedule ( Schedule & schedule )

bool openstudio::model::OutputVariable::setVariableName ( const std::string & variableName )

std::string openstudio::model::OutputVariable::variableName ( ) const

Friends And Related Function Documentation

typedef boost::optional<OutputVariable> OptionalOutputVariable

Public Member Functions

Static Public Member Functions

Related Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation