WaterToWaterComponent Class Reference

#include "WaterToWaterComponent.hpp"

Inheritance diagram for openstudio::model::WaterToWaterComponent:

Public Member Functions
virtual bool	addToNode (Node &node)
virtual bool	addToTertiaryNode (Node &node)
virtual ModelObject	clone (Model model) const
virtual boost::optional < ModelObject >	demandInletModelObject () const
virtual unsigned	demandInletPort () const
virtual boost::optional < ModelObject >	demandOutletModelObject () const
virtual unsigned	demandOutletPort () const
void	disconnect ()
WaterToWaterComponent &	operator= (const WaterToWaterComponent &)=default
WaterToWaterComponent &	operator= (WaterToWaterComponent &&)=default
boost::optional< PlantLoop >	plantLoop () const
virtual std::vector < openstudio::IdfObject >	remove ()
bool	removeFromPlantLoop ()
bool	removeFromSecondaryPlantLoop ()
bool	removeFromTertiaryPlantLoop ()
boost::optional< PlantLoop >	secondaryPlantLoop () const
virtual boost::optional < ModelObject >	supplyInletModelObject () const
virtual unsigned	supplyInletPort () const
virtual boost::optional < ModelObject >	supplyOutletModelObject () const
virtual unsigned	supplyOutletPort () const
boost::optional< ModelObject >	tertiaryInletModelObject () const
boost::optional< ModelObject >	tertiaryOutletModelObject () const
boost::optional< PlantLoop >	tertiaryPlantLoop () const
	WaterToWaterComponent (IddObjectType type, const Model &model)
	WaterToWaterComponent (const WaterToWaterComponent &other)=default
	WaterToWaterComponent (WaterToWaterComponent &&other)=default
virtual	~WaterToWaterComponent ()=default

Detailed Description

WaterToWaterComponent is the base class for HVACComponent objects which interact with two water loops.

A WaterToWaterComponent has two inlet nodes and two outlet ports. One pair of inlet/outlet ports is designated as the supply side and the other pair is designated as the demand side.

Constructor & Destructor Documentation

openstudio::model::WaterToWaterComponent::WaterToWaterComponent	(	IddObjectType	type,
		const Model &	model
	)

virtual openstudio::model::WaterToWaterComponent::~WaterToWaterComponent ( )

virtualdefault

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

default

openstudio::model::WaterToWaterComponent::WaterToWaterComponent ( WaterToWaterComponent &&  other )

default

Member Function Documentation

virtual bool openstudio::model::WaterToWaterComponent::addToNode ( Node &  node )

virtual

virtual bool openstudio::model::WaterToWaterComponent::addToTertiaryNode ( Node &  node )

virtual

Add this WaterToWaterComponent to a tertiaryPlantLoop by making connections to the tertiary inlet and outlet.

virtual ModelObject openstudio::model::WaterToWaterComponent::clone ( Model  model ) const

virtual

virtual boost::optional<ModelObject> openstudio::model::WaterToWaterComponent::demandInletModelObject ( ) const

virtual

Returns the optional ModelObject connected to the demand inlet port.

virtual unsigned openstudio::model::WaterToWaterComponent::demandInletPort ( ) const

virtual

Returns the demand inlet port.

virtual boost::optional<ModelObject> openstudio::model::WaterToWaterComponent::demandOutletModelObject ( ) const

virtual

Returns the optional ModelObject connected to the demand outlet port.

virtual unsigned openstudio::model::WaterToWaterComponent::demandOutletPort ( ) const

virtual

Returns the demand outlet port.

void openstudio::model::WaterToWaterComponent::disconnect

(

)

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

default

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

default

boost::optional<PlantLoop> openstudio::model::WaterToWaterComponent::plantLoop

(

)

const

Returns the optional PlantLoop object that the HVAC component is a supply component on.

virtual std::vector<openstudio::IdfObject> openstudio::model::WaterToWaterComponent::remove ( )

virtual

bool openstudio::model::WaterToWaterComponent::removeFromPlantLoop

(

)

Removes the component from the plantLoop if one is attached.

Repairs the plantLoop connections preserving the integrity of the loop.

bool openstudio::model::WaterToWaterComponent::removeFromSecondaryPlantLoop

(

)

Removes the component from the secondaryPlantLoop if one is attached.

Repairs the secondaryPlantLoop connections preserving the integrity of the loop.

bool openstudio::model::WaterToWaterComponent::removeFromTertiaryPlantLoop

(

)

Removes the component from the tertiaryPlantLoop if one is attached.

Repairs the tertiaryPlantLoop connections preserving the integrity of the loop.

boost::optional<PlantLoop> openstudio::model::WaterToWaterComponent::secondaryPlantLoop

(

)

const

Returns the optional PlantLoop object that the HVAC component is a demand component on.

virtual boost::optional<ModelObject> openstudio::model::WaterToWaterComponent::supplyInletModelObject ( ) const

virtual

Returns the optional ModelObject connected to the supply inlet port.

virtual unsigned openstudio::model::WaterToWaterComponent::supplyInletPort ( ) const

virtual

Returns the supply inlet port.

virtual boost::optional<ModelObject> openstudio::model::WaterToWaterComponent::supplyOutletModelObject ( ) const

virtual

Returns the optional ModelObject connected to the supply outlet port.

virtual unsigned openstudio::model::WaterToWaterComponent::supplyOutletPort ( ) const

virtual

Returns the supply outlet port.

boost::optional<ModelObject> openstudio::model::WaterToWaterComponent::tertiaryInletModelObject

(

)

const

Returns the optional ModelObject connected to the tertiary inlet.

boost::optional<ModelObject> openstudio::model::WaterToWaterComponent::tertiaryOutletModelObject

(

)

const

Returns the optional ModelObject connected to the tertiary outlet.

boost::optional<PlantLoop> openstudio::model::WaterToWaterComponent::tertiaryPlantLoop

(

)

const

Tertiary plant loop applies to a limited number of WaterToWaterComponent types that interact with three plant systems.

One example is a water cooled chiller with heat recovery, which can be connected to a chilled water, condenser, and heat recovery plant simultaneously.