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

#include <Splitter.hpp>

+ Inheritance diagram for openstudio::model::Splitter:

Public Member Functions

virtual unsigned branchIndexForOutletModelObject (ModelObject modelObject) const
 Returns the branch index for the ModelObject specified by modelObject. More...
 
virtual boost::optional
< ModelObject
inletModelObject () const
 Returns the optional ModelObject connected to the inlet port. More...
 
virtual unsigned inletPort () const
 Returns the inlet port to the splitter. More...
 
bool isRemovable () const
 
virtual boost::optional
< ModelObject
lastOutletModelObject () const
 Returns the optional ModelObject connected to the last branch of the splitter. More...
 
virtual unsigned newOutletPortAfterBranch (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 nextOutletPort () const
 Returns the next available outlet port. More...
 
virtual boost::optional
< ModelObject
outletModelObject (unsigned branchIndex) const
 Returns the optional ModelObject connected to the branch designated by branchIndex. More...
 
virtual std::vector< ModelObjectoutletModelObjects () const
 Returns a vector of all objects connected to the splitter's outlet ports. More...
 
virtual unsigned outletPort (unsigned branchIndex) const
 Returns the outlet port for branchIndex. More...
 
virtual void removePortForBranch (unsigned branchIndex)
 Effectively disconnects anything connected to the outlet port at the specified branch index. More...
 
virtual ~Splitter ()
 
- 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...
 
void applySizingValues ()
 
void autosize ()
 Returns the optional ModelObject connected to this object's port. More...
 
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...
 
void disconnect ()
 Removes all connections to other HVACComponent objects. More...
 
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...
 
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 ()
 
- 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...
 
virtual ~ParentObject ()
 
- Public Member Functions inherited from openstudio::model::ModelObject
virtual ~ModelObject ()
 
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 (std::string valueName, std::string unitString) 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
 

Protected Types

typedef detail::Splitter_Impl ImplType
 
- Protected Types inherited from openstudio::model::HVACComponent
typedef detail::HVACComponent_Impl ImplType
 
- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl ImplType
 

Protected Member Functions

 Splitter (IddObjectType type, const Model &model)
 
 Splitter (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)
 

Additional Inherited Members

Member Typedef Documentation

typedef detail::Splitter_Impl openstudio::model::Splitter::ImplType
protected

Constructor & Destructor Documentation

virtual openstudio::model::Splitter::~Splitter ( )
inlinevirtual
openstudio::model::Splitter::Splitter ( IddObjectType  type,
const Model model 
)
protected
openstudio::model::Splitter::Splitter ( std::shared_ptr< ImplType impl)
explicitprotected

Member Function Documentation

virtual unsigned openstudio::model::Splitter::branchIndexForOutletModelObject ( ModelObject  modelObject) const
virtual

Returns the branch index for the ModelObject specified by modelObject.

The specified object must be connected to an outlet port of the splitter.

virtual boost::optional<ModelObject> openstudio::model::Splitter::inletModelObject ( ) const
virtual

Returns the optional ModelObject connected to the inlet port.

If there is no connected object then the optional will be false.

virtual unsigned openstudio::model::Splitter::inletPort ( ) const
virtual
bool openstudio::model::Splitter::isRemovable ( ) const
virtual boost::optional<ModelObject> openstudio::model::Splitter::lastOutletModelObject ( ) const
virtual

Returns the optional ModelObject connected to the last branch of the splitter.

If there are no connections to the splitter's outlet ports, then the optional will be false.

virtual unsigned openstudio::model::Splitter::newOutletPortAfterBranch ( unsigned  branchIndex)
virtual

Returns a new port after the branch specified by branchIndex.

virtual unsigned openstudio::model::Splitter::nextBranchIndex ( ) const
virtual

Returns the index of the next available branch.

virtual unsigned openstudio::model::Splitter::nextOutletPort ( ) const
virtual

Returns the next available outlet port.

This will be the first port with no connected objects

Reimplemented in openstudio::model::AirLoopHVACZoneSplitter, openstudio::model::AirLoopHVACSupplyPlenum, and openstudio::model::ConnectorSplitter.

virtual boost::optional<ModelObject> openstudio::model::Splitter::outletModelObject ( unsigned  branchIndex) const
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 std::vector<ModelObject> openstudio::model::Splitter::outletModelObjects ( ) const
virtual

Returns a vector of all objects connected to the splitter's outlet ports.

If no objects are connected to the splitter then an empty vector will be returned.

virtual unsigned openstudio::model::Splitter::outletPort ( unsigned  branchIndex) const
virtual

Returns the outlet port for branchIndex.

Branches consequtively indexed starting from 0.

Reimplemented in openstudio::model::AirLoopHVACSupplyPlenum, openstudio::model::AirLoopHVACZoneSplitter, and openstudio::model::ConnectorSplitter.

virtual void openstudio::model::Splitter::removePortForBranch ( unsigned  branchIndex)
virtual

Effectively disconnects anything connected to the outlet 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.