 |
OpenStudioCore:model |
|
OpenStudioCore:model |
#include "HVACComponent.hpp"
Public Member Functions | |
| bool | addToNode (Node &node) |
| bool | addToSplitter (Splitter &splitter) |
| boost::optional< AirLoopHVAC > | airLoopHVAC () const |
| boost::optional < AirLoopHVACOutdoorAirSystem > | airLoopHVACOutdoorAirSystem () const |
| boost::optional< HVACComponent > | containingHVACComponent () const |
| boost::optional < StraightComponent > | containingStraightComponent () const |
| boost::optional < ZoneHVACComponent > | containingZoneHVACComponent () const |
| void | disconnect () |
| bool | isRemovable () const |
| boost::optional< Loop > | loop () const |
| boost::optional< PlantLoop > | plantLoop () const |
| std::vector< IdfObject > | remove () |
| virtual | ~HVACComponent () |
Protected Types | |
| typedef detail::HVACComponent_Impl | ImplType |
Protected Member Functions | |
| virtual std::vector< ModelObject > | children () const |
| HVACComponent (IddObjectType type, const Model &model) | |
| HVACComponent (std::shared_ptr< ImplType > impl) | |
HVACComponent is the base class for objects related to HVAC systems.
HVACComponent provides the ability to connect multiple HVACComponents together through ports. Connections are directional and they are created by identifying a source HVACComponent and port as well as a target HVACComponent object and port. Once a connection is made, it is easy to access the HVACComponent connected to a particular port using the member functions of HVACComponent.
New Connections are made using the openstudio::model::Model::connect function.
Connections and ports together form similar functionality as EnergyPlus nodes, however a connection between ports is more general then a node connection in Energyplus. Indeed, in the OpenStudio model connections are used to describe what is a node connection in EnergyPlus, but connections can be applied to other contexts then just EnergyPlus nodes. OpenStudio's connections and ports can be used anytime one "component" can be arbitrarily connected to another "component". For example EnergyPlus EMS sensors and actuaters could be thought of as source and target ports, where a connection can be made between the two.
|
protected |
|
inlinevirtual |
|
protected |
Returns the optional ModelObject connected to this object's port.
Returns the optional Port on the connected object through which the connection to this object's port is made.
|
explicitprotected |
| bool openstudio::model::HVACComponent::addToNode | ( | Node & | node | ) |
Adds this object to a new system node and returns a boolean indicating if the addition was successful.
This method is reimplemented in many of the derived classes to do the right thing based on the context of the node a particular object is added to. For example if a specific HVACComoponent is not allowed on an air loop and this interface is used to attempt to add the HVAC component to a node on an air loop the method will return false and the object will not be added.
Normally, this method will add this HVAC component immediatly after the node specified. There are exceptions, such as when a component is dropped on an outlet node such as the supply outlet node of an air loop. In this case the method will do the only thing possible and add this component before the outlet node.
| bool openstudio::model::HVACComponent::addToSplitter | ( | Splitter & | splitter | ) |
Adds this object to a splitter by creating a new branch.
Returns true if the operation was succesfull.
This method is reimplemented in many of the derived class to do the right thing based on the context of the splitter a particular object is added to.
| boost::optional<AirLoopHVAC> openstudio::model::HVACComponent::airLoopHVAC | ( | ) | const |
Returns the optional AirLoopHVAC object that the HVAC component is attached to.
If the component is part of an outdoor air system, the containing AirLoopHVAC will be returned. If the HVAC component is not associated with an air loop then the optional will be false.
| boost::optional<AirLoopHVACOutdoorAirSystem> openstudio::model::HVACComponent::airLoopHVACOutdoorAirSystem | ( | ) | const |
Returns the optional AirLoopHVACOutdoorAirSystem that the HVAC component is attached to.
If the HVAC component is not associated with an outdoor air system then the optional will be false.
|
protectedvirtual |
Reimplemented in openstudio::model::ZoneHVACComponent.
| boost::optional<HVACComponent> openstudio::model::HVACComponent::containingHVACComponent | ( | ) | const |
EnergyPlus unitary equipment and air terminals are typically composed of other HVAC components.
This method returns any such component containing this component. In OpenStudio, AirLoopHVAC, PlantLoop, and AirLoopHVACOutdoorAirSystem are treated as systems, not unitary equipment, thus they are not returned by this method. See plantLoop(), airLoop(), and airLoopHVACOutdoorAirSystem() to access those systems.
| boost::optional<StraightComponent> openstudio::model::HVACComponent::containingStraightComponent | ( | ) | const |
| boost::optional<ZoneHVACComponent> openstudio::model::HVACComponent::containingZoneHVACComponent | ( | ) | const |
Returns any ZoneHVACComponent that contains this HVACComponent.
| void openstudio::model::HVACComponent::disconnect | ( | ) |
Removes all connections to other HVACComponent objects.
| bool openstudio::model::HVACComponent::isRemovable | ( | ) | const |
Indicates if the HVACComponent can be removed from the model.
One reason a component could not be removed is because it is attached to a loop and removing it would destroy the integrity of the loop. Zone splitters and mixers are examples of this, since they are required components of an air loop. In such a case, the HVACComponent must be disconnected before it can be removed.
| boost::optional<Loop> openstudio::model::HVACComponent::loop | ( | ) | const |
Returns the optional Loop object that the HVAC component is attached to.
If the component is part of an outdoor air system, the containing AirLoopHVAC will be returned. If the component is attached to multiple loops, the optional will be false.
| boost::optional<PlantLoop> openstudio::model::HVACComponent::plantLoop | ( | ) | const |
Returns the optional PlantLoop object that the HVAC component is attached to.
If the HVAC component is not associated with a plant loop then the optional will be false.
| std::vector<IdfObject> openstudio::model::HVACComponent::remove | ( | ) |
Removes the HVACComponent from the model only if isRemovable() return true.