OutputVariable Class Reference

#include "OutputVariable.hpp"

Inheritance diagram for openstudio::model::OutputVariable:

Public Member Functions
OutputVariable &	operator= (const OutputVariable &)=default
OutputVariable &	operator= (OutputVariable &&)=default
	OutputVariable (const OutputVariable &other)=default
	OutputVariable (OutputVariable &&other)=default
virtual	~OutputVariable ()=default
	OutputVariable (const std::string &variableName, const Model &model)
virtual std::vector < openstudio::IdfObject >	remove ()
std::string	keyValue () const
bool	isKeyValueDefaulted () const
std::string	variableName () const
std::string	reportingFrequency () const
bool	isReportingFrequencyDefaulted () const
boost::optional< Schedule >	schedule () const
bool	exportToBCVTB () const
bool	isExportToBCVTBDefaulted () const
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 ()
bool	setExportToBCVTB (bool exportToBCVTB)
void	resetExportToBCVTB ()

Static Public Member Functions
static IddObjectType	iddObjectType ()
static std::vector< std::string >	reportingFrequencyValues ()

Related Functions
using	OptionalOutputVariable = boost::optional< OutputVariable >
using	OutputVariableVector = std::vector< OutputVariable >

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 ( )

virtualdefault

openstudio::model::OutputVariable::OutputVariable ( const OutputVariable &  other )

default

openstudio::model::OutputVariable::OutputVariable ( OutputVariable &&  other )

default

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

explicit

Constructs a new OutputVariable object in the model.

Member Function Documentation

bool openstudio::model::OutputVariable::exportToBCVTB

(

)

const

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

static

bool openstudio::model::OutputVariable::isExportToBCVTBDefaulted

(

)

const

bool openstudio::model::OutputVariable::isKeyValueDefaulted

(

)

const

bool openstudio::model::OutputVariable::isReportingFrequencyDefaulted

(

)

const

std::string openstudio::model::OutputVariable::keyValue

(

)

const

OutputVariable& openstudio::model::OutputVariable::operator= ( const OutputVariable &  )

default

OutputVariable& openstudio::model::OutputVariable::operator= ( OutputVariable &&  )

default

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::resetExportToBCVTB

(

)

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::setExportToBCVTB

(

bool

exportToBCVTB

)

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

using OptionalOutputVariable = boost::optional<OutputVariable>

related

using OutputVariableVector = std::vector<OutputVariable>

related