OpenStudioCore:model
 AllClasses Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages

#include "ConnectorMixer.hpp"

Inheritance diagram for openstudio::model::ConnectorMixer:

Public Member Functions

virtual bool addToNode (Node &node)
virtual ModelObject clone (Model model) const
 ConnectorMixer (const Model &model)
unsigned inletPort (unsigned branchIndex) const override
unsigned nextInletPort () const override
unsigned outletPort () const override
virtual std::vector
< openstudio::IdfObject
remove ()
virtual ~ConnectorMixer ()

Static Public Member Functions

static IddObjectType iddObjectType ()

Protected Types

typedef detail::ConnectorMixer_Impl ImplType

Protected Member Functions

 ConnectorMixer (std::shared_ptr< detail::ConnectorMixer_Impl > impl)

Related Functions

typedef boost::optional
< ConnectorMixer
OptionalConnectorMixer

Detailed Description

Mixer is an interface to the IDD object named "OS:Connector:Mixer".

The purpose of this class is to simplify the construction and manipulation of mixer objects in EnergyPlus. Methods are built around the acts of getting the inlet and outlet ports to the mixer. Branch indexes are used to refer to the many inlet ports of the mixer

Member Typedef Documentation

typedef detail::ConnectorMixer_Impl openstudio::model::ConnectorMixer::ImplType
protected

Constructor & Destructor Documentation

openstudio::model::ConnectorMixer::ConnectorMixer ( const Model model)
explicit

Constructs a new Mixer object and places it inside the model.

virtual openstudio::model::ConnectorMixer::~ConnectorMixer ( )
inlinevirtual
openstudio::model::ConnectorMixer::ConnectorMixer ( std::shared_ptr< detail::ConnectorMixer_Impl >  impl)
explicitprotected

Member Function Documentation

virtual bool openstudio::model::ConnectorMixer::addToNode ( Node node)
virtual
virtual ModelObject openstudio::model::ConnectorMixer::clone ( Model  model) const
virtual
static IddObjectType openstudio::model::ConnectorMixer::iddObjectType ( )
static
unsigned openstudio::model::ConnectorMixer::inletPort ( unsigned  branchIndex) const
overridevirtual

Returns the inlet port for branchIndex.

Branches consequtively indexed starting from 0.

Reimplemented from openstudio::model::Mixer.

unsigned openstudio::model::ConnectorMixer::nextInletPort ( ) const
overridevirtual

Returns the next available inlet port.

This will be the first port with no connected objects

Reimplemented from openstudio::model::Mixer.

unsigned openstudio::model::ConnectorMixer::outletPort ( ) const
overridevirtual

Returns the outlet port to the zone mixer.

Reimplemented from openstudio::model::Mixer.

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

Friends And Related Function Documentation

typedef boost::optional<ConnectorMixer> OptionalConnectorMixer
related