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

#include <EnergyManagementSystemOutputVariable.hpp>

+ Inheritance diagram for openstudio::model::EnergyManagementSystemOutputVariable:

Public Member Functions

Constructors and Destructors
 EnergyManagementSystemOutputVariable (const Model &model, const std::string eMSVariableName)
 
 EnergyManagementSystemOutputVariable (const Model &model, const EnergyManagementSystemActuator &object)
 
 EnergyManagementSystemOutputVariable (const Model &model, const EnergyManagementSystemSensor &object)
 
 EnergyManagementSystemOutputVariable (const Model &model, const EnergyManagementSystemGlobalVariable &object)
 
 EnergyManagementSystemOutputVariable (const Model &model, const EnergyManagementSystemTrendVariable &object)
 
 EnergyManagementSystemOutputVariable (const Model &model, const EnergyManagementSystemInternalVariable &object)
 
 EnergyManagementSystemOutputVariable (const Model &model, const EnergyManagementSystemCurveOrTableIndexVariable &object)
 
 EnergyManagementSystemOutputVariable (const Model &model, const EnergyManagementSystemConstructionIndexVariable &object)
 
virtual ~EnergyManagementSystemOutputVariable ()
 
Getters
std::string emsVariableName () const
 
std::string typeOfDataInVariable () const
 
std::string updateFrequency () const
 
std::string emsProgramOrSubroutineName () const
 
boost::optional
< EnergyManagementSystemProgram
emsProgram () const
 
boost::optional
< EnergyManagementSystemSubroutine
emsSubroutine () const
 
std::string units () const
 
boost::optional< ModelObjectemsVariableObject () const
 
boost::optional
< EnergyManagementSystemActuator
emsActuator () const
 
boost::optional
< EnergyManagementSystemSensor
emsSensor () const
 
boost::optional
< EnergyManagementSystemGlobalVariable
emsGlobalVariable () const
 
boost::optional
< EnergyManagementSystemTrendVariable
emsTrendVariable () const
 
boost::optional
< EnergyManagementSystemInternalVariable
emsInternalVariable () const
 
boost::optional
< EnergyManagementSystemCurveOrTableIndexVariable
emsCurveOrTableIndexVariable () const
 
boost::optional
< EnergyManagementSystemConstructionIndexVariable
emsConstructionIndexVariable () const
 
bool exportToBCVTB () const
 
bool isExportToBCVTBDefaulted () const
 
Setters
bool setEMSVariableName (const std::string &eMSVariableName)
 
bool setTypeOfDataInVariable (const std::string &typeofDatainVariable)
 
bool setUpdateFrequency (const std::string &updateFrequency)
 
bool setEMSProgramOrSubroutineName (const EnergyManagementSystemProgram &program)
 
bool setEMSProgramOrSubroutineName (const EnergyManagementSystemSubroutine &subroutine)
 
void resetEMSProgramOrSubroutineName ()
 
bool setUnits (const std::string &units)
 
void resetUnits ()
 
bool setEMSVariableName (const EnergyManagementSystemActuator &object)
 
bool setEMSVariableName (const EnergyManagementSystemSensor &object)
 
bool setEMSVariableName (const EnergyManagementSystemGlobalVariable &object)
 
bool setEMSVariableName (const EnergyManagementSystemTrendVariable &object)
 
bool setEMSVariableName (const EnergyManagementSystemInternalVariable &object)
 
bool setEMSVariableName (const EnergyManagementSystemCurveOrTableIndexVariable &object)
 
bool setEMSVariableName (const EnergyManagementSystemConstructionIndexVariable &object)
 
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...
 
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< 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 > typeOfDataInVariableValues ()
 
static std::vector< std::string > updateFrequencyValues ()
 

Related Functions

(Note that these are not member functions.)

typedef std::vector
< EnergyManagementSystemOutputVariable
EnergyManagementSystemOutputVariableVector
 
typedef boost::optional
< EnergyManagementSystemOutputVariable
OptionalEnergyManagementSystemOutputVariable
 

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

EnergyManagementSystemOutputVariable is a ModelObject that wraps the OpenStudio IDD object 'OS:EnergyManagementSystem:OutputVariable'.

Constructor & Destructor Documentation

openstudio::model::EnergyManagementSystemOutputVariable::EnergyManagementSystemOutputVariable ( const Model model,
const std::string  eMSVariableName 
)
explicit
openstudio::model::EnergyManagementSystemOutputVariable::EnergyManagementSystemOutputVariable ( const Model model,
const EnergyManagementSystemActuator object 
)
explicit
openstudio::model::EnergyManagementSystemOutputVariable::EnergyManagementSystemOutputVariable ( const Model model,
const EnergyManagementSystemSensor object 
)
explicit
openstudio::model::EnergyManagementSystemOutputVariable::EnergyManagementSystemOutputVariable ( const Model model,
const EnergyManagementSystemGlobalVariable object 
)
explicit
openstudio::model::EnergyManagementSystemOutputVariable::EnergyManagementSystemOutputVariable ( const Model model,
const EnergyManagementSystemTrendVariable object 
)
explicit
openstudio::model::EnergyManagementSystemOutputVariable::EnergyManagementSystemOutputVariable ( const Model model,
const EnergyManagementSystemInternalVariable object 
)
explicit
openstudio::model::EnergyManagementSystemOutputVariable::EnergyManagementSystemOutputVariable ( const Model model,
const EnergyManagementSystemCurveOrTableIndexVariable object 
)
explicit
openstudio::model::EnergyManagementSystemOutputVariable::EnergyManagementSystemOutputVariable ( const Model model,
const EnergyManagementSystemConstructionIndexVariable object 
)
explicit
virtual openstudio::model::EnergyManagementSystemOutputVariable::~EnergyManagementSystemOutputVariable ( )
inlinevirtual

Member Function Documentation

boost::optional<EnergyManagementSystemActuator> openstudio::model::EnergyManagementSystemOutputVariable::emsActuator ( ) const
boost::optional<EnergyManagementSystemConstructionIndexVariable> openstudio::model::EnergyManagementSystemOutputVariable::emsConstructionIndexVariable ( ) const
boost::optional<EnergyManagementSystemCurveOrTableIndexVariable> openstudio::model::EnergyManagementSystemOutputVariable::emsCurveOrTableIndexVariable ( ) const
boost::optional<EnergyManagementSystemGlobalVariable> openstudio::model::EnergyManagementSystemOutputVariable::emsGlobalVariable ( ) const
boost::optional<EnergyManagementSystemInternalVariable> openstudio::model::EnergyManagementSystemOutputVariable::emsInternalVariable ( ) const
boost::optional<EnergyManagementSystemProgram> openstudio::model::EnergyManagementSystemOutputVariable::emsProgram ( ) const
std::string openstudio::model::EnergyManagementSystemOutputVariable::emsProgramOrSubroutineName ( ) const
boost::optional<EnergyManagementSystemSensor> openstudio::model::EnergyManagementSystemOutputVariable::emsSensor ( ) const
boost::optional<EnergyManagementSystemSubroutine> openstudio::model::EnergyManagementSystemOutputVariable::emsSubroutine ( ) const
boost::optional<EnergyManagementSystemTrendVariable> openstudio::model::EnergyManagementSystemOutputVariable::emsTrendVariable ( ) const
std::string openstudio::model::EnergyManagementSystemOutputVariable::emsVariableName ( ) const
boost::optional<ModelObject> openstudio::model::EnergyManagementSystemOutputVariable::emsVariableObject ( ) const
bool openstudio::model::EnergyManagementSystemOutputVariable::exportToBCVTB ( ) const
static IddObjectType openstudio::model::EnergyManagementSystemOutputVariable::iddObjectType ( )
static
bool openstudio::model::EnergyManagementSystemOutputVariable::isExportToBCVTBDefaulted ( ) const
void openstudio::model::EnergyManagementSystemOutputVariable::resetEMSProgramOrSubroutineName ( )
void openstudio::model::EnergyManagementSystemOutputVariable::resetExportToBCVTB ( )
void openstudio::model::EnergyManagementSystemOutputVariable::resetUnits ( )
bool openstudio::model::EnergyManagementSystemOutputVariable::setEMSProgramOrSubroutineName ( const EnergyManagementSystemProgram program)
bool openstudio::model::EnergyManagementSystemOutputVariable::setEMSProgramOrSubroutineName ( const EnergyManagementSystemSubroutine subroutine)
bool openstudio::model::EnergyManagementSystemOutputVariable::setEMSVariableName ( const std::string &  eMSVariableName)
bool openstudio::model::EnergyManagementSystemOutputVariable::setEMSVariableName ( const EnergyManagementSystemActuator object)
bool openstudio::model::EnergyManagementSystemOutputVariable::setEMSVariableName ( const EnergyManagementSystemSensor object)
bool openstudio::model::EnergyManagementSystemOutputVariable::setEMSVariableName ( const EnergyManagementSystemGlobalVariable object)
bool openstudio::model::EnergyManagementSystemOutputVariable::setEMSVariableName ( const EnergyManagementSystemTrendVariable object)
bool openstudio::model::EnergyManagementSystemOutputVariable::setEMSVariableName ( const EnergyManagementSystemInternalVariable object)
bool openstudio::model::EnergyManagementSystemOutputVariable::setEMSVariableName ( const EnergyManagementSystemCurveOrTableIndexVariable object)
bool openstudio::model::EnergyManagementSystemOutputVariable::setEMSVariableName ( const EnergyManagementSystemConstructionIndexVariable object)
bool openstudio::model::EnergyManagementSystemOutputVariable::setExportToBCVTB ( bool  exportToBCVTB)
bool openstudio::model::EnergyManagementSystemOutputVariable::setTypeOfDataInVariable ( const std::string &  typeofDatainVariable)
bool openstudio::model::EnergyManagementSystemOutputVariable::setUnits ( const std::string &  units)
bool openstudio::model::EnergyManagementSystemOutputVariable::setUpdateFrequency ( const std::string &  updateFrequency)
std::string openstudio::model::EnergyManagementSystemOutputVariable::typeOfDataInVariable ( ) const
static std::vector<std::string> openstudio::model::EnergyManagementSystemOutputVariable::typeOfDataInVariableValues ( )
static
std::string openstudio::model::EnergyManagementSystemOutputVariable::units ( ) const
std::string openstudio::model::EnergyManagementSystemOutputVariable::updateFrequency ( ) const
static std::vector<std::string> openstudio::model::EnergyManagementSystemOutputVariable::updateFrequencyValues ( )
static

Friends And Related Function Documentation