OpenStudio:model
 AllClasses Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages

#include "HotWaterEquipment.hpp"

Inheritance diagram for openstudio::model::HotWaterEquipment:

Public Member Functions

 HotWaterEquipment (const HotWaterEquipmentDefinition &hotWaterEquipmentDefinition)
virtual ~HotWaterEquipment () override=default
 HotWaterEquipment (const HotWaterEquipment &other)=default
 HotWaterEquipment (HotWaterEquipment &&other)=default
HotWaterEquipmentoperator= (const HotWaterEquipment &)=default
HotWaterEquipmentoperator= (HotWaterEquipment &&)=default
HotWaterEquipmentDefinition hotWaterEquipmentDefinition () const
boost::optional< Scheduleschedule () const
bool isScheduleDefaulted () const
std::string endUseSubcategory () const
bool isEndUseSubcategoryDefaulted () const
bool setHotWaterEquipmentDefinition (const HotWaterEquipmentDefinition &definition)
bool setSchedule (Schedule &schedule)
void resetSchedule ()
bool setMultiplier (double multiplier)
void resetMultiplier ()
bool setEndUseSubcategory (const std::string &endUseSubcategory)
void resetEndUseSubcategory ()
double getDesignLevel (double floorArea, double numPeople) const
double getPowerPerFloorArea (double floorArea, double numPeople) const
double getPowerPerPerson (double floorArea, double numPeople) const

Static Public Member Functions

static IddObjectType iddObjectType ()

Related Functions

using HotWaterEquipmentVector = std::vector< HotWaterEquipment >
using OptionalHotWaterEquipment = boost::optional< HotWaterEquipment >

Detailed Description

HotWaterEquipment is a SpaceLoadInstance that wraps the OpenStudio IDD object 'OS:HotWaterEquipment'.

Its fields are derived from the EnergyPlus IDD object 'HotWaterEquipment'.

See also
HotWaterEquipmentDefinition

Constructor & Destructor Documentation

openstudio::model::HotWaterEquipment::HotWaterEquipment ( const HotWaterEquipmentDefinition hotWaterEquipmentDefinition)
explicit
virtual openstudio::model::HotWaterEquipment::~HotWaterEquipment ( )
overridevirtualdefault
openstudio::model::HotWaterEquipment::HotWaterEquipment ( const HotWaterEquipment other)
default
openstudio::model::HotWaterEquipment::HotWaterEquipment ( HotWaterEquipment &&  other)
default

Member Function Documentation

std::string openstudio::model::HotWaterEquipment::endUseSubcategory ( ) const
double openstudio::model::HotWaterEquipment::getDesignLevel ( double  floorArea,
double  numPeople 
) const

Returns the design level represented by this instance, assuming floorArea (m^2) and numPeople.

double openstudio::model::HotWaterEquipment::getPowerPerFloorArea ( double  floorArea,
double  numPeople 
) const

Returns the watts/m^2 represented by this instance, assuming floorArea (m^2) and numPeople.

double openstudio::model::HotWaterEquipment::getPowerPerPerson ( double  floorArea,
double  numPeople 
) const

Returns the watts/person represented by this instance, assuming floorArea (m^2) and numPeople.

HotWaterEquipmentDefinition openstudio::model::HotWaterEquipment::hotWaterEquipmentDefinition ( ) const

Gets the HotWaterEquipmentDefinition object.

static IddObjectType openstudio::model::HotWaterEquipment::iddObjectType ( )
static
bool openstudio::model::HotWaterEquipment::isEndUseSubcategoryDefaulted ( ) const
bool openstudio::model::HotWaterEquipment::isScheduleDefaulted ( ) const

Returns true if this object does not specify a schedule directly.

HotWaterEquipment& openstudio::model::HotWaterEquipment::operator= ( const HotWaterEquipment )
default
HotWaterEquipment& openstudio::model::HotWaterEquipment::operator= ( HotWaterEquipment &&  )
default
void openstudio::model::HotWaterEquipment::resetEndUseSubcategory ( )
void openstudio::model::HotWaterEquipment::resetMultiplier ( )
void openstudio::model::HotWaterEquipment::resetSchedule ( )

Resets the (fractional) Schedule.

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

Returns the (fractional) equipment schedule.

If this object does not specify a schedule this function will search the hierarchy.

bool openstudio::model::HotWaterEquipment::setEndUseSubcategory ( const std::string &  endUseSubcategory)
bool openstudio::model::HotWaterEquipment::setHotWaterEquipmentDefinition ( const HotWaterEquipmentDefinition definition)

Sets the HotWaterEquipmentDefinition object.

bool openstudio::model::HotWaterEquipment::setMultiplier ( double  multiplier)
bool openstudio::model::HotWaterEquipment::setSchedule ( Schedule schedule)

Sets the (fractional) Schedule.

Friends And Related Function Documentation

using HotWaterEquipmentVector = std::vector<HotWaterEquipment>
related
using OptionalHotWaterEquipment = boost::optional<HotWaterEquipment>
related