openstudio::model::ExteriorWaterEquipment Class Reference

#include <ExteriorWaterEquipment.hpp>

Inheritance diagram for openstudio::model::ExteriorWaterEquipment:

Public Member Functions
Constructors and Destructors
	ExteriorWaterEquipment (const ExteriorWaterEquipmentDefinition &definition)
	This constructor sets schedule to always on. More...
	ExteriorWaterEquipment (const ExteriorWaterEquipmentDefinition &definition, Schedule &schedule)
	This constructor requires a user-specified schedule. More...
virtual	~ExteriorWaterEquipment ()
Getters
ExteriorWaterEquipmentDefinition	exteriorWaterEquipmentDefinition () const
Schedule	schedule () const
double	multiplier () const
bool	isMultiplierDefaulted () const
std::string	endUseSubcategory () const
bool	isEndUseSubcategoryDefaulted () const
Setters
bool	setExteriorWaterEquipmentDefinition (const ExteriorWaterEquipmentDefinition &exteriorWaterEquipmentDefinition)
bool	setSchedule (Schedule &schedule)
void	resetSchedule ()
bool	setMultiplier (double multiplier)
void	resetMultiplier ()
bool	setEndUseSubcategory (std::string endUseSubcategory)
void	resetEndUseSubcategory ()
Other
Facility	facility () const
Public Member Functions inherited from openstudio::model::ExteriorLoadInstance
ExteriorLoadDefinition	definition () const
	Returns the definition of this instance. More...
bool	isMultiplierDefaulted () const
	Returns true if the multiplier is defaulted. More...
void	makeUnique ()
	Ensures that no other instances share this instances definition. More...
double	multiplier () const
	Gets the multiplier for this space instance, defaults to 1. More...
int	quantity () const
	Returns the number of instances this space load instance represents. More...
bool	setDefinition (const ExteriorLoadDefinition &definition)
	Sets the definition of this instance. More...
virtual	~ExteriorLoadInstance ()
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< 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 (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< ModelObject >	connectedObject (unsigned port) const
boost::optional< unsigned >	connectedObjectPort (unsigned port) const

Static Public Member Functions
static IddObjectType	iddObjectType ()

Related Functions
(Note that these are not member functions.)
typedef std::vector < ExteriorWaterEquipment >	ExteriorWaterEquipmentVector
typedef boost::optional < ExteriorWaterEquipment >	OptionalExteriorWaterEquipment
Related Functions inherited from openstudio::model::ExteriorLoadInstance
typedef std::vector < ExteriorLoadInstance >	ExteriorLoadInstanceVector
typedef boost::optional < ExteriorLoadInstance >	OptionalExteriorLoadInstance
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
typedef detail::ModelObject_Impl	ImplType
Protected Member Functions inherited from openstudio::model::ExteriorLoadInstance
	ExteriorLoadInstance (IddObjectType type, const ExteriorLoadDefinition &definition)
	Constructs a new ExteriorLoadInstance 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)

Detailed Description

ExteriorWaterEquipment is a ExteriorLoadInstance that wraps the OpenStudio IDD object 'OS:Exterior:WaterEquipment'.

ExteriorWaterEquipment is a child of Facility and instances ExteriorWaterEquipmentDefinition.

Constructor & Destructor Documentation

openstudio::model::ExteriorWaterEquipment::ExteriorWaterEquipment

(

const ExteriorWaterEquipmentDefinition &

definition

)

This constructor sets schedule to always on.

openstudio::model::ExteriorWaterEquipment::ExteriorWaterEquipment	(	const ExteriorWaterEquipmentDefinition &	definition,
		Schedule &	schedule
	)

This constructor requires a user-specified schedule.

virtual openstudio::model::ExteriorWaterEquipment::~ExteriorWaterEquipment ( )

inlinevirtual

Member Function Documentation

std::string openstudio::model::ExteriorWaterEquipment::endUseSubcategory

(

)

const

ExteriorWaterEquipmentDefinition openstudio::model::ExteriorWaterEquipment::exteriorWaterEquipmentDefinition

(

)

const

Facility openstudio::model::ExteriorWaterEquipment::facility

(

)

const

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

static

bool openstudio::model::ExteriorWaterEquipment::isEndUseSubcategoryDefaulted

(

)

const

bool openstudio::model::ExteriorWaterEquipment::isMultiplierDefaulted

(

)

const

double openstudio::model::ExteriorWaterEquipment::multiplier

(

)

const

void openstudio::model::ExteriorWaterEquipment::resetEndUseSubcategory

(

)

void openstudio::model::ExteriorWaterEquipment::resetMultiplier

(

)

void openstudio::model::ExteriorWaterEquipment::resetSchedule

(

)

Schedule openstudio::model::ExteriorWaterEquipment::schedule

(

)

const

bool openstudio::model::ExteriorWaterEquipment::setEndUseSubcategory

(

std::string

endUseSubcategory

)

bool openstudio::model::ExteriorWaterEquipment::setExteriorWaterEquipmentDefinition

(

const ExteriorWaterEquipmentDefinition &

exteriorWaterEquipmentDefinition

)

bool openstudio::model::ExteriorWaterEquipment::setMultiplier

(

double

multiplier

)

bool openstudio::model::ExteriorWaterEquipment::setSchedule

(

Schedule &

schedule

)

Friends And Related Function Documentation

typedef std::vector<ExteriorWaterEquipment> ExteriorWaterEquipmentVector

related

typedef boost::optional<ExteriorWaterEquipment> OptionalExteriorWaterEquipment

related