OpenStudio:model
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Related Functions | List of all members
openstudio::model::ConnectorMixer Class Reference

#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)
 Constructs a new Mixer object and places it inside the model. More...
 
 ConnectorMixer (const ConnectorMixer &other)=default
 
 ConnectorMixer (ConnectorMixer &&other)=default
 
unsigned inletPort (unsigned branchIndex) const override
 Returns the inlet port for branchIndex. More...
 
unsigned nextInletPort () const override
 Returns the next available inlet port. More...
 
ConnectorMixeroperator= (const ConnectorMixer &)=default
 
ConnectorMixeroperator= (ConnectorMixer &&)=default
 
unsigned outletPort () const override
 Returns the outlet port to the zone mixer. More...
 
virtual std::vector
< openstudio::IdfObject > 
remove ()
 
virtual ~ConnectorMixer ()=default
 
- Public Member Functions inherited from openstudio::model::Mixer
virtual unsigned branchIndexForInletModelObject (ModelObject modelObject) const
 Returns the branch index for the ModelObject specified by modelObject. More...
 
virtual boost::optional
< ModelObject
inletModelObject (unsigned branchIndex) const
 Returns the optional ModelObject connected to the branch designated by branchIndex. More...
 
virtual std::vector< ModelObjectinletModelObjects () const
 Returns a vector of all objects connected to the mixer's inlet ports. More...
 
bool isRemovable () const
 
virtual boost::optional
< ModelObject
lastInletModelObject () const
 Returns the optional ModelObject connected to the last branch of the mixer. More...
 
 Mixer (const Mixer &other)=default
 
 Mixer (Mixer &&other)=default
 
virtual unsigned newInletPortAfterBranch (unsigned branchIndex)
 Returns a new port after the branch specified by branchIndex. More...
 
virtual unsigned nextBranchIndex () const
 Returns the index of the next available branch. More...
 
Mixeroperator= (const Mixer &)=default
 
Mixeroperator= (Mixer &&)=default
 
virtual boost::optional
< ModelObject
outletModelObject () const
 Returns the optional ModelObject connected to the outlet port. More...
 
virtual void removePortForBranch (unsigned branchIndex)
 Effectively disconnects anything connected to the inlet port at the specified branch index. More...
 
virtual ~Mixer ()=default
 
- Public Member Functions inherited from openstudio::model::HVACComponent
bool addToNode (Node &node)
 Adds this object to a new system node and returns a boolean indicating if the addition was successful. More...
 
bool addToSplitter (Splitter &splitter)
 Adds this object to a splitter by creating a new branch. More...
 
boost::optional< AirLoopHVACairLoopHVAC () const
 Returns the optional AirLoopHVAC object that the HVAC component is attached to. More...
 
boost::optional
< AirLoopHVACOutdoorAirSystem
airLoopHVACOutdoorAirSystem () const
 Returns the optional AirLoopHVACOutdoorAirSystem that the HVAC component is attached to. More...
 
std::vector< AppGFuelType > appGHeatingFuelTypes () const
 
void applySizingValues ()
 
void autosize ()
 Returns the optional ModelObject connected to this object's port. More...
 
ComponentType componentType () const
 
boost::optional< HVACComponentcontainingHVACComponent () const
 EnergyPlus unitary equipment and air terminals are typically composed of other HVAC components. More...
 
boost::optional
< StraightComponent
containingStraightComponent () const
 
boost::optional
< ZoneHVACComponent
containingZoneHVACComponent () const
 Returns any ZoneHVACComponent that contains this HVACComponent. More...
 
std::vector< FuelType > coolingFuelTypes () const
 
void disconnect ()
 Removes all connections to other HVACComponent objects. More...
 
std::vector< FuelType > heatingFuelTypes () const
 
 HVACComponent (const HVACComponent &other)=default
 
 HVACComponent (HVACComponent &&other)=default
 
bool isRemovable () const
 Indicates if the HVACComponent can be removed from the model. More...
 
boost::optional< Looploop () const
 Returns the optional Loop object that the HVAC component is attached to. More...
 
HVACComponentoperator= (const HVACComponent &)=default
 
HVACComponentoperator= (HVACComponent &&)=default
 
boost::optional< PlantLoopplantLoop () const
 Returns the optional PlantLoop object that the HVAC component is attached to. More...
 
std::vector< IdfObject > remove ()
 Removes the HVACComponent from the model only if isRemovable() return true. More...
 
virtual ~HVACComponent ()=default
 
- Public Member Functions inherited from openstudio::model::ParentObject
std::vector< IddObjectType > allowableChildTypes () const
 Returns a vector of allowable children types. More...
 
std::vector< ModelObjectchildren () const
 Return direct child objects in the Model. More...
 
ParentObjectoperator= (const ParentObject &)=default
 
ParentObjectoperator= (ParentObject &&)=default
 
 ParentObject (const ParentObject &other)=default
 
 ParentObject (ParentObject &&other)=default
 
virtual ~ParentObject ()=default
 
- Public Member Functions inherited from openstudio::model::ModelObject
virtual ~ModelObject ()=default
 
 ModelObject (const ModelObject &other)=default
 
 ModelObject (ModelObject &&other)=default
 
ModelObjectoperator= (const ModelObject &)=default
 
ModelObjectoperator= (ModelObject &&)=default
 
ModelObject clone () const
 Creates a deep copy of this object, placing it in this object's model(). More...
 
ModelObject clone (Model model) const
 Creates a deep copy of this object, placing it in model. More...
 
Component createComponent () const
 Method for creating sharable Model snippets. More...
 
Model model () const
 Returns the Model that contains this object. More...
 
boost::optional< ParentObjectparent () const
 Return this object's parent in the hierarchy, if it has one. More...
 
std::vector< ResourceObjectresources () const
 Get the resources directly used by this ModelObject. More...
 
template<typename T >
std::vector< T > getModelObjectSources () const
 Get all objects of type T that point to this object. More...
 
template<typename T >
std::vector< T > getModelObjectSources (IddObjectType iddObjectType) const
 Get all objects of type T that point to this object. More...
 
template<typename T >
boost::optional< T > getModelObjectTarget (unsigned index) const
 Get the object of type T pointed to by this object from field index. More...
 
template<typename T >
std::vector< T > getModelObjectTargets () const
 Get all objects of type T to which this object points. More...
 
const std::vector< std::string > & outputVariableNames () const
 Get all output variables names that could be associated with this object. More...
 
std::vector< OutputVariableoutputVariables () const
 Get all output variables associated with this object, must run simulation to generate data. More...
 
boost::optional
< openstudio::TimeSeries > 
getData (const OutputVariable &variable, const std::string &envPeriod) const
 Get data associated with this output variable and this object. More...
 
std::vector< LifeCycleCostlifeCycleCosts () const
 Returns the list of all LifeCycleCosts that refer to this object. More...
 
std::vector< IdfObject > removeLifeCycleCosts ()
 Removes all LifeCycleCosts that refer to this object. More...
 
IddObjectType iddObjectType () const
 This is a virtual function that will tell you the type of iddObject you are dealing with. More...
 
AdditionalProperties additionalProperties () const
 Returns this object's additional properties, constructing a new object if necessary. More...
 
bool hasAdditionalProperties () const
 Returns true if this object has additional properties. More...
 
std::vector< IdfObject > removeAdditionalProperties ()
 Removes all additional properties that refer to this object. More...
 
boost::optional< std::string > cadObjectId () const
 
bool setCADObjectId (const std::string &cadObjectId)
 
boost::optional< std::string > gbXMLId () const
 
bool setGBXMLId (const std::string &gbXMLId)
 
boost::optional< std::string > displayName () const
 
bool setDisplayName (const std::string &displayName)
 
bool setParent (ParentObject &newParent)
 set the parent, child may have to call non-const methods on the parent More...
 
bool operator< (const ModelObject &right) const
 
bool operator== (const ModelObject &other) const
 equality test More...
 
bool operator!= (const ModelObject &other) const
 inequality test More...
 
std::vector< ScheduleTypeKeygetScheduleTypeKeys (const Schedule &schedule) const
 Return the ScheduleTypeKeys indicating how schedule is used in this object. More...
 
boost::optional< double > getAutosizedValue (const std::string &valueName, const std::string &units) const
 Gets the autosized component value from the sql file. More...
 
virtual std::vector
< EMSActuatorNames
emsActuatorNames () const
 Return the names of the available ems actuators. More...
 
virtual std::vector< std::string > emsInternalVariableNames () const
 Return the names of the available ems internal variables. More...
 
boost::optional< ModelObjectconnectedObject (unsigned port) const
 
boost::optional< unsigned > connectedObjectPort (unsigned port) const
 

Static Public Member Functions

static IddObjectType iddObjectType ()
 

Protected Types

using ImplType = detail::ConnectorMixer_Impl
 
- Protected Types inherited from openstudio::model::Mixer
using ImplType = detail::Mixer_Impl
 
- Protected Types inherited from openstudio::model::HVACComponent
using ImplType = detail::HVACComponent_Impl
 
- Protected Types inherited from openstudio::model::ModelObject
using ImplType = detail::ModelObject_Impl
 

Protected Member Functions

 ConnectorMixer (std::shared_ptr< detail::ConnectorMixer_Impl > impl)
 
- Protected Member Functions inherited from openstudio::model::Mixer
 Mixer (IddObjectType type, const Model &model)
 
 Mixer (std::shared_ptr< ImplType > impl)
 
- Protected Member Functions inherited from openstudio::model::HVACComponent
virtual std::vector< ModelObjectchildren () const
 
 HVACComponent (IddObjectType type, const Model &model)
 
 HVACComponent (std::shared_ptr< ImplType > impl)
 
- Protected Member Functions inherited from openstudio::model::ParentObject
 ParentObject (IddObjectType type, const Model &model)
 Constructs a new ParentObject object in the model. More...
 
- Protected Member Functions inherited from openstudio::model::ModelObject
 ModelObject (IddObjectType type, const Model &model, bool fastName=false)
 
 ModelObject (std::shared_ptr< detail::ModelObject_Impl > impl)
 

Related Functions

(Note that these are not member functions.)

using OptionalConnectorMixer = boost::optional< ConnectorMixer >
 

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

using openstudio::model::ConnectorMixer::ImplType = detail::ConnectorMixer_Impl
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 ( )
virtualdefault
openstudio::model::ConnectorMixer::ConnectorMixer ( const ConnectorMixer other)
default
openstudio::model::ConnectorMixer::ConnectorMixer ( ConnectorMixer &&  other)
default
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.

ConnectorMixer& openstudio::model::ConnectorMixer::operator= ( const ConnectorMixer )
default
ConnectorMixer& openstudio::model::ConnectorMixer::operator= ( ConnectorMixer &&  )
default
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

using OptionalConnectorMixer = boost::optional<ConnectorMixer>
related