openstudio::model::WaterHeaterSizing Class Reference

#include <WaterHeaterSizing.hpp>

Inheritance diagram for openstudio::model::WaterHeaterSizing:

Public Member Functions
Constructors and Destructors
virtual	~WaterHeaterSizing ()=default
	WaterHeaterSizing (const WaterHeaterSizing &other)=default
	WaterHeaterSizing (WaterHeaterSizing &&other)=default
WaterHeaterSizing &	operator= (const WaterHeaterSizing &)=default
WaterHeaterSizing &	operator= (WaterHeaterSizing &&)=default
Getters
WaterToWaterComponent	waterHeater () const
boost::optional< std::string >	designMode () const
boost::optional< double >	timeStorageCanMeetPeakDraw () const
boost::optional< double >	timeforTankRecovery () const
boost::optional< double >	nominalTankVolumeforAutosizingPlantConnections () const
boost::optional< int >	numberofBedrooms () const
boost::optional< int >	numberofBathrooms () const
boost::optional< double >	storageCapacityperPerson () const
boost::optional< double >	recoveryCapacityperPerson () const
boost::optional< double >	storageCapacityperFloorArea () const
boost::optional< double >	recoveryCapacityperFloorArea () const
boost::optional< double >	numberofUnits () const
boost::optional< double >	storageCapacityperUnit () const
boost::optional< double >	recoveryCapacityPerUnit () const
boost::optional< double >	storageCapacityperCollectorArea () const
boost::optional< double >	heightAspectRatio () const
Setters
bool	setDesignMode (const std::string &designMode)
void	resetDesignMode ()
bool	setTimeStorageCanMeetPeakDraw (double timeStorageCanMeetPeakDraw)
void	resetTimeStorageCanMeetPeakDraw ()
bool	setTimeforTankRecovery (double timeforTankRecovery)
void	resetTimeforTankRecovery ()
bool	setNominalTankVolumeforAutosizingPlantConnections (double nominalTankVolumeforAutosizingPlantConnections)
void	resetNominalTankVolumeforAutosizingPlantConnections ()
bool	setNumberofBedrooms (int numberofBedrooms)
void	resetNumberofBedrooms ()
bool	setNumberofBathrooms (int numberofBathrooms)
void	resetNumberofBathrooms ()
bool	setStorageCapacityperPerson (double storageCapacityperPerson)
void	resetStorageCapacityperPerson ()
bool	setRecoveryCapacityperPerson (double recoveryCapacityperPerson)
void	resetRecoveryCapacityperPerson ()
bool	setStorageCapacityperFloorArea (double storageCapacityperFloorArea)
void	resetStorageCapacityperFloorArea ()
bool	setRecoveryCapacityperFloorArea (double recoveryCapacityperFloorArea)
void	resetRecoveryCapacityperFloorArea ()
bool	setNumberofUnits (double numberofUnits)
void	resetNumberofUnits ()
bool	setStorageCapacityperUnit (double storageCapacityperUnit)
void	resetStorageCapacityperUnit ()
bool	setRecoveryCapacityPerUnit (double recoveryCapacityPerUnit)
void	resetRecoveryCapacityPerUnit ()
bool	setStorageCapacityperCollectorArea (double storageCapacityperCollectorArea)
void	resetStorageCapacityperCollectorArea ()
bool	setHeightAspectRatio (double heightAspectRatio)
void	resetHeightAspectRatio ()
Public Member Functions inherited from openstudio::model::ModelObject
virtual	~ModelObject ()=default
	ModelObject (const ModelObject &other)=default
	ModelObject (ModelObject &&other)=default
ModelObject &	operator= (const ModelObject &)=default
ModelObject &	operator= (ModelObject &&)=default
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< ParentObject >	parent () const
	Return this object's parent in the hierarchy, if it has one. More...
std::vector< ResourceObject >	resources () 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< OutputVariable >	outputVariables () 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< LifeCycleCost >	lifeCycleCosts () 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< ScheduleTypeKey >	getScheduleTypeKeys (const Schedule &schedule) const
	Return the ScheduleTypeKeys indicating how schedule is used in this object. More...
boost::optional< double >	getAutosizedValue (const std::string &valueName, const std::string &units) 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< ModelObject >	connectedObject (unsigned port) const
boost::optional< unsigned >	connectedObjectPort (unsigned port) const

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

Related Functions
(Note that these are not member functions.)
using	OptionalWaterHeaterSizing = boost::optional< WaterHeaterSizing >
using	WaterHeaterSizingVector = std::vector< WaterHeaterSizing >
Related Functions inherited from openstudio::model::ModelObject
std::vector< ResourceObject >	getRecursiveResources (const ModelObject &object)
	Returns all ResourceObjects accessible by recursively calling .resources() starting from object. More...

Additional Inherited Members
Protected Types inherited from openstudio::model::ModelObject
using	ImplType = detail::ModelObject_Impl
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

WaterHeaterSizing is a ModelObject that wraps the OpenStudio IDD object 'OS:WaterHeater:Sizing'.

Constructor & Destructor Documentation

virtual openstudio::model::WaterHeaterSizing::~WaterHeaterSizing ( )

virtualdefault

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

default

openstudio::model::WaterHeaterSizing::WaterHeaterSizing ( WaterHeaterSizing &&  other )

default

Member Function Documentation

boost::optional<std::string> openstudio::model::WaterHeaterSizing::designMode

(

)

const

static std::vector<std::string> openstudio::model::WaterHeaterSizing::designModeValues ( )

static

boost::optional<double> openstudio::model::WaterHeaterSizing::heightAspectRatio

(

)

const

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

static

boost::optional<double> openstudio::model::WaterHeaterSizing::nominalTankVolumeforAutosizingPlantConnections

(

)

const

boost::optional<int> openstudio::model::WaterHeaterSizing::numberofBathrooms

(

)

const

boost::optional<int> openstudio::model::WaterHeaterSizing::numberofBedrooms

(

)

const

boost::optional<double> openstudio::model::WaterHeaterSizing::numberofUnits

(

)

const

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

default

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

default

boost::optional<double> openstudio::model::WaterHeaterSizing::recoveryCapacityperFloorArea

(

)

const

boost::optional<double> openstudio::model::WaterHeaterSizing::recoveryCapacityperPerson

(

)

const

boost::optional<double> openstudio::model::WaterHeaterSizing::recoveryCapacityPerUnit

(

)

const

void openstudio::model::WaterHeaterSizing::resetDesignMode

(

)

void openstudio::model::WaterHeaterSizing::resetHeightAspectRatio

(

)

void openstudio::model::WaterHeaterSizing::resetNominalTankVolumeforAutosizingPlantConnections

(

)

void openstudio::model::WaterHeaterSizing::resetNumberofBathrooms

(

)

void openstudio::model::WaterHeaterSizing::resetNumberofBedrooms

(

)

void openstudio::model::WaterHeaterSizing::resetNumberofUnits

(

)

void openstudio::model::WaterHeaterSizing::resetRecoveryCapacityperFloorArea

(

)

void openstudio::model::WaterHeaterSizing::resetRecoveryCapacityperPerson

(

)

void openstudio::model::WaterHeaterSizing::resetRecoveryCapacityPerUnit

(

)

void openstudio::model::WaterHeaterSizing::resetStorageCapacityperCollectorArea

(

)

void openstudio::model::WaterHeaterSizing::resetStorageCapacityperFloorArea

(

)

void openstudio::model::WaterHeaterSizing::resetStorageCapacityperPerson

(

)

void openstudio::model::WaterHeaterSizing::resetStorageCapacityperUnit

(

)

void openstudio::model::WaterHeaterSizing::resetTimeforTankRecovery

(

)

void openstudio::model::WaterHeaterSizing::resetTimeStorageCanMeetPeakDraw

(

)

bool openstudio::model::WaterHeaterSizing::setDesignMode

(

const std::string &

designMode

)

bool openstudio::model::WaterHeaterSizing::setHeightAspectRatio

(

double

heightAspectRatio

)

bool openstudio::model::WaterHeaterSizing::setNominalTankVolumeforAutosizingPlantConnections

(

double

nominalTankVolumeforAutosizingPlantConnections

)

bool openstudio::model::WaterHeaterSizing::setNumberofBathrooms

(

int

numberofBathrooms

)

bool openstudio::model::WaterHeaterSizing::setNumberofBedrooms

(

int

numberofBedrooms

)

bool openstudio::model::WaterHeaterSizing::setNumberofUnits

(

double

numberofUnits

)

bool openstudio::model::WaterHeaterSizing::setRecoveryCapacityperFloorArea

(

double

recoveryCapacityperFloorArea

)

bool openstudio::model::WaterHeaterSizing::setRecoveryCapacityperPerson

(

double

recoveryCapacityperPerson

)

bool openstudio::model::WaterHeaterSizing::setRecoveryCapacityPerUnit

(

double

recoveryCapacityPerUnit

)

bool openstudio::model::WaterHeaterSizing::setStorageCapacityperCollectorArea

(

double

storageCapacityperCollectorArea

)

bool openstudio::model::WaterHeaterSizing::setStorageCapacityperFloorArea

(

double

storageCapacityperFloorArea

)

bool openstudio::model::WaterHeaterSizing::setStorageCapacityperPerson

(

double

storageCapacityperPerson

)

bool openstudio::model::WaterHeaterSizing::setStorageCapacityperUnit

(

double

storageCapacityperUnit

)

bool openstudio::model::WaterHeaterSizing::setTimeforTankRecovery

(

double

timeforTankRecovery

)

bool openstudio::model::WaterHeaterSizing::setTimeStorageCanMeetPeakDraw

(

double

timeStorageCanMeetPeakDraw

)

boost::optional<double> openstudio::model::WaterHeaterSizing::storageCapacityperCollectorArea

(

)

const

boost::optional<double> openstudio::model::WaterHeaterSizing::storageCapacityperFloorArea

(

)

const

boost::optional<double> openstudio::model::WaterHeaterSizing::storageCapacityperPerson

(

)

const

boost::optional<double> openstudio::model::WaterHeaterSizing::storageCapacityperUnit

(

)

const

boost::optional<double> openstudio::model::WaterHeaterSizing::timeforTankRecovery

(

)

const

boost::optional<double> openstudio::model::WaterHeaterSizing::timeStorageCanMeetPeakDraw

(

)

const

WaterToWaterComponent openstudio::model::WaterHeaterSizing::waterHeater

(

)

const

Friends And Related Function Documentation

using OptionalWaterHeaterSizing = boost::optional<WaterHeaterSizing>

related

using WaterHeaterSizingVector = std::vector<WaterHeaterSizing>

related