 |
OpenStudio:model |
#include <AirToAirComponent.hpp>
Inheritance diagram for openstudio::model::AirToAirComponent:Public Member Functions | |
| bool | addToNode (Node &node) |
| AirToAirComponent (IddObjectType type, const Model &model) | |
| ModelObject | clone (Model model) const |
| boost::optional< ModelObject > | primaryAirInletModelObject () const |
| Returns the optional ModelObject connected to the primary air stream inlet port. More... | |
| unsigned | primaryAirInletPort () const |
| Returns the primary air stream inlet port. More... | |
| boost::optional< ModelObject > | primaryAirOutletModelObject () const |
| Returns the optional ModelObject connected to the primary air stream outlet port. More... | |
| unsigned | primaryAirOutletPort () const |
| Returns the primary air stream outlet port. More... | |
| std::vector < openstudio::IdfObject > | remove () |
| boost::optional< ModelObject > | secondaryAirInletModelObject () const |
| Returns the optional ModelObject connected to the secondary air stream inlet port. More... | |
| unsigned | secondaryAirInletPort () const |
| Returns the secondary air stream inlet port. More... | |
| boost::optional< ModelObject > | secondaryAirOutletModelObject () const |
| Returns the optional ModelObject connected to the secondary air stream outlet port. More... | |
| unsigned | secondaryAirOutletPort () const |
| Returns the secondary air stream outlet port. More... | |
| virtual | ~AirToAirComponent () |
| 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... | |
| void | applySizingValues () |
| void | autosize () |
| Returns the optional ModelObject connected to this object's port. More... | |
| 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... | |
| 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< Loop > | loop () const |
| Returns the optional Loop object that the HVAC component is attached to. More... | |
| 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 () |
| 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... | |
| 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< 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 (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< ModelObject > | connectedObject (unsigned port) const |
| boost::optional< unsigned > | connectedObjectPort (unsigned port) const |
Additional Inherited Members | |
| 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 inherited from openstudio::model::HVACComponent | |
| virtual std::vector< ModelObject > | children () 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 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... | |
AirToAirComponent is the base class for model objects which interact with two air streams.
These objects are typically heat recovery devices such as the EnergyPlus IDD object named HeatExchanger:AirToAir:SensibleAndLatent.
| openstudio::model::AirToAirComponent::AirToAirComponent | ( | IddObjectType | type, |
| const Model & | model | ||
| ) |
|
inlinevirtual |
| bool openstudio::model::AirToAirComponent::addToNode | ( | Node & | node | ) |
| ModelObject openstudio::model::AirToAirComponent::clone | ( | Model | model | ) | const |
| boost::optional<ModelObject> openstudio::model::AirToAirComponent::primaryAirInletModelObject | ( | ) | const |
Returns the optional ModelObject connected to the primary air stream inlet port.
| unsigned openstudio::model::AirToAirComponent::primaryAirInletPort | ( | ) | const |
Returns the primary air stream inlet port.
In the conext of air to air heat recovery devices in EnergyPlus, the primary air stream is often thought of as the supply side air stream which is the supply of outdoor air into the system.
| boost::optional<ModelObject> openstudio::model::AirToAirComponent::primaryAirOutletModelObject | ( | ) | const |
Returns the optional ModelObject connected to the primary air stream outlet port.
| unsigned openstudio::model::AirToAirComponent::primaryAirOutletPort | ( | ) | const |
Returns the primary air stream outlet port.
| std::vector<openstudio::IdfObject> openstudio::model::AirToAirComponent::remove | ( | ) |
| boost::optional<ModelObject> openstudio::model::AirToAirComponent::secondaryAirInletModelObject | ( | ) | const |
Returns the optional ModelObject connected to the secondary air stream inlet port.
| unsigned openstudio::model::AirToAirComponent::secondaryAirInletPort | ( | ) | const |
Returns the secondary air stream inlet port.
In the context of air to air heat recovery devices in EnergyPlus, the secondary air stream is often the exhaust air stream leaving the system.
| boost::optional<ModelObject> openstudio::model::AirToAirComponent::secondaryAirOutletModelObject | ( | ) | const |
Returns the optional ModelObject connected to the secondary air stream outlet port.
| unsigned openstudio::model::AirToAirComponent::secondaryAirOutletPort | ( | ) | const |
Returns the secondary air stream outlet port.