Mixer Class Reference

#include "Mixer.hpp"

Inheritance diagram for openstudio::model::Mixer:

Public Member Functions
virtual unsigned	branchIndexForInletModelObject (ModelObject modelObject) const
virtual boost::optional < ModelObject >	inletModelObject (unsigned branchIndex) const
virtual std::vector< ModelObject >	inletModelObjects () const
virtual unsigned	inletPort (unsigned branchIndex) const
bool	isRemovable () const
virtual boost::optional < ModelObject >	lastInletModelObject () const
virtual unsigned	newInletPortAfterBranch (unsigned branchIndex)
virtual unsigned	nextBranchIndex () const
virtual unsigned	nextInletPort () const
virtual boost::optional < ModelObject >	outletModelObject () const
virtual unsigned	outletPort () const
virtual void	removePortForBranch (unsigned branchIndex)
virtual	~Mixer ()

Protected Types
typedef detail::Mixer_Impl	ImplType

Protected Member Functions
	Mixer (IddObjectType type, const Model &model)
	Mixer (std::shared_ptr< ImplType > impl)

Member Typedef Documentation

typedef detail::Mixer_Impl openstudio::model::Mixer::ImplType

protected

Constructor & Destructor Documentation

virtual openstudio::model::Mixer::~Mixer ( )

inlinevirtual

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

protected

openstudio::model::Mixer::Mixer ( std::shared_ptr< ImplType >  impl )

explicitprotected

Member Function Documentation

virtual unsigned openstudio::model::Mixer::branchIndexForInletModelObject ( ModelObject  modelObject ) const

virtual

Returns the branch index for the ModelObject specified by modelObject.

The specified object must be connected to an inlet port of the mixer.

virtual boost::optional<ModelObject> openstudio::model::Mixer::inletModelObject ( unsigned  branchIndex ) const

virtual

Returns the optional ModelObject connected to the branch designated by branchIndex.

If there is no connected object then the optional will be false.

virtual std::vector<ModelObject> openstudio::model::Mixer::inletModelObjects ( ) const

virtual

Returns a vector of all objects connected to the mixer's inlet ports.

If no objects are connected to the mixer then an empty vector will be returned.

virtual unsigned openstudio::model::Mixer::inletPort ( unsigned  branchIndex ) const

virtual

Returns the inlet port for branchIndex.

Branches consequtively indexed starting from 0.

Reimplemented in openstudio::model::AirLoopHVACReturnPlenum, openstudio::model::AirLoopHVACZoneMixer, and openstudio::model::ConnectorMixer.

bool openstudio::model::Mixer::isRemovable

(

)

const

virtual boost::optional<ModelObject> openstudio::model::Mixer::lastInletModelObject ( ) const

virtual

Returns the optional ModelObject connected to the last branch of the mixer.

If there are no connections to the mixer's inlet ports, then the optional will be false.

virtual unsigned openstudio::model::Mixer::newInletPortAfterBranch ( unsigned  branchIndex )

virtual

Returns a new port after the branch specified by branchIndex.

virtual unsigned openstudio::model::Mixer::nextBranchIndex ( ) const

virtual

Returns the index of the next available branch.

virtual unsigned openstudio::model::Mixer::nextInletPort ( ) const

virtual

Returns the next available inlet port.

This will be the first port with no connected objects

Reimplemented in openstudio::model::AirLoopHVACReturnPlenum, openstudio::model::AirLoopHVACZoneMixer, and openstudio::model::ConnectorMixer.

virtual boost::optional<ModelObject> openstudio::model::Mixer::outletModelObject ( ) const

virtual

Returns the optional ModelObject connected to the outlet port.

If there is no connected object then the optional will be false.

virtual unsigned openstudio::model::Mixer::outletPort ( ) const

virtual

Returns the outlet port to the zone mixer.

Reimplemented in openstudio::model::AirLoopHVACReturnPlenum, openstudio::model::AirLoopHVACZoneMixer, and openstudio::model::ConnectorMixer.

virtual void openstudio::model::Mixer::removePortForBranch ( unsigned  branchIndex )

virtual

Effectively disconnects anything connected to the inlet port at the specified branch index.

All branches after the specified branch index are moved to the next lower branch index, thereby removing any unconnected ports between branches.