All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Public Member Functions | Static Public Member Functions | Related Functions | List of all members
openstudio::model::OutputVariable Class Reference

#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 ()
std::string keyValue () const
bool isKeyValueDefaulted () const
std::string variableName () const
std::string reportingFrequency () const
bool isReportingFrequencyDefaulted () const
boost::optional< Scheduleschedule () 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 ()
- 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< ParentObjectparent () const
 Return this object's parent in the hierarchy, if it has one. More...
std::vector< ResourceObjectresources () 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< OutputVariableoutputVariables () const
 Get all output variables associated with this object, must run simulation to generate data. More...
< openstudio::TimeSeries > 
getData (const OutputVariable &variable, const std::string &envPeriod) const
 Get data associated with this output variable and this object. More...
std::vector< LifeCycleCostlifeCycleCosts () 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...
AdditionalProperties additionalProperties () const
 Returns this object's additional properties, constructing a new object if necessary. More...
bool hasAdditionalProperties () const
 Returns true if this object has additional properties. More...
std::vector< IdfObject > removeAdditionalProperties ()
 Removes all additional properties that refer to this object. 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< ScheduleTypeKeygetScheduleTypeKeys (const Schedule &schedule) const
 Return the ScheduleTypeKeys indicating how schedule is used in this object. More...
boost::optional< double > getAutosizedValue (std::string valueName, std::string unitString) const
 Gets the autosized component value from the sql file. More...
virtual std::vector
< EMSActuatorNames
emsActuatorNames () const
 Return the names of the available ems actuators. More...
virtual std::vector< std::string > emsInternalVariableNames () const
 Return the names of the available ems internal variables. More...
boost::optional< ModelObjectconnectedObject (unsigned port) const
boost::optional< unsigned > connectedObjectPort (unsigned port) const

Static Public Member Functions

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

Related Functions

(Note that these are not member functions.)

typedef boost::optional
< OutputVariable
typedef std::vector
< OutputVariable

Additional Inherited Members

- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_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)

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 ( )
openstudio::model::OutputVariable::OutputVariable ( const std::string &  variableName,
const Model model 

Constructs a new OutputVariable object in the model.

Member Function Documentation

bool openstudio::model::OutputVariable::exportToBCVTB ( ) const
static IddObjectType openstudio::model::OutputVariable::iddObjectType ( )
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
virtual std::vector<openstudio::IdfObject> openstudio::model::OutputVariable::remove ( )
std::string openstudio::model::OutputVariable::reportingFrequency ( ) const
static std::vector<std::string> openstudio::model::OutputVariable::reportingFrequencyValues ( )
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

typedef boost::optional<OutputVariable> OptionalOutputVariable
typedef std::vector<OutputVariable> OutputVariableVector