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

#include <WaterUseEquipmentDefinition.hpp>

+ Inheritance diagram for openstudio::model::WaterUseEquipmentDefinition:

Public Member Functions

std::string endUseSubcategory () const
 
bool isEndUseSubcategoryDefaulted () const
 
boost::optional< SchedulelatentFractionSchedule () const
 
double peakFlowRate () const
 
void resetEndUseSubcategory ()
 
void resetLatentFractionSchedule ()
 
void resetSensibleFractionSchedule ()
 
void resetTargetTemperatureSchedule ()
 
boost::optional< SchedulesensibleFractionSchedule () const
 
bool setEndUseSubcategory (const std::string &endUseSubcategory)
 
bool setLatentFractionSchedule (const Schedule &latentFractionSchedule)
 
bool setPeakFlowRate (double peakFlowRate)
 
bool setSensibleFractionSchedule (const Schedule &sensibleFractionSchedule)
 
bool setTargetTemperatureSchedule (const Schedule &targetTemperatureSchedule)
 
boost::optional< ScheduletargetTemperatureSchedule () const
 
 WaterUseEquipmentDefinition (const Model &model)
 
virtual ~WaterUseEquipmentDefinition ()
 
- Public Member Functions inherited from openstudio::model::SpaceLoadDefinition
double floorArea () const
 Returns the floor area associated with instances of this space load definition. More...
 
std::vector< SpaceLoadInstanceinstances () const
 Returns all instances of this definition. More...
 
int quantity () const
 Returns the number of instances of this space load. More...
 
virtual ~SpaceLoadDefinition ()
 
- Public Member Functions inherited from openstudio::model::ResourceObject
unsigned directUseCount (bool excludeChildren=false) const
 Returns the number of objects that use this resource directly. More...
 
unsigned nonResourceObjectUseCount (bool excludeChildren=false) const
 Returns the number of non-ResourceObjects that use this resource either directly or indirectly. More...
 
virtual ~ResourceObject ()
 
- Public Member Functions inherited from openstudio::model::ParentObject
std::vector< IddObjectType > allowableChildTypes () const
 Returns a vector of allowable children types. More...
 
std::vector< ModelObjectchildren () const
 Return direct child objects in the Model. More...
 
virtual ~ParentObject ()
 
- 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...
 
boost::optional< std::string > cadObjectId () const
 
bool setCADObjectId (const std::string &cadObjectId)
 
boost::optional< std::string > gbXMLId () const
 
bool setGBXMLId (const std::string &gbXMLId)
 
boost::optional< std::string > displayName () const
 
bool setDisplayName (const std::string &displayName)
 
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 ()
 

Protected Types

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

Protected Member Functions

 WaterUseEquipmentDefinition (std::shared_ptr< detail::WaterUseEquipmentDefinition_Impl > impl)
 
- Protected Member Functions inherited from openstudio::model::SpaceLoadDefinition
 SpaceLoadDefinition (IddObjectType type, const Model &model)
 Constructs a new SpaceLoadDefinition object in the model. More...
 
- Protected Member Functions inherited from openstudio::model::ResourceObject
 ResourceObject (IddObjectType type, const Model &model)
 Constructs a new PlanarSurface object in the model. More...
 
- Protected Member Functions inherited from openstudio::model::ParentObject
 ParentObject (IddObjectType type, const Model &model)
 Constructs a new ParentObject object in the model. More...
 
- 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)
 

Additional Inherited Members

Detailed Description

WaterUseEquipmentDefinition is a SpaceLoadDefinition that wraps the OpenStudio IDD object 'OS:WaterUse:Equipment:Definition'.

Member Typedef Documentation

typedef detail::WaterUseEquipmentDefinition_Impl openstudio::model::WaterUseEquipmentDefinition::ImplType
protected

Constructor & Destructor Documentation

openstudio::model::WaterUseEquipmentDefinition::WaterUseEquipmentDefinition ( const Model model)
explicit
virtual openstudio::model::WaterUseEquipmentDefinition::~WaterUseEquipmentDefinition ( )
inlinevirtual
openstudio::model::WaterUseEquipmentDefinition::WaterUseEquipmentDefinition ( std::shared_ptr< detail::WaterUseEquipmentDefinition_Impl >  impl)
explicitprotected

Member Function Documentation

std::string openstudio::model::WaterUseEquipmentDefinition::endUseSubcategory ( ) const
static IddObjectType openstudio::model::WaterUseEquipmentDefinition::iddObjectType ( )
static
bool openstudio::model::WaterUseEquipmentDefinition::isEndUseSubcategoryDefaulted ( ) const
boost::optional<Schedule> openstudio::model::WaterUseEquipmentDefinition::latentFractionSchedule ( ) const
double openstudio::model::WaterUseEquipmentDefinition::peakFlowRate ( ) const
void openstudio::model::WaterUseEquipmentDefinition::resetEndUseSubcategory ( )
void openstudio::model::WaterUseEquipmentDefinition::resetLatentFractionSchedule ( )
void openstudio::model::WaterUseEquipmentDefinition::resetSensibleFractionSchedule ( )
void openstudio::model::WaterUseEquipmentDefinition::resetTargetTemperatureSchedule ( )
boost::optional<Schedule> openstudio::model::WaterUseEquipmentDefinition::sensibleFractionSchedule ( ) const
bool openstudio::model::WaterUseEquipmentDefinition::setEndUseSubcategory ( const std::string &  endUseSubcategory)
bool openstudio::model::WaterUseEquipmentDefinition::setLatentFractionSchedule ( const Schedule latentFractionSchedule)
bool openstudio::model::WaterUseEquipmentDefinition::setPeakFlowRate ( double  peakFlowRate)
bool openstudio::model::WaterUseEquipmentDefinition::setSensibleFractionSchedule ( const Schedule sensibleFractionSchedule)
bool openstudio::model::WaterUseEquipmentDefinition::setTargetTemperatureSchedule ( const Schedule targetTemperatureSchedule)
boost::optional<Schedule> openstudio::model::WaterUseEquipmentDefinition::targetTemperatureSchedule ( ) const