OpenStudio:model
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Public Member Functions | Static Public Member Functions | Related Functions | List of all members
openstudio::model::HeatExchangerAirToAirSensibleAndLatent Class Reference

#include <HeatExchangerAirToAirSensibleAndLatent.hpp>

+ Inheritance diagram for openstudio::model::HeatExchangerAirToAirSensibleAndLatent:

Public Member Functions

boost::optional
< AirflowNetworkEquivalentDuct
airflowNetworkEquivalentDuct () const
 
boost::optional< double > autosizedNominalSupplyAirFlowRate () const
 
void autosizeNominalSupplyAirFlowRate ()
 
Schedule availabilitySchedule () const
 
bool economizerLockout () const
 
std::string frostControlType () const
 
AirflowNetworkEquivalentDuct getAirflowNetworkEquivalentDuct (double length, double diameter)
 
 HeatExchangerAirToAirSensibleAndLatent (const Model &model)
 
std::string heatExchangerType () const
 
boost::optional< double > initialDefrostTimeFraction () const
 
bool isNominalSupplyAirFlowRateAutosized () const
 
bool isThresholdTemperatureDefaulted () const
 
double latentEffectivenessat100CoolingAirFlow () const
 
double latentEffectivenessat100HeatingAirFlow () const
 
double latentEffectivenessat75CoolingAirFlow () const
 
double latentEffectivenessat75HeatingAirFlow () const
 
double nominalElectricPower () const
 
boost::optional< double > nominalSupplyAirFlowRate () const
 
boost::optional< double > rateofDefrostTimeFractionIncrease () const
 
void resetInitialDefrostTimeFraction ()
 
void resetRateofDefrostTimeFractionIncrease ()
 
void resetThresholdTemperature ()
 
double sensibleEffectivenessat100CoolingAirFlow () const
 
double sensibleEffectivenessat100HeatingAirFlow () const
 
double sensibleEffectivenessat75CoolingAirFlow () const
 
double sensibleEffectivenessat75HeatingAirFlow () const
 
bool setAvailabilitySchedule (Schedule &schedule)
 
bool setEconomizerLockout (bool economizerLockout)
 
bool setFrostControlType (std::string frostControlType)
 
bool setHeatExchangerType (std::string heatExchangerType)
 
bool setInitialDefrostTimeFraction (double initialDefrostTimeFraction)
 
bool setLatentEffectivenessat100CoolingAirFlow (double latentEffectivenessat100CoolingAirFlow)
 
bool setLatentEffectivenessat100HeatingAirFlow (double latentEffectivenessat100HeatingAirFlow)
 
bool setLatentEffectivenessat75CoolingAirFlow (double latentEffectivenessat75CoolingAirFlow)
 
bool setLatentEffectivenessat75HeatingAirFlow (double latentEffectivenessat75HeatingAirFlow)
 
bool setNominalElectricPower (double nominalElectricPower)
 
bool setNominalSupplyAirFlowRate (double nominalSupplyAirFlowRate)
 
bool setRateofDefrostTimeFractionIncrease (double rateofDefrostTimeFractionIncrease)
 
bool setSensibleEffectivenessat100CoolingAirFlow (double sensibleEffectivenessat100CoolingAirFlow)
 
bool setSensibleEffectivenessat100HeatingAirFlow (double sensibleEffectivenessat100HeatingAirFlow)
 
bool setSensibleEffectivenessat75CoolingAirFlow (double sensibleEffectivenessat75CoolingAirFlow)
 
bool setSensibleEffectivenessat75HeatingAirFlow (double sensibleEffectivenessat75HeatingAirFlow)
 
bool setSupplyAirOutletTemperatureControl (bool supplyAirOutletTemperatureControl)
 
bool setThresholdTemperature (double thresholdTemperature)
 
bool supplyAirOutletTemperatureControl () const
 
double thresholdTemperature () const
 
virtual ~HeatExchangerAirToAirSensibleAndLatent ()
 
- Public Member Functions inherited from openstudio::model::AirToAirComponent
bool addToNode (Node &node)
 
 AirToAirComponent (IddObjectType type, const Model &model)
 
ModelObject clone (Model model) const
 
boost::optional< ModelObjectprimaryAirInletModelObject () 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< ModelObjectprimaryAirOutletModelObject () 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< ModelObjectsecondaryAirInletModelObject () 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< ModelObjectsecondaryAirOutletModelObject () 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< 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...
 
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 std::vector< std::string > frostControlTypeValues ()
 
static std::vector< std::string > heatExchangerTypeValues ()
 
static IddObjectType iddObjectType ()
 

Related Functions

(Note that these are not member functions.)

typedef std::vector
< HeatExchangerAirToAirSensibleAndLatent
HeatExchangerAirToAirSensibleAndLatentVector
 
typedef boost::optional
< HeatExchangerAirToAirSensibleAndLatent
OptionalHeatExchangerAirToAirSensibleAndLatent
 

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< 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)
 

Detailed Description

HeatExchangerAirToAirSensibleAndLatent is a AirToAirComponent that wraps the OpenStudio IDD object 'OS:HeatExchanger:AirToAir:SensibleAndLatent'.

Constructor & Destructor Documentation

openstudio::model::HeatExchangerAirToAirSensibleAndLatent::HeatExchangerAirToAirSensibleAndLatent ( const Model model)
explicit
virtual openstudio::model::HeatExchangerAirToAirSensibleAndLatent::~HeatExchangerAirToAirSensibleAndLatent ( )
inlinevirtual

Member Function Documentation

boost::optional<AirflowNetworkEquivalentDuct> openstudio::model::HeatExchangerAirToAirSensibleAndLatent::airflowNetworkEquivalentDuct ( ) const
boost::optional<double> openstudio::model::HeatExchangerAirToAirSensibleAndLatent::autosizedNominalSupplyAirFlowRate ( ) const
void openstudio::model::HeatExchangerAirToAirSensibleAndLatent::autosizeNominalSupplyAirFlowRate ( )
Schedule openstudio::model::HeatExchangerAirToAirSensibleAndLatent::availabilitySchedule ( ) const
bool openstudio::model::HeatExchangerAirToAirSensibleAndLatent::economizerLockout ( ) const
std::string openstudio::model::HeatExchangerAirToAirSensibleAndLatent::frostControlType ( ) const
static std::vector<std::string> openstudio::model::HeatExchangerAirToAirSensibleAndLatent::frostControlTypeValues ( )
static
AirflowNetworkEquivalentDuct openstudio::model::HeatExchangerAirToAirSensibleAndLatent::getAirflowNetworkEquivalentDuct ( double  length,
double  diameter 
)
std::string openstudio::model::HeatExchangerAirToAirSensibleAndLatent::heatExchangerType ( ) const
static std::vector<std::string> openstudio::model::HeatExchangerAirToAirSensibleAndLatent::heatExchangerTypeValues ( )
static
static IddObjectType openstudio::model::HeatExchangerAirToAirSensibleAndLatent::iddObjectType ( )
static
boost::optional<double> openstudio::model::HeatExchangerAirToAirSensibleAndLatent::initialDefrostTimeFraction ( ) const
bool openstudio::model::HeatExchangerAirToAirSensibleAndLatent::isNominalSupplyAirFlowRateAutosized ( ) const
bool openstudio::model::HeatExchangerAirToAirSensibleAndLatent::isThresholdTemperatureDefaulted ( ) const
double openstudio::model::HeatExchangerAirToAirSensibleAndLatent::latentEffectivenessat100CoolingAirFlow ( ) const
double openstudio::model::HeatExchangerAirToAirSensibleAndLatent::latentEffectivenessat100HeatingAirFlow ( ) const
double openstudio::model::HeatExchangerAirToAirSensibleAndLatent::latentEffectivenessat75CoolingAirFlow ( ) const
double openstudio::model::HeatExchangerAirToAirSensibleAndLatent::latentEffectivenessat75HeatingAirFlow ( ) const
double openstudio::model::HeatExchangerAirToAirSensibleAndLatent::nominalElectricPower ( ) const
boost::optional<double> openstudio::model::HeatExchangerAirToAirSensibleAndLatent::nominalSupplyAirFlowRate ( ) const
boost::optional<double> openstudio::model::HeatExchangerAirToAirSensibleAndLatent::rateofDefrostTimeFractionIncrease ( ) const
void openstudio::model::HeatExchangerAirToAirSensibleAndLatent::resetInitialDefrostTimeFraction ( )
void openstudio::model::HeatExchangerAirToAirSensibleAndLatent::resetRateofDefrostTimeFractionIncrease ( )
void openstudio::model::HeatExchangerAirToAirSensibleAndLatent::resetThresholdTemperature ( )
double openstudio::model::HeatExchangerAirToAirSensibleAndLatent::sensibleEffectivenessat100CoolingAirFlow ( ) const
double openstudio::model::HeatExchangerAirToAirSensibleAndLatent::sensibleEffectivenessat100HeatingAirFlow ( ) const
double openstudio::model::HeatExchangerAirToAirSensibleAndLatent::sensibleEffectivenessat75CoolingAirFlow ( ) const
double openstudio::model::HeatExchangerAirToAirSensibleAndLatent::sensibleEffectivenessat75HeatingAirFlow ( ) const
bool openstudio::model::HeatExchangerAirToAirSensibleAndLatent::setAvailabilitySchedule ( Schedule schedule)
bool openstudio::model::HeatExchangerAirToAirSensibleAndLatent::setEconomizerLockout ( bool  economizerLockout)
bool openstudio::model::HeatExchangerAirToAirSensibleAndLatent::setFrostControlType ( std::string  frostControlType)
bool openstudio::model::HeatExchangerAirToAirSensibleAndLatent::setHeatExchangerType ( std::string  heatExchangerType)
bool openstudio::model::HeatExchangerAirToAirSensibleAndLatent::setInitialDefrostTimeFraction ( double  initialDefrostTimeFraction)
bool openstudio::model::HeatExchangerAirToAirSensibleAndLatent::setLatentEffectivenessat100CoolingAirFlow ( double  latentEffectivenessat100CoolingAirFlow)
bool openstudio::model::HeatExchangerAirToAirSensibleAndLatent::setLatentEffectivenessat100HeatingAirFlow ( double  latentEffectivenessat100HeatingAirFlow)
bool openstudio::model::HeatExchangerAirToAirSensibleAndLatent::setLatentEffectivenessat75CoolingAirFlow ( double  latentEffectivenessat75CoolingAirFlow)
bool openstudio::model::HeatExchangerAirToAirSensibleAndLatent::setLatentEffectivenessat75HeatingAirFlow ( double  latentEffectivenessat75HeatingAirFlow)
bool openstudio::model::HeatExchangerAirToAirSensibleAndLatent::setNominalElectricPower ( double  nominalElectricPower)
bool openstudio::model::HeatExchangerAirToAirSensibleAndLatent::setNominalSupplyAirFlowRate ( double  nominalSupplyAirFlowRate)
bool openstudio::model::HeatExchangerAirToAirSensibleAndLatent::setRateofDefrostTimeFractionIncrease ( double  rateofDefrostTimeFractionIncrease)
bool openstudio::model::HeatExchangerAirToAirSensibleAndLatent::setSensibleEffectivenessat100CoolingAirFlow ( double  sensibleEffectivenessat100CoolingAirFlow)
bool openstudio::model::HeatExchangerAirToAirSensibleAndLatent::setSensibleEffectivenessat100HeatingAirFlow ( double  sensibleEffectivenessat100HeatingAirFlow)
bool openstudio::model::HeatExchangerAirToAirSensibleAndLatent::setSensibleEffectivenessat75CoolingAirFlow ( double  sensibleEffectivenessat75CoolingAirFlow)
bool openstudio::model::HeatExchangerAirToAirSensibleAndLatent::setSensibleEffectivenessat75HeatingAirFlow ( double  sensibleEffectivenessat75HeatingAirFlow)
bool openstudio::model::HeatExchangerAirToAirSensibleAndLatent::setSupplyAirOutletTemperatureControl ( bool  supplyAirOutletTemperatureControl)
bool openstudio::model::HeatExchangerAirToAirSensibleAndLatent::setThresholdTemperature ( double  thresholdTemperature)
bool openstudio::model::HeatExchangerAirToAirSensibleAndLatent::supplyAirOutletTemperatureControl ( ) const
double openstudio::model::HeatExchangerAirToAirSensibleAndLatent::thresholdTemperature ( ) const

Friends And Related Function Documentation