WaterToAirComponent Class Reference

#include "WaterToAirComponent.hpp"

Inheritance diagram for openstudio::model::WaterToAirComponent:

Public Member Functions
virtual bool	addToNode (Node &node)
virtual bool	addToSplitter (Splitter &splitter)
virtual boost::optional < ModelObject >	airInletModelObject ()
virtual unsigned	airInletPort ()
virtual boost::optional < AirLoopHVAC >	airLoopHVAC () const
virtual boost::optional < ModelObject >	airOutletModelObject ()
virtual unsigned	airOutletPort ()
virtual ModelObject	clone (Model model) const
void	disconnectAirSide ()
void	disconnectWaterSide ()
virtual boost::optional < PlantLoop >	plantLoop () const
virtual std::vector < openstudio::IdfObject >	remove ()
bool	removeFromAirLoopHVAC ()
bool	removeFromPlantLoop ()
virtual boost::optional < ModelObject >	waterInletModelObject ()
virtual unsigned	waterInletPort ()
virtual boost::optional < ModelObject >	waterOutletModelObject ()
virtual unsigned	waterOutletPort ()
virtual	~WaterToAirComponent ()

Detailed Description

WaterToAirComponent is the base class for model objects which interact with an air stream and a water stream.

These objects are typically water coils such as the EnergyPlus IDD objects named Coil:Heating:Water and Coil:Cooling:Water.

Constructor & Destructor Documentation

virtual openstudio::model::WaterToAirComponent::~WaterToAirComponent ( )

inlinevirtual

Member Function Documentation

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

virtual

virtual bool openstudio::model::WaterToAirComponent::addToSplitter ( Splitter &  splitter )

virtual

virtual boost::optional<ModelObject> openstudio::model::WaterToAirComponent::airInletModelObject ( )

virtual

Returns the optional ModelObject connected to the air inlet port.

virtual unsigned openstudio::model::WaterToAirComponent::airInletPort ( )

virtual

Returns the air inlet port.

virtual boost::optional<AirLoopHVAC> openstudio::model::WaterToAirComponent::airLoopHVAC ( ) const

virtual

virtual boost::optional<ModelObject> openstudio::model::WaterToAirComponent::airOutletModelObject ( )

virtual

Returns the optional ModelObject connected to the air outlet port.

virtual unsigned openstudio::model::WaterToAirComponent::airOutletPort ( )

virtual

Returns the air outlet port.

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

virtual

void openstudio::model::WaterToAirComponent::disconnectAirSide

(

)

void openstudio::model::WaterToAirComponent::disconnectWaterSide

(

)

virtual boost::optional<PlantLoop> openstudio::model::WaterToAirComponent::plantLoop ( ) const

virtual

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

virtual

bool openstudio::model::WaterToAirComponent::removeFromAirLoopHVAC

(

)

Removes the component from the airLoopHVAC if one is attached.

Repairs the airLoopHVAC connections preserving the integrity of the loop. Does not remove the component from the model

bool openstudio::model::WaterToAirComponent::removeFromPlantLoop

(

)

Removes the component from the plantLoop if one is attached.

Repairs the plantLoop connections preserving the integrity of the loop. Does not remove the component from the model

virtual boost::optional<ModelObject> openstudio::model::WaterToAirComponent::waterInletModelObject ( )

virtual

Returns the optional ModelObject connected to the water inlet port.

virtual unsigned openstudio::model::WaterToAirComponent::waterInletPort ( )

virtual

Returns the water inlet port.

virtual boost::optional<ModelObject> openstudio::model::WaterToAirComponent::waterOutletModelObject ( )

virtual

Returns the optional ModelObject connected to the water outlet port.

virtual unsigned openstudio::model::WaterToAirComponent::waterOutletPort ( )

virtual

Returns the water outlet port.