openstudio::model::WaterUseEquipmentDefinition Class Reference

#include <WaterUseEquipmentDefinition.hpp>

Inheritance diagram for openstudio::model::WaterUseEquipmentDefinition:

Public Member Functions
std::string	endUseSubcategory () const
Quantity	getPeakFlowRate (bool returnIP=false) const
bool	isEndUseSubcategoryDefaulted () const
boost::optional< Schedule >	latentFractionSchedule () const
double	peakFlowRate () const
void	resetEndUseSubcategory ()
void	resetLatentFractionSchedule ()
void	resetSensibleFractionSchedule ()
void	resetTargetTemperatureSchedule ()
boost::optional< Schedule >	sensibleFractionSchedule () const
bool	setEndUseSubcategory (std::string endUseSubcategory)
bool	setLatentFractionSchedule (const Schedule &latentFractionSchedule)
bool	setPeakFlowRate (double peakFlowRate)
bool	setPeakFlowRate (const Quantity &peakFlowRate)
bool	setSensibleFractionSchedule (const Schedule &sensibleFractionSchedule)
bool	setTargetTemperatureSchedule (const Schedule &targetTemperatureSchedule)
boost::optional< Schedule >	targetTemperatureSchedule () 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< SpaceLoadInstance >	instances () 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< ModelObject >	children () 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< 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...
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< ModelObject >	connectedObject (unsigned port) const
boost::optional< unsigned >	connectedObjectPort (unsigned port) const
Public Member Functions inherited from openstudio::WorkspaceObject
bool	canBeSource () const
bool	canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const
std::vector< std::string >	canBeTarget () const
std::vector< unsigned >	getSourceIndices (const Handle &targetHandle) const
std::vector< WorkspaceObject >	getSources (IddObjectType type) const
boost::optional< WorkspaceObject >	getTarget (unsigned index) const
IdfObject	idfObject ()
IdfObject	idfObject () const
bool	initialized () const
bool	isSource () const
bool	isTarget () const
unsigned	numSources () const
bool	objectListFieldsEqual (const WorkspaceObject &other) const
bool	objectListFieldsNonConflicting (const WorkspaceObject &other) const
bool	operator< (const WorkspaceObject &right) const
std::ostream &	operator<< (std::ostream &os, const WorkspaceObject &workspaceObject)
std::vector < openstudio::IdfObject >	remove ()
bool	setPointer (unsigned index, const Handle &targetHandle)
std::vector< WorkspaceObject >	sources () const
std::vector< WorkspaceObject >	targets () const
Workspace	workspace () const
virtual	~WorkspaceObject ()
Public Member Functions inherited from openstudio::IdfObject
std::string	briefDescription () const
T	cast () const
std::vector< T >	castVector (const std::vector< U > &objects)
std::vector< std::vector < std::string > >	clearExtensibleGroups ()
IdfObject	clone (bool keepHandle=false) const
std::string	comment () const
boost::optional< std::string >	createName (bool overwrite=true)
std::vector< unsigned >	dataFields () const
bool	dataFieldsEqual (const IdfObject &other) const
std::vector< std::string >	eraseExtensibleGroup (unsigned groupIndex)
std::vector< IdfExtensibleGroup >	extensibleGroups () const
boost::optional< std::string >	fieldComment (unsigned index, bool returnDefault=false) const
boost::optional< double >	getDouble (unsigned index, bool returnDefault=false) const
IdfExtensibleGroup	getExtensibleGroup (unsigned groupIndex) const
std::vector< Handle >	getHandles (const std::vector< T > &objects)
boost::optional< int >	getInt (unsigned index, bool returnDefault=false) const
OSOptionalQuantity	getQuantity (unsigned index, bool returnDefault=false, bool returnIP=false) const
boost::optional< std::string >	getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const
boost::optional< unsigned >	getUnsigned (unsigned index, bool returnDefault=false) const
boost::optional< QUrl >	getURL (unsigned index, bool returnDefault=false) const
Handle	handle () const
IddObject	iddObject () const
	IdfObject (IddObjectType type, bool fastName=false)
	IdfObject (const IddObject &, bool fastName=false)
	IdfObject (const IdfObject &other)
IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex)
IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)
bool	isDataField (unsigned index) const
bool	isEmpty (unsigned index) const
bool	isObjectListField (unsigned index) const
bool	isValid (StrictnessLevel level, bool checkNames=false) const
boost::optional< unsigned >	maxExtensibleGroups () const
boost::optional< unsigned >	maxFields () const
unsigned	minExtensibleGroups () const
unsigned	minFields () const
boost::optional< std::string >	name (bool returnDefault=false) const
std::string	nameString (bool returnDefault=false) const
unsigned	numExtensibleGroups () const
unsigned	numFields () const
unsigned	numNonextensibleFields () const
std::vector< unsigned >	objectListFields () const
bool	objectListFieldsEqual (const IdfObject &other) const
bool	objectListFieldsNonConflicting (const IdfObject &other) const
bool	operator!= (const IdfObject &other) const
std::ostream &	operator<< (std::ostream &os, const IdfObject &IdfObject)
bool	operator== (const IdfObject &other) const
boost::optional< T >	optionalCast () const
std::vector< std::string >	popExtensibleGroup ()
std::ostream &	print (std::ostream &os) const
std::ostream &	printField (std::ostream &os, unsigned index, bool isLastField=false) const
std::ostream &	printName (std::ostream &os, bool hasFields=true) const
IdfExtensibleGroup	pushExtensibleGroup ()
IdfExtensibleGroup	pushExtensibleGroup (const std::vector< std::string > &values)
std::vector< unsigned >	requiredFields () const
void	setComment (const std::string &msg)
bool	setDouble (unsigned index, double value)
bool	setFieldComment (unsigned index, const std::string &cmnt)
bool	setInt (unsigned index, int value)
boost::optional< std::string >	setName (const std::string &newName)
bool	setQuantity (unsigned index, const Quantity &q)
bool	setString (unsigned index, const std::string &value)
bool	setUnsigned (unsigned index, unsigned value)
std::vector< T >	subsetCastVector (const std::vector< U > &original)
ValidityReport	validityReport (StrictnessLevel level, bool checkNames=false) const
virtual	~IdfObject ()

Static Public Member Functions
static IddObjectType	iddObjectType ()
Static Public Member Functions inherited from openstudio::IdfObject
static boost::optional< IdfObject >	load (const std::string &text)
static boost::optional< IdfObject >	load (const std::string &text, const IddObject &iddObject)
static int	printedFieldSpace ()

Protected Types
typedef detail::WaterUseEquipmentDefinition_Impl	ImplType
Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl	ImplType
Protected Types inherited from openstudio::WorkspaceObject
typedef detail::WorkspaceObject_Impl	ImplType
Protected Types inherited from openstudio::IdfObject
typedef detail::IdfObject_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)
Protected Member Functions inherited from openstudio::WorkspaceObject
	WorkspaceObject (std::shared_ptr< detail::WorkspaceObject_Impl > impl)
Protected Member Functions inherited from openstudio::IdfObject
	IdfObject (std::shared_ptr< detail::IdfObject_Impl > impl)

Additional Inherited Members
Public Types inherited from openstudio::WorkspaceObject
typedef boost::optional < WorkspaceObject >	OptionalWorkspaceObject
typedef std::vector < WorkspaceObject >	WorkspaceObjectVector
Public Types inherited from openstudio::IdfObject
typedef std::pair< IdfObject, IdfObject >	IdfObjectPair
typedef std::vector< IdfObject >	IdfObjectVector
typedef boost::optional < IdfObject >	OptionalIdfObject
Related Functions inherited from openstudio::model::SpaceLoadDefinition
typedef boost::optional < SpaceLoadDefinition >	OptionalSpaceLoadDefinition
typedef std::vector < SpaceLoadDefinition >	SpaceLoadDefinitionVector
Related Functions inherited from openstudio::model::ResourceObject
typedef boost::optional < ResourceObject >	OptionalResourceObject
typedef std::vector < ResourceObject >	ResourceObjectVector
Related Functions inherited from openstudio::model::ParentObject
std::vector< ModelObject >	getRecursiveChildren (const ParentObject &object, bool includeLifeCycleCosts=false)
	Returns object and all other objects accessible by calling children() on encountered ParentObjects . More...
std::vector< ModelObject >	getRecursiveChildrenAndResources (const ModelObject &object)
	Returns object and all other objects accessible by calling children() and resources() on encountered ModelObjects . More...
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...
typedef std::pair< std::string, std::string >	ScheduleTypeKey
	Typedef for ScheduleTypeRegistry key. More...

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

Quantity openstudio::model::WaterUseEquipmentDefinition::getPeakFlowRate

(

bool

returnIP = false

)

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

(

std::string

endUseSubcategory

)

bool openstudio::model::WaterUseEquipmentDefinition::setLatentFractionSchedule

(

const Schedule &

latentFractionSchedule

)

bool openstudio::model::WaterUseEquipmentDefinition::setPeakFlowRate

(

double

peakFlowRate

)

bool openstudio::model::WaterUseEquipmentDefinition::setPeakFlowRate

(

const Quantity &

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