OpenStudio:model
 AllClasses Namespaces Functions Variables Typedefs Enumerations Enumerator Pages

#include "ConnectorSplitter.hpp"

Inheritance diagram for openstudio::model::ConnectorSplitter:

Public Member Functions

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

Static Public Member Functions

static IddObjectType iddObjectType ()

Protected Types

typedef
detail::ConnectorSplitter_Impl 
ImplType

Protected Member Functions

 ConnectorSplitter (std::shared_ptr< detail::ConnectorSplitter_Impl > impl)

Related Functions

typedef boost::optional
< ConnectorSplitter
OptionalConnectorSplitter

Detailed Description

ConnectorSplitter is an interface to the EnergyPlus IDD object named "OS:Connector:Splitter".

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

Member Typedef Documentation

typedef detail::ConnectorSplitter_Impl openstudio::model::ConnectorSplitter::ImplType
protected

Constructor & Destructor Documentation

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

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

virtual openstudio::model::ConnectorSplitter::~ConnectorSplitter ( )
inlinevirtual
openstudio::model::ConnectorSplitter::ConnectorSplitter ( std::shared_ptr< detail::ConnectorSplitter_Impl >  impl)
explicitprotected

Member Function Documentation

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

Returns the inlet port to the splitter.

Reimplemented from openstudio::model::Splitter.

unsigned openstudio::model::ConnectorSplitter::nextOutletPort ( ) const
overridevirtual

Returns the next available outlet port.

This will be the first port with no connected objects

Reimplemented from openstudio::model::Splitter.

unsigned openstudio::model::ConnectorSplitter::outletPort ( unsigned  branchIndex) const
overridevirtual

Returns the outlet port for branchIndex.

Branches consequtively indexed starting from 0.

Reimplemented from openstudio::model::Splitter.

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

Friends And Related Function Documentation

typedef boost::optional<ConnectorSplitter> OptionalConnectorSplitter
related