OpenStudio:model
Loading...
Searching...
No Matches
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 (ConnectorMixer &&other)=default
 
 ConnectorMixer (const ConnectorMixer &other)=default
 
 ConnectorMixer (const Model &model)
 Constructs a new Mixer object and places it inside the model.
 
unsigned inletPort (unsigned branchIndex) const override
 Returns the inlet port for branchIndex.
 
unsigned nextInletPort () const override
 Returns the next available inlet port.
 
ConnectorMixeroperator= (ConnectorMixer &&)=default
 
ConnectorMixeroperator= (const ConnectorMixer &)=default
 
unsigned outletPort () const override
 Returns the outlet port to the zone mixer.
 
virtual std::vector< openstudio::IdfObjectremove ()
 
virtual ~ConnectorMixer () override=default
 
- Public Member Functions inherited from openstudio::model::Mixer
virtual unsigned branchIndexForInletModelObject (const ModelObject &modelObject) const
 Returns the branch index for the ModelObject specified by modelObject.
 
virtual boost::optional< ModelObjectinletModelObject (unsigned branchIndex) const
 Returns the optional ModelObject connected to the branch designated by branchIndex.
 
virtual std::vector< ModelObjectinletModelObjects () const
 Returns a vector of all objects connected to the mixer's inlet ports.
 
virtual boost::optional< ModelObjectlastInletModelObject () const
 Returns the optional ModelObject connected to the last branch of the mixer.
 
 Mixer (const Mixer &other)=default
 
 Mixer (Mixer &&other)=default
 
virtual unsigned newInletPortAfterBranch (unsigned branchIndex)
 Returns a new port after the branch specified by branchIndex.
 
virtual unsigned nextBranchIndex () const
 Returns the index of the next available branch.
 
Mixeroperator= (const Mixer &)=default
 
Mixeroperator= (Mixer &&)=default
 
virtual boost::optional< ModelObjectoutletModelObject () const
 Returns the optional ModelObject connected to the outlet port.
 
virtual void removePortForBranch (unsigned branchIndex)
 Effectively disconnects anything connected to the inlet port at the specified branch index.
 
virtual ~Mixer () override=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.
 
bool addToSplitter (Splitter &splitter)
 Adds this object to a splitter by creating a new branch.
 
boost::optional< AirLoopHVACairLoopHVAC () const
 Returns the optional AirLoopHVAC object that the HVAC component is attached to.
 
boost::optional< AirLoopHVACOutdoorAirSystem > airLoopHVACOutdoorAirSystem () const
 Returns the optional AirLoopHVACOutdoorAirSystem that the HVAC component is attached to.
 
std::vector< AppGFuelTypeappGHeatingFuelTypes () const
 
void applySizingValues ()
 
void autosize ()
 Returns the optional ModelObject connected to this object's port.
 
ComponentType componentType () const
 
boost::optional< HVACComponentcontainingHVACComponent () const
 EnergyPlus unitary equipment and air terminals are typically composed of other HVAC components.
 
boost::optional< StraightComponentcontainingStraightComponent () const
 
boost::optional< ZoneHVACComponentcontainingZoneHVACComponent () const
 Returns any ZoneHVACComponent that contains this HVACComponent.
 
std::vector< FuelTypecoolingFuelTypes () const
 
void disconnect ()
 Removes all connections to other HVACComponent objects.
 
std::vector< FuelTypeheatingFuelTypes () const
 
 HVACComponent (const HVACComponent &other)=default
 
 HVACComponent (HVACComponent &&other)=default
 
bool isRemovable () const
 Indicates if the HVACComponent can be removed from the model.
 
boost::optional< Looploop () const
 Returns the optional Loop object that the HVAC component is attached to.
 
HVACComponentoperator= (const HVACComponent &)=default
 
HVACComponentoperator= (HVACComponent &&)=default
 
boost::optional< PlantLoopplantLoop () const
 Returns the optional PlantLoop object that the HVAC component is attached to.
 
std::vector< IdfObjectremove ()
 Removes the HVACComponent from the model only if isRemovable() return true.
 
virtual ~HVACComponent () override=default
 
- Public Member Functions inherited from openstudio::model::ParentObject
ParentObjectoperator= (const ParentObject &)=default
 
ParentObjectoperator= (ParentObject &&)=default
 
 ParentObject (const ParentObject &other)=default
 
 ParentObject (ParentObject &&other)=default
 
virtual ~ParentObject () override=default
 
std::vector< ModelObjectchildren () const
 Return direct child objects in the Model.
 
std::vector< IddObjectTypeallowableChildTypes () const
 Returns a vector of allowable children types.
 
- Public Member Functions inherited from openstudio::model::ModelObject
virtual ~ModelObject () override=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().
 
ModelObject clone (Model model) const
 Creates a deep copy of this object, placing it in model.
 
Component createComponent () const
 Method for creating sharable Model snippets.
 
Model model () const
 Returns the Model that contains this object.
 
boost::optional< ParentObjectparent () const
 Return this object's parent in the hierarchy, if it has one.
 
std::vector< ResourceObjectresources () const
 Get the resources directly used by this ModelObject.
 
template<typename T >
std::vector< T > getModelObjectSources () const
 Get all objects of type T that point to this object.
 
template<typename T >
std::vector< T > getModelObjectSources (IddObjectType iddObjectType) const
 Get all objects of type T that point to this object.
 
template<typename T >
boost::optional< T > getModelObjectTarget (unsigned index) const
 Get the object of type T pointed to by this object from field index.
 
template<typename T >
std::vector< T > getModelObjectTargets () const
 Get all objects of type T to which this object points.
 
const std::vector< std::string > & outputVariableNames () const
 Get all output variables names that could be associated with this object.
 
std::vector< OutputVariableoutputVariables () const
 Get all output variables associated with this object, must run simulation to generate data.
 
boost::optional< openstudio::TimeSeriesgetData (const OutputVariable &variable, const std::string &envPeriod) const
 Get data associated with this output variable and this object.
 
std::vector< LifeCycleCostlifeCycleCosts () const
 Returns the list of all LifeCycleCosts that refer to this object.
 
std::vector< IdfObjectremoveLifeCycleCosts ()
 Removes all LifeCycleCosts that refer to this object.
 
IddObjectType iddObjectType () const
 This is a virtual function that will tell you the type of iddObject you are dealing with.
 
AdditionalProperties additionalProperties () const
 Returns this object's additional properties, constructing a new object if necessary.
 
bool hasAdditionalProperties () const
 Returns true if this object has additional properties.
 
std::vector< IdfObjectremoveAdditionalProperties ()
 Removes all additional properties that refer to this object.
 
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
 
bool operator< (const ModelObject &right) const
 
bool operator== (const ModelObject &other) const
 equality test
 
bool operator!= (const ModelObject &other) const
 inequality test
 
std::vector< ScheduleTypeKeygetScheduleTypeKeys (const Schedule &schedule) const
 Return the ScheduleTypeKeys indicating how schedule is used in this object.
 
boost::optional< double > getAutosizedValue (const std::string &valueName, const std::string &units) const
 Gets the autosized component value from the sql file.
 
virtual std::vector< EMSActuatorNamesemsActuatorNames () const
 Return the names of the available ems actuators.
 
virtual std::vector< std::string > emsInternalVariableNames () const
 Return the names of the available ems internal variables.
 
boost::optional< ModelObjectconnectedObject (unsigned port) const
 
boost::optional< unsigned > connectedObjectPort (unsigned port) const
 
- Public Member Functions inherited from openstudio::WorkspaceObject
bool canBeSource () const
 
bool canBeSource () const
 
bool canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const
 
bool canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const
 
std::vector< std::string > canBeTarget () const
 
std::vector< std::string > canBeTarget () const
 
std::vector< unsigned > getSourceIndices (const Handle &targetHandle) const
 
std::vector< unsigned > getSourceIndices (const Handle &targetHandle) const
 
std::vector< WorkspaceObjectgetSources (IddObjectType type) const
 
std::vector< WorkspaceObjectgetSources (IddObjectType type) const
 
boost::optional< WorkspaceObjectgetTarget (unsigned index) const
 
boost::optional< WorkspaceObjectgetTarget (unsigned index) const
 
IdfObject idfObject ()
 
IdfObject idfObject () const
 
bool initialized () const
 
bool initialized () const
 
bool isSource () const
 
bool isSource () const
 
bool isTarget () const
 
bool isTarget () const
 
unsigned numSources () const
 
unsigned numSources () const
 
bool objectListFieldsEqual (const WorkspaceObject &other) const
 
bool objectListFieldsEqual (const WorkspaceObject &other) const
 
bool objectListFieldsNonConflicting (const WorkspaceObject &other) const
 
bool objectListFieldsNonConflicting (const WorkspaceObject &other) const
 
bool operator< (const WorkspaceObject &right) const
 
bool operator< (const WorkspaceObject &right) const
 
std::ostream & operator<< (std::ostream &os, const WorkspaceObject &workspaceObject)
 
WorkspaceObjectoperator= (const WorkspaceObject &)=default
 
WorkspaceObjectoperator= (const WorkspaceObject &)=default
 
WorkspaceObjectoperator= (WorkspaceObject &&)=default
 
WorkspaceObjectoperator= (WorkspaceObject &&)=default
 
std::vector< openstudio::IdfObjectremove ()
 
std::vector< openstudio::IdfObjectremove ()
 
bool setPointer (unsigned index, const Handle &targetHandle)
 
bool setPointer (unsigned index, const Handle &targetHandle)
 
std::vector< WorkspaceObjectsources () const
 
std::vector< WorkspaceObjectsources () const
 
std::vector< WorkspaceObjecttargets () const
 
std::vector< WorkspaceObjecttargets () const
 
Workspace workspace () const
 
Workspace workspace () const
 
 WorkspaceObject (const WorkspaceObject &other)=default
 
 WorkspaceObject (const WorkspaceObject &other)=default
 
 WorkspaceObject (WorkspaceObject &&other)=default
 
 WorkspaceObject (WorkspaceObject &&other)=default
 
virtual ~WorkspaceObject () override=default
 
virtual ~WorkspaceObject () override=default
 
- Public Member Functions inherited from openstudio::IdfObject
std::string briefDescription () const
 
std::string briefDescription () const
 
cast () const
 
std::vector< T > castVector (const std::vector< U > &objects)
 
std::vector< std::vector< std::string > > clearExtensibleGroups ()
 
std::vector< std::vector< std::string > > clearExtensibleGroups ()
 
IdfObject clone (bool keepHandle=false) const
 
IdfObject clone (bool keepHandle=false) const
 
std::string comment () const
 
std::string comment () const
 
boost::optional< std::string > createName (bool overwrite=true)
 
boost::optional< std::string > createName (bool overwrite=true)
 
std::vector< unsigned > dataFields () const
 
std::vector< unsigned > dataFields () const
 
bool dataFieldsEqual (const IdfObject &other) const
 
bool dataFieldsEqual (const IdfObject &other) const
 
std::vector< std::string > eraseExtensibleGroup (unsigned groupIndex)
 
std::vector< std::string > eraseExtensibleGroup (unsigned groupIndex)
 
std::vector< IdfExtensibleGroupextensibleGroups () const
 
std::vector< IdfExtensibleGroupextensibleGroups () const
 
boost::optional< std::string > fieldComment (unsigned index, bool returnDefault=false) const
 
boost::optional< std::string > fieldComment (unsigned index, bool returnDefault=false) const
 
boost::optional< double > getDouble (unsigned index, bool returnDefault=false) const
 
boost::optional< double > getDouble (unsigned index, bool returnDefault=false) const
 
IdfExtensibleGroup getExtensibleGroup (unsigned groupIndex) const
 
IdfExtensibleGroup getExtensibleGroup (unsigned groupIndex) const
 
boost::optional< std::string > getField (unsigned index, bool returnDefault=false) const
 
boost::optional< std::string > getField (unsigned index, bool returnDefault=false) const
 
std::vector< Handle > getHandles (const std::vector< T > &objects)
 
boost::optional< int > getInt (unsigned index, bool returnDefault=false) const
 
boost::optional< int > getInt (unsigned index, bool returnDefault=false) const
 
OSOptionalQuantity getQuantity (unsigned index, bool returnDefault=false, bool returnIP=false) const
 
OSOptionalQuantity getQuantity (unsigned index, bool returnDefault=false, bool returnIP=false) const
 
boost::optional< std::string > getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const
 
boost::optional< std::string > getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const
 
boost::optional< unsigned > getUnsigned (unsigned index, bool returnDefault=false) const
 
boost::optional< unsigned > getUnsigned (unsigned index, bool returnDefault=false) const
 
Handle handle () const
 
Handle handle () const
 
IddObject iddObject () const
 
IddObject iddObject () const
 
 IdfObject (const IddObject &, bool fastName=false)
 
 IdfObject (const IddObject &, bool fastName=false)
 
 IdfObject (const IdfObject &other)
 
 IdfObject (const IdfObject &other)
 
 IdfObject (IddObjectType type, bool fastName=false)
 
 IdfObject (IddObjectType type, bool fastName=false)
 
 IdfObject (IdfObject &&other) noexcept
 
 IdfObject (IdfObject &&other) noexcept
 
void initializeFields (bool fill_default=false)
 
void initializeFields (bool fill_default=false)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)
 
bool isDataField (unsigned index) const
 
bool isDataField (unsigned index) const
 
bool isEmpty (unsigned index) const
 
bool isEmpty (unsigned index) const
 
bool isObjectListField (unsigned index) const
 
bool isObjectListField (unsigned index) const
 
bool isValid (StrictnessLevel level, bool checkNames=false) const
 
bool isValid (StrictnessLevel level, bool checkNames=false) const
 
boost::optional< unsigned > maxExtensibleGroups () const
 
boost::optional< unsigned > maxExtensibleGroups () const
 
boost::optional< unsigned > maxFields () const
 
boost::optional< unsigned > maxFields () const
 
unsigned minExtensibleGroups () const
 
unsigned minExtensibleGroups () const
 
unsigned minFields () const
 
unsigned minFields () const
 
boost::optional< std::string > name (bool returnDefault=false) const
 
boost::optional< std::string > name (bool returnDefault=false) const
 
std::string nameString (bool returnDefault=false) const
 
std::string nameString (bool returnDefault=false) const
 
unsigned numExtensibleGroups () const
 
unsigned numExtensibleGroups () const
 
unsigned numFields () const
 
unsigned numFields () const
 
unsigned numNonextensibleFields () const
 
unsigned numNonextensibleFields () const
 
std::vector< unsigned > objectListFields () const
 
std::vector< unsigned > objectListFields () const
 
bool objectListFieldsEqual (const IdfObject &other) const
 
bool objectListFieldsEqual (const IdfObject &other) const
 
bool objectListFieldsNonConflicting (const IdfObject &other) const
 
bool objectListFieldsNonConflicting (const IdfObject &other) const
 
bool operator!= (const IdfObject &other) const
 
bool operator!= (const IdfObject &other) const
 
std::ostream & operator<< (std::ostream &os, const IdfObject &IdfObject)
 
IdfObjectoperator= (const IdfObject &other)
 
IdfObjectoperator= (const IdfObject &other)
 
IdfObjectoperator= (IdfObject &&other) noexcept
 
IdfObjectoperator= (IdfObject &&other) noexcept
 
bool operator== (const IdfObject &other) const
 
bool operator== (const IdfObject &other) const
 
boost::optional< T > optionalCast () const
 
std::vector< std::string > popExtensibleGroup ()
 
std::vector< std::string > popExtensibleGroup ()
 
std::ostream & print (std::ostream &os) const
 
std::ostream & printField (std::ostream &os, unsigned index, bool isLastField=false) const
 
std::ostream & printName (std::ostream &os, bool hasFields=true) const
 
IdfExtensibleGroup pushExtensibleGroup ()
 
IdfExtensibleGroup pushExtensibleGroup ()
 
IdfExtensibleGroup pushExtensibleGroup (const std::vector< std::string > &values)
 
IdfExtensibleGroup pushExtensibleGroup (const std::vector< std::string > &values)
 
std::vector< unsigned > requiredFields () const
 
std::vector< unsigned > requiredFields () const
 
void setComment (const std::string &msg)
 
void setComment (const std::string &msg)
 
bool setDouble (unsigned index, double value)
 
bool setDouble (unsigned index, double value)
 
bool setFieldComment (unsigned index, const std::string &cmnt)
 
bool setFieldComment (unsigned index, const std::string &cmnt)
 
bool setInt (unsigned index, int value)
 
bool setInt (unsigned index, int value)
 
boost::optional< std::string > setName (const std::string &newName)
 
boost::optional< std::string > setName (const std::string &newName)
 
bool setQuantity (unsigned index, const Quantity &q)
 
bool setQuantity (unsigned index, const Quantity &q)
 
bool setString (unsigned index, const std::string &value)
 
bool setString (unsigned index, const std::string &value)
 
bool setUnsigned (unsigned index, unsigned value)
 
bool setUnsigned (unsigned index, unsigned value)
 
std::vector< T > subsetCastVector (const std::vector< U > &original)
 
ValidityReport validityReport (StrictnessLevel level, bool checkNames=false) const
 
ValidityReport validityReport (StrictnessLevel level, bool checkNames=false) const
 
virtual ~IdfObject ()=default
 
virtual ~IdfObject ()=default
 

Static Public Member Functions

static IddObjectType iddObjectType ()
 
- Static Public Member Functions inherited from openstudio::IdfObject
static boost::optional< IdfObjectload (const std::string &text)
 
static boost::optional< IdfObjectload (const std::string &text, const IddObject &iddObject)
 
static int printedFieldSpace ()
 

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 Types inherited from openstudio::WorkspaceObject
typedef detail::WorkspaceObject_Impl ImplType
 
- Protected Types inherited from openstudio::IdfObject
typedef detail::IdfObject_Impl ImplType
 

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
 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.
 
- 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)
 
- Protected Member Functions inherited from openstudio::WorkspaceObject
 WorkspaceObject (std::shared_ptr< detail::WorkspaceObject_Impl > impl)
 
- Protected Member Functions inherited from openstudio::IdfObject
 IdfObject (std::shared_ptr< detail::IdfObject_Impl > impl)
 

Related Symbols

(Note that these are not member symbols.)

using OptionalConnectorMixer = boost::optional<ConnectorMixer>
 

Additional Inherited Members

- Public Types inherited from openstudio::WorkspaceObject
typedef boost::optional< WorkspaceObjectOptionalWorkspaceObject
 
typedef std::vector< WorkspaceObjectWorkspaceObjectVector
 
- Public Types inherited from openstudio::IdfObject
typedef std::pair< IdfObject, IdfObjectIdfObjectPair
 
typedef std::vector< IdfObjectIdfObjectVector
 
typedef boost::optional< IdfObjectOptionalIdfObject
 

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

◆ ImplType

using openstudio::model::ConnectorMixer::ImplType = detail::ConnectorMixer_Impl
protected

Constructor & Destructor Documentation

◆ ConnectorMixer() [1/4]

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

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

◆ ~ConnectorMixer()

virtual openstudio::model::ConnectorMixer::~ConnectorMixer ( )
overridevirtualdefault

◆ ConnectorMixer() [2/4]

openstudio::model::ConnectorMixer::ConnectorMixer ( const ConnectorMixer & other)
default

◆ ConnectorMixer() [3/4]

openstudio::model::ConnectorMixer::ConnectorMixer ( ConnectorMixer && other)
default

◆ ConnectorMixer() [4/4]

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

Member Function Documentation

◆ addToNode()

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

◆ clone()

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

◆ iddObjectType()

static IddObjectType openstudio::model::ConnectorMixer::iddObjectType ( )
static

◆ inletPort()

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.

◆ nextInletPort()

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.

◆ operator=() [1/2]

ConnectorMixer & openstudio::model::ConnectorMixer::operator= ( ConnectorMixer && )
default

◆ operator=() [2/2]

ConnectorMixer & openstudio::model::ConnectorMixer::operator= ( const ConnectorMixer & )
default

◆ outletPort()

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

Returns the outlet port to the zone mixer.

Reimplemented from openstudio::model::Mixer.

◆ remove()

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

Friends And Related Symbol Documentation

◆ OptionalConnectorMixer

using OptionalConnectorMixer = boost::optional<ConnectorMixer>
related