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::ConnectorSplitter Class Reference

#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)
 Constructs a new Splitter object and places it inside the model. More...
 
unsigned inletPort () const override
 Returns the inlet port to the splitter. More...
 
unsigned nextOutletPort () const override
 Returns the next available outlet port. More...
 
unsigned outletPort (unsigned branchIndex) const override
 Returns the outlet port for branchIndex. More...
 
virtual std::vector
< openstudio::IdfObject > 
remove ()
 
virtual ~ConnectorSplitter ()
 
- Public Member Functions inherited from openstudio::model::Splitter
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...
 
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 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 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
 

Static Public Member Functions

static IddObjectType iddObjectType ()
 

Protected Types

typedef
detail::ConnectorSplitter_Impl 
ImplType
 
- Protected Types inherited from openstudio::model::Splitter
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

 ConnectorSplitter (std::shared_ptr< detail::ConnectorSplitter_Impl > impl)
 
- Protected Member Functions inherited from openstudio::model::Splitter
 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)
 

Related Functions

(Note that these are not member 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