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

#include <ZoneHVACUnitVentilator.hpp>

+ Inheritance diagram for openstudio::model::ZoneHVACUnitVentilator:

Public Member Functions

Constructors and Destructors
 ZoneHVACUnitVentilator (const Model &model)
 ZoneHVACUnitVentilator (const Model &model, const HVACComponent &supplyAirFan)
virtual ~ZoneHVACUnitVentilator ()
Schedule availabilitySchedule () const
boost::optional< double > maximumSupplyAirFlowRate () const
bool isMaximumSupplyAirFlowRateAutosized () const
std::string outdoorAirControlType () const
boost::optional< double > minimumOutdoorAirFlowRate () const
bool isMinimumOutdoorAirFlowRateAutosized () const
Schedule minimumOutdoorAirSchedule () const
boost::optional< double > maximumOutdoorAirFlowRate () const
bool isMaximumOutdoorAirFlowRateAutosized () const
Schedule maximumOutdoorAirFractionorTemperatureSchedule () const
HVACComponent supplyAirFan () const
boost::optional< SchedulesupplyAirFanOperatingModeSchedule () const
boost::optional< HVACComponentheatingCoil () const
double heatingConvergenceTolerance () const
boost::optional< HVACComponentcoolingCoil () const
double coolingConvergenceTolerance () const
bool setAvailabilitySchedule (Schedule &schedule)
bool setMaximumSupplyAirFlowRate (double maximumSupplyAirFlowRate)
void autosizeMaximumSupplyAirFlowRate ()
bool setOutdoorAirControlType (std::string outdoorAirControlType)
bool setMinimumOutdoorAirFlowRate (double minimumOutdoorAirFlowRate)
void autosizeMinimumOutdoorAirFlowRate ()
bool setMinimumOutdoorAirSchedule (Schedule &schedule)
bool setMaximumOutdoorAirFlowRate (double maximumOutdoorAirFlowRate)
void autosizeMaximumOutdoorAirFlowRate ()
bool setMaximumOutdoorAirFractionorTemperatureSchedule (Schedule &schedule)
bool setSupplyAirFan (const HVACComponent &supplyAirFan)
bool setSupplyAirFanOperatingModeSchedule (Schedule &schedule)
void resetSupplyAirFanOperatingModeSchedule ()
bool setHeatingCoil (const HVACComponent &heatingCoil)
void resetHeatingCoil ()
bool setHeatingConvergenceTolerance (double heatingConvergenceTolerance)
bool setCoolingCoil (const HVACComponent &coolingCoil)
void resetCoolingCoil ()
bool setCoolingConvergenceTolerance (double coolingConvergenceTolerance)
boost::optional< double > autosizedMaximumSupplyAirFlowRate () const
boost::optional< double > autosizedMinimumOutdoorAirFlowRate () const
boost::optional< double > autosizedMaximumOutdoorAirFlowRate () const
- Public Member Functions inherited from openstudio::model::ZoneHVACComponent
bool addToNode (Node &node)
 Adds this ZoneHVACComponent to a node on an AirLoopHVAC object. More...
bool addToThermalZone (ThermalZone &thermalZone)
 Adds this ZoneHVACComponent to the thermal zone while managing all node connections automatically. More...
boost::optional< ModelObjectairInletModelObject () const
 Provided for backwards compatibility, use inletNode instead. More...
boost::optional< AirLoopHVACairLoopHVAC () const
 Returns the AirLoopHVAC attached to this ZoneHVACComponent. More...
boost::optional< ModelObjectairOutletModelObject () const
 Provided for backwards compatibility, use outletNode instead. More...
boost::optional< NodeinletNode () const
 Returns the optional node connected to the inletPort(). More...
unsigned inletPort () const
 Returns the inlet port. More...
boost::optional< NodeoutletNode () const
 Returns the optional node connected to the outletPort(). More...
unsigned outletPort () const
 Returns the outlet port. More...
bool removeFromAirLoopHVAC ()
 If this ZoneHVACComponent is used as a supply component on an AirLoopHVAC system, then this method will detach this ZoneHVACComponent from the AirLoopHVAC system, otherwise this method does nothing. More...
void removeFromThermalZone ()
 Detaches this ZoneHVACComponent from the associated ThermalZone. More...
void removeReturnPlenum ()
 Remove any return plenum attached to this ZoneHVACComponent. More...
< AirLoopHVACReturnPlenum
returnPlenum () const
bool setReturnPlenum (const ThermalZone &plenumZone)
 Establish plenumZone as the return plenum for this ZoneHVACComponent. More...
virtual boost::optional
< ThermalZone
thermalZone () const
 Returns the optional ThermalZone that this ZoneHVACComponent is attached to. More...
virtual ~ZoneHVACComponent ()
- 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...
< 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...
< StraightComponent
containingStraightComponent () const
< 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...
< 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 IddObjectType iddObjectType ()
static std::vector< std::string > outdoorAirControlTypeValues ()

Related Functions

(Note that these are not member functions.)

typedef boost::optional
< ZoneHVACUnitVentilator
typedef std::vector
< ZoneHVACUnitVentilator

Additional Inherited Members

- Protected Types inherited from openstudio::model::ZoneHVACComponent
- 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::ZoneHVACComponent
virtual std::vector< ModelObjectchildren () const override
 ZoneHVACComponent (IddObjectType type, const Model &model)
 ZoneHVACComponent (std::shared_ptr< ImplType > impl)
- Protected Member Functions inherited from openstudio::model::HVACComponent
 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

ZoneHVACUnitVentilator is a ZoneHVACComponent that wraps the OpenStudio IDD object 'OS:ZoneHVAC:UnitVentilator'.

Constructor & Destructor Documentation

openstudio::model::ZoneHVACUnitVentilator::ZoneHVACUnitVentilator ( const Model model)
openstudio::model::ZoneHVACUnitVentilator::ZoneHVACUnitVentilator ( const Model model,
const HVACComponent supplyAirFan 
virtual openstudio::model::ZoneHVACUnitVentilator::~ZoneHVACUnitVentilator ( )

Member Function Documentation

boost::optional<double> openstudio::model::ZoneHVACUnitVentilator::autosizedMaximumOutdoorAirFlowRate ( ) const
boost::optional<double> openstudio::model::ZoneHVACUnitVentilator::autosizedMaximumSupplyAirFlowRate ( ) const
boost::optional<double> openstudio::model::ZoneHVACUnitVentilator::autosizedMinimumOutdoorAirFlowRate ( ) const
void openstudio::model::ZoneHVACUnitVentilator::autosizeMaximumOutdoorAirFlowRate ( )
void openstudio::model::ZoneHVACUnitVentilator::autosizeMaximumSupplyAirFlowRate ( )
void openstudio::model::ZoneHVACUnitVentilator::autosizeMinimumOutdoorAirFlowRate ( )
Schedule openstudio::model::ZoneHVACUnitVentilator::availabilitySchedule ( ) const
boost::optional<HVACComponent> openstudio::model::ZoneHVACUnitVentilator::coolingCoil ( ) const
double openstudio::model::ZoneHVACUnitVentilator::coolingConvergenceTolerance ( ) const
boost::optional<HVACComponent> openstudio::model::ZoneHVACUnitVentilator::heatingCoil ( ) const
double openstudio::model::ZoneHVACUnitVentilator::heatingConvergenceTolerance ( ) const
static IddObjectType openstudio::model::ZoneHVACUnitVentilator::iddObjectType ( )
bool openstudio::model::ZoneHVACUnitVentilator::isMaximumOutdoorAirFlowRateAutosized ( ) const
bool openstudio::model::ZoneHVACUnitVentilator::isMaximumSupplyAirFlowRateAutosized ( ) const
bool openstudio::model::ZoneHVACUnitVentilator::isMinimumOutdoorAirFlowRateAutosized ( ) const
boost::optional<double> openstudio::model::ZoneHVACUnitVentilator::maximumOutdoorAirFlowRate ( ) const
Schedule openstudio::model::ZoneHVACUnitVentilator::maximumOutdoorAirFractionorTemperatureSchedule ( ) const
boost::optional<double> openstudio::model::ZoneHVACUnitVentilator::maximumSupplyAirFlowRate ( ) const
boost::optional<double> openstudio::model::ZoneHVACUnitVentilator::minimumOutdoorAirFlowRate ( ) const
Schedule openstudio::model::ZoneHVACUnitVentilator::minimumOutdoorAirSchedule ( ) const
std::string openstudio::model::ZoneHVACUnitVentilator::outdoorAirControlType ( ) const
static std::vector<std::string> openstudio::model::ZoneHVACUnitVentilator::outdoorAirControlTypeValues ( )
void openstudio::model::ZoneHVACUnitVentilator::resetCoolingCoil ( )
void openstudio::model::ZoneHVACUnitVentilator::resetHeatingCoil ( )
void openstudio::model::ZoneHVACUnitVentilator::resetSupplyAirFanOperatingModeSchedule ( )
bool openstudio::model::ZoneHVACUnitVentilator::setAvailabilitySchedule ( Schedule schedule)
bool openstudio::model::ZoneHVACUnitVentilator::setCoolingCoil ( const HVACComponent coolingCoil)
bool openstudio::model::ZoneHVACUnitVentilator::setCoolingConvergenceTolerance ( double  coolingConvergenceTolerance)
bool openstudio::model::ZoneHVACUnitVentilator::setHeatingCoil ( const HVACComponent heatingCoil)
bool openstudio::model::ZoneHVACUnitVentilator::setHeatingConvergenceTolerance ( double  heatingConvergenceTolerance)
bool openstudio::model::ZoneHVACUnitVentilator::setMaximumOutdoorAirFlowRate ( double  maximumOutdoorAirFlowRate)
bool openstudio::model::ZoneHVACUnitVentilator::setMaximumOutdoorAirFractionorTemperatureSchedule ( Schedule schedule)
bool openstudio::model::ZoneHVACUnitVentilator::setMaximumSupplyAirFlowRate ( double  maximumSupplyAirFlowRate)
bool openstudio::model::ZoneHVACUnitVentilator::setMinimumOutdoorAirFlowRate ( double  minimumOutdoorAirFlowRate)
bool openstudio::model::ZoneHVACUnitVentilator::setMinimumOutdoorAirSchedule ( Schedule schedule)
bool openstudio::model::ZoneHVACUnitVentilator::setOutdoorAirControlType ( std::string  outdoorAirControlType)
bool openstudio::model::ZoneHVACUnitVentilator::setSupplyAirFan ( const HVACComponent supplyAirFan)
bool openstudio::model::ZoneHVACUnitVentilator::setSupplyAirFanOperatingModeSchedule ( Schedule schedule)
HVACComponent openstudio::model::ZoneHVACUnitVentilator::supplyAirFan ( ) const
boost::optional<Schedule> openstudio::model::ZoneHVACUnitVentilator::supplyAirFanOperatingModeSchedule ( ) const

Friends And Related Function Documentation

typedef boost::optional<ZoneHVACUnitVentilator> OptionalZoneHVACUnitVentilator