 |
OpenStudio:model |
|
OpenStudio:model |
#include <Mixer.hpp>
Inheritance diagram for openstudio::model::Mixer:Public Member Functions | |
| virtual unsigned | branchIndexForInletModelObject (const 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< ModelObject > | inletModelObjects () const |
| Returns a vector of all objects connected to the mixer's inlet ports. More... | |
| virtual unsigned | inletPort (unsigned branchIndex) const |
| Returns the inlet port for branchIndex. More... | |
| 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... | |
| virtual unsigned | nextInletPort () const |
| Returns the next available inlet port. More... | |
| Mixer & | operator= (const Mixer &)=default |
| Mixer & | operator= (Mixer &&)=default |
| virtual boost::optional < ModelObject > | outletModelObject () const |
| Returns the optional ModelObject connected to the outlet port. More... | |
| virtual unsigned | outletPort () const |
| Returns the outlet port to the zone mixer. More... | |
| virtual void | removePortForBranch (unsigned branchIndex) |
| Effectively disconnects anything connected to the inlet port at the specified branch index. More... | |
| 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. More... | |
| bool | addToSplitter (Splitter &splitter) |
| Adds this object to a splitter by creating a new branch. More... | |
| boost::optional< AirLoopHVAC > | airLoopHVAC () 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< HVACComponent > | containingHVACComponent () 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< Loop > | loop () const |
| Returns the optional Loop object that the HVAC component is attached to. More... | |
| HVACComponent & | operator= (const HVACComponent &)=default |
| HVACComponent & | operator= (HVACComponent &&)=default |
| boost::optional< PlantLoop > | plantLoop () 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 () override=default |
| Public Member Functions inherited from openstudio::model::ParentObject | |
| std::vector< IddObjectType > | allowableChildTypes () const |
| Returns a vector of allowable children types. More... | |
| std::vector< ModelObject > | children () const |
| Return direct child objects in the Model. More... | |
| ParentObject & | operator= (const ParentObject &)=default |
| ParentObject & | operator= (ParentObject &&)=default |
| ParentObject (const ParentObject &other)=default | |
| ParentObject (ParentObject &&other)=default | |
| virtual | ~ParentObject () override=default |
| Public Member Functions inherited from openstudio::model::ModelObject | |
| virtual | ~ModelObject () override=default |
| ModelObject (const ModelObject &other)=default | |
| ModelObject (ModelObject &&other)=default | |
| ModelObject & | operator= (const ModelObject &)=default |
| ModelObject & | operator= (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< ParentObject > | parent () const |
| Return this object's parent in the hierarchy, if it has one. More... | |
| std::vector< ResourceObject > | resources () 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< OutputVariable > | outputVariables () 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< LifeCycleCost > | lifeCycleCosts () 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< ScheduleTypeKey > | getScheduleTypeKeys (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< ModelObject > | connectedObject (unsigned port) const |
| boost::optional< unsigned > | connectedObjectPort (unsigned port) const |
| Public Member Functions inherited from openstudio::WorkspaceObject | |
| bool | canBeSource () const |
| bool | canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const |
| std::vector< std::string > | canBeTarget () const |
| std::vector< unsigned > | getSourceIndices (const Handle &targetHandle) const |
| std::vector< WorkspaceObject > | getSources (IddObjectType type) const |
| boost::optional< WorkspaceObject > | getTarget (unsigned index) const |
| IdfObject | idfObject () |
| IdfObject | idfObject () const |
| bool | initialized () const |
| bool | isSource () const |
| bool | isTarget () const |
| unsigned | numSources () const |
| bool | objectListFieldsEqual (const WorkspaceObject &other) const |
| bool | objectListFieldsNonConflicting (const WorkspaceObject &other) const |
| bool | operator< (const WorkspaceObject &right) const |
| std::ostream & | operator<< (std::ostream &os, const WorkspaceObject &workspaceObject) |
| WorkspaceObject & | operator= (WorkspaceObject &&)=default |
| WorkspaceObject & | operator= (const WorkspaceObject &)=default |
| std::vector < openstudio::IdfObject > | remove () |
| bool | setPointer (unsigned index, const Handle &targetHandle) |
| std::vector< WorkspaceObject > | sources () const |
| std::vector< WorkspaceObject > | targets () const |
| Workspace | workspace () const |
| WorkspaceObject (const WorkspaceObject &other)=default | |
| WorkspaceObject (WorkspaceObject &&other)=default | |
| virtual | ~WorkspaceObject () override=default |
| Public Member Functions inherited from openstudio::IdfObject | |
| std::string | briefDescription () const |
| T | cast () const |
| std::vector< T > | castVector (const std::vector< U > &objects) |
| std::vector< std::vector < std::string > > | clearExtensibleGroups () |
| IdfObject | clone (bool keepHandle=false) const |
| std::string | comment () const |
| boost::optional< std::string > | createName (bool overwrite=true) |
| std::vector< unsigned > | dataFields () const |
| bool | dataFieldsEqual (const IdfObject &other) const |
| std::vector< std::string > | eraseExtensibleGroup (unsigned groupIndex) |
| std::vector< IdfExtensibleGroup > | extensibleGroups () const |
| boost::optional< std::string > | fieldComment (unsigned index, bool returnDefault=false) const |
| boost::optional< double > | getDouble (unsigned index, bool returnDefault=false) const |
| IdfExtensibleGroup | getExtensibleGroup (unsigned groupIndex) 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 |
| 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< unsigned > | getUnsigned (unsigned index, bool returnDefault=false) const |
| Handle | handle () const |
| IddObject | iddObject () const |
| IdfObject (IddObjectType type, bool fastName=false) | |
| IdfObject (const IdfObject &other) | |
| IdfObject (const IddObject &, bool fastName=false) | |
| IdfObject (IdfObject &&other) noexcept | |
| IdfExtensibleGroup | insertExtensibleGroup (unsigned groupIndex) |
| IdfExtensibleGroup | insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values) |
| bool | isDataField (unsigned index) const |
| bool | isEmpty (unsigned index) const |
| bool | isObjectListField (unsigned index) const |
| bool | isValid (StrictnessLevel level, bool checkNames=false) const |
| boost::optional< unsigned > | maxExtensibleGroups () const |
| boost::optional< unsigned > | maxFields () const |
| unsigned | minExtensibleGroups () const |
| unsigned | minFields () const |
| boost::optional< std::string > | name (bool returnDefault=false) const |
| std::string | nameString (bool returnDefault=false) const |
| unsigned | numExtensibleGroups () const |
| unsigned | numFields () const |
| unsigned | numNonextensibleFields () const |
| std::vector< unsigned > | objectListFields () const |
| bool | objectListFieldsEqual (const IdfObject &other) const |
| bool | objectListFieldsNonConflicting (const IdfObject &other) const |
| bool | operator!= (const IdfObject &other) const |
| std::ostream & | operator<< (std::ostream &os, const IdfObject &IdfObject) |
| IdfObject & | operator= (IdfObject &&other) noexcept |
| IdfObject & | operator= (const IdfObject &other) |
| bool | operator== (const IdfObject &other) const |
| boost::optional< T > | optionalCast () const |
| 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 (const std::vector< std::string > &values) |
| IdfExtensibleGroup | pushExtensibleGroup () |
| std::vector< unsigned > | requiredFields () const |
| void | setComment (const std::string &msg) |
| bool | setDouble (unsigned index, double value) |
| bool | setFieldComment (unsigned index, const std::string &cmnt) |
| bool | setInt (unsigned index, int value) |
| boost::optional< std::string > | setName (const std::string &newName) |
| bool | setQuantity (unsigned index, const Quantity &q) |
| bool | setString (unsigned index, const std::string &value) |
| bool | setUnsigned (unsigned index, unsigned value) |
| std::vector< T > | subsetCastVector (const std::vector< U > &original) |
| ValidityReport | validityReport (StrictnessLevel level, bool checkNames=false) const |
| virtual | ~IdfObject ()=default |
Protected Types | |
| 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 | |
| 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. 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) | |
| 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) | |
Additional Inherited Members | |
| Public Types inherited from openstudio::WorkspaceObject | |
| typedef boost::optional < WorkspaceObject > | OptionalWorkspaceObject |
| typedef std::vector < WorkspaceObject > | WorkspaceObjectVector |
| Public Types inherited from openstudio::IdfObject | |
| typedef std::pair< IdfObject, IdfObject > | IdfObjectPair |
| typedef std::vector< IdfObject > | IdfObjectVector |
| typedef boost::optional < IdfObject > | OptionalIdfObject |
| Static Public Member Functions inherited from openstudio::IdfObject | |
| static boost::optional< IdfObject > | load (const std::string &text) |
| static boost::optional< IdfObject > | load (const std::string &text, const IddObject &iddObject) |
| static int | printedFieldSpace () |
| Related Functions inherited from openstudio::model::ParentObject | |
| std::vector< ModelObject > | getRecursiveChildren (const ParentObject &object, bool includeLifeCycleCostsAndAdditionalProperties=false, bool includeUsedResources=true) |
| Returns object and all other objects accessible by calling children() on encountered ParentObjects . More... | |
| std::vector< ModelObject > | getRecursiveChildrenAndResources (const ModelObject &object) |
| Returns object and all other objects accessible by calling children() and resources() on encountered ModelObjects . More... | |
| Related Functions inherited from openstudio::model::ModelObject | |
| std::vector< ResourceObject > | getRecursiveResources (const ModelObject &object) |
| Returns all ResourceObjects accessible by recursively calling .resources() starting from object. More... | |
|
protected |
|
overridevirtualdefault |
|
default |
|
default |
|
protected |
|
explicitprotected |
|
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 |
Returns the optional ModelObject connected to the branch designated by branchIndex.
If there is no connected object then the optional will be false.
|
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 |
Returns the inlet port for branchIndex.
Branches consequtively indexed starting from 0.
Reimplemented in openstudio::model::AirLoopHVACReturnPlenum, openstudio::model::AirLoopHVACZoneMixer, and openstudio::model::ConnectorMixer.
|
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 |
Returns a new port after the branch specified by branchIndex.
|
virtual |
Returns the index of the next available branch.
|
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 |
Returns the optional ModelObject connected to the outlet port.
If there is no connected object then the optional will be false.
|
virtual |
Returns the outlet port to the zone mixer.
Reimplemented in openstudio::model::AirLoopHVACReturnPlenum, openstudio::model::AirLoopHVACZoneMixer, and openstudio::model::ConnectorMixer.
|
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.
