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

#include <AirflowNetworkZone.hpp>

+ Inheritance diagram for openstudio::model::AirflowNetworkZone:

Public Member Functions

Constructors and Destructors
virtual ~AirflowNetworkZone ()
 
Getters
ThermalZone thermalZone () const
 Returns the associated thermal zone. More...
 
std::string ventilationControlMode () const
 Returns the ventilation control mode. More...
 
bool isVentilationControlModeDefaulted () const
 Returns true if the ventilation control mode is defaulted. More...
 
boost::optional< ScheduleventilationControlZoneTemperatureSetpointSchedule () const
 Returns the ventilation control zone temperature setpoint schedule, if any. More...
 
double minimumVentingOpenFactor () const
 Returns the minimum venting open factor. More...
 
bool isMinimumVentingOpenFactorDefaulted () const
 Returns true if the minimum venting open factor is defaulted. More...
 
double indoorandOutdoorTemperatureDifferenceLowerLimitForMaximumVentingOpenFactor () const
 Returns the temperature difference lower limit for maximum venting factor. More...
 
bool isIndoorandOutdoorTemperatureDifferenceLowerLimitForMaximumVentingOpenFactorDefaulted () const
 Returns true if the temperature difference lower limit for maximum venting factor is defaulted. More...
 
double indoorandOutdoorTemperatureDifferenceUpperLimitforMinimumVentingOpenFactor () const
 Returns the temperature difference upper limit for minimum venting factor. More...
 
bool isIndoorandOutdoorTemperatureDifferenceUpperLimitforMinimumVentingOpenFactorDefaulted () const
 Returns true if the temperature difference upper limit for minimum venting factor is defaulted. More...
 
double indoorandOutdoorEnthalpyDifferenceLowerLimitForMaximumVentingOpenFactor () const
 Returns the enthalpy difference lower limit for maximum venting factor. More...
 
bool isIndoorandOutdoorEnthalpyDifferenceLowerLimitForMaximumVentingOpenFactorDefaulted () const
 Returns true if the enthalpy difference lower limit for maximum venting factor is defaulted. More...
 
double indoorandOutdoorEnthalpyDifferenceUpperLimitforMinimumVentingOpenFactor () const
 Returns the enthalpy difference upper limit for minimum venting factor. More...
 
bool isIndoorandOutdoorEnthalpyDifferenceUpperLimitforMinimumVentingOpenFactorDefaulted () const
 Returns true if the enthalpy difference upper limit for minimum venting factor is defaulted. More...
 
boost::optional< ScheduleventingAvailabilitySchedule () const
 Returns the venting availability schedule, if any. More...
 
std::string singleSidedWindPressureCoefficientAlgorithm () const
 Returns the single sided wind pressure algorithm. More...
 
bool isSingleSidedWindPressureCoefficientAlgorithmDefaulted () const
 Returns true if the single sided wind pressure algorithm is defaulted. More...
 
double facadeWidth () const
 Returns the single sided wind pressure algorithm facade width. More...
 
bool isFacadeWidthDefaulted () const
 Returns true if the single sided wind pressure algorithm facade width is defaulted. More...
 
boost::optional
< AirflowNetworkOccupantVentilationControl
occupantVentilationControl () const
 Returns the occupant ventilation control object for this zone, if any. More...
 
Setters
bool setVentilationControlMode (const std::string &ventilationControlMode)
 Sets the ventilation control mode. More...
 
void resetVentilationControlMode ()
 Resets the ventilation control mode. More...
 
bool setVentilationControlZoneTemperatureSetpointSchedule (Schedule &schedule)
 Sets the ventilation control zone temperature setpoint schedule. More...
 
void resetVentilationControlZoneTemperatureSetpointSchedule ()
 Resets the ventilation control zone temperature setpoint schedule. More...
 
bool setMinimumVentingOpenFactor (double minimumVentingOpenFactor)
 Sets the minimum venting open factor. More...
 
void resetMinimumVentingOpenFactor ()
 Resets the minimum venting open factor. More...
 
bool setIndoorandOutdoorTemperatureDifferenceLowerLimitForMaximumVentingOpenFactor (double indoorandOutdoorTemperatureDifferenceLowerLimitForMaximumVentingOpenFactor)
 Sets the temperature difference lower limit for maximum venting factor. More...
 
void resetIndoorandOutdoorTemperatureDifferenceLowerLimitForMaximumVentingOpenFactor ()
 Resets the temperature difference lower limit for maximum venting factor. More...
 
bool setIndoorandOutdoorTemperatureDifferenceUpperLimitforMinimumVentingOpenFactor (double indoorandOutdoorTemperatureDifferenceUpperLimitforMinimumVentingOpenFactor)
 Sets the temperature difference upper limit for minimum venting factor. More...
 
void resetIndoorandOutdoorTemperatureDifferenceUpperLimitforMinimumVentingOpenFactor ()
 Resets the temperature difference upper limit for minimum venting factor. More...
 
bool setIndoorandOutdoorEnthalpyDifferenceLowerLimitForMaximumVentingOpenFactor (double indoorandOutdoorEnthalpyDifferenceLowerLimitForMaximumVentingOpenFactor)
 Sets the enthalpy difference lower limit for maximum venting factor. More...
 
void resetIndoorandOutdoorEnthalpyDifferenceLowerLimitForMaximumVentingOpenFactor ()
 Resets the enthalpy difference lower limit for maximum venting factor. More...
 
bool setIndoorandOutdoorEnthalpyDifferenceUpperLimitforMinimumVentingOpenFactor (double indoorandOutdoorEnthalpyDifferenceUpperLimitforMinimumVentingOpenFactor)
 Sets the enthalphy difference upper limit for minimum venting factor. More...
 
void resetIndoorandOutdoorEnthalpyDifferenceUpperLimitforMinimumVentingOpenFactor ()
 Resets the enthalphy difference upper limit for minimum venting factor. More...
 
bool setVentingAvailabilitySchedule (Schedule &schedule)
 Sets the venting availability schedule. More...
 
void resetVentingAvailabilitySchedule ()
 Resets the venting availability schedule. More...
 
bool setSingleSidedWindPressureCoefficientAlgorithm (const std::string &singleSidedWindPressureCoefficientAlgorithm)
 Sets the single sided wind pressure algorithm. More...
 
void resetSingleSidedWindPressureCoefficientAlgorithm ()
 Resets the single sided wind pressure algorithm. More...
 
bool setFacadeWidth (double facadeWidth)
 Sets the single sided wind pressure algorithm facade width. More...
 
void resetFacadeWidth ()
 Resets the single sided wind pressure algorithm facade width. More...
 
bool setOccupantVentilationControl (const AirflowNetworkOccupantVentilationControl &airflowNetworkOccupantVentilationControl)
 Sets the occupant ventilation control object for this zone. More...
 
void resetOccupantVentilationControl ()
 Resets the occupant ventilation control object. More...
 
- Public Member Functions inherited from openstudio::model::AirflowNetworkNode
 AirflowNetworkNode (IddObjectType type, const Model &model)
 
virtual ~AirflowNetworkNode ()
 
- 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 ()
 
static std::vector< std::string > singleSidedWindPressureCoefficientAlgorithmValues ()
 
static std::vector< std::string > ventilationControlModeValues ()
 

Related Functions

(Note that these are not member functions.)

typedef std::vector
< AirflowNetworkZone
AirflowNetworkZoneVector
 
typedef boost::optional
< AirflowNetworkZone
OptionalAirflowNetworkZone
 

Additional Inherited Members

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

AirflowNetworkZone is a AirflowNetworkNode that wraps the OpenStudio IDD object 'OS:AirflowNetworkZone'.

Constructor & Destructor Documentation

virtual openstudio::model::AirflowNetworkZone::~AirflowNetworkZone ( )
inlinevirtual

Member Function Documentation

double openstudio::model::AirflowNetworkZone::facadeWidth ( ) const

Returns the single sided wind pressure algorithm facade width.

static IddObjectType openstudio::model::AirflowNetworkZone::iddObjectType ( )
static
double openstudio::model::AirflowNetworkZone::indoorandOutdoorEnthalpyDifferenceLowerLimitForMaximumVentingOpenFactor ( ) const

Returns the enthalpy difference lower limit for maximum venting factor.

double openstudio::model::AirflowNetworkZone::indoorandOutdoorEnthalpyDifferenceUpperLimitforMinimumVentingOpenFactor ( ) const

Returns the enthalpy difference upper limit for minimum venting factor.

double openstudio::model::AirflowNetworkZone::indoorandOutdoorTemperatureDifferenceLowerLimitForMaximumVentingOpenFactor ( ) const

Returns the temperature difference lower limit for maximum venting factor.

double openstudio::model::AirflowNetworkZone::indoorandOutdoorTemperatureDifferenceUpperLimitforMinimumVentingOpenFactor ( ) const

Returns the temperature difference upper limit for minimum venting factor.

bool openstudio::model::AirflowNetworkZone::isFacadeWidthDefaulted ( ) const

Returns true if the single sided wind pressure algorithm facade width is defaulted.

bool openstudio::model::AirflowNetworkZone::isIndoorandOutdoorEnthalpyDifferenceLowerLimitForMaximumVentingOpenFactorDefaulted ( ) const

Returns true if the enthalpy difference lower limit for maximum venting factor is defaulted.

bool openstudio::model::AirflowNetworkZone::isIndoorandOutdoorEnthalpyDifferenceUpperLimitforMinimumVentingOpenFactorDefaulted ( ) const

Returns true if the enthalpy difference upper limit for minimum venting factor is defaulted.

bool openstudio::model::AirflowNetworkZone::isIndoorandOutdoorTemperatureDifferenceLowerLimitForMaximumVentingOpenFactorDefaulted ( ) const

Returns true if the temperature difference lower limit for maximum venting factor is defaulted.

bool openstudio::model::AirflowNetworkZone::isIndoorandOutdoorTemperatureDifferenceUpperLimitforMinimumVentingOpenFactorDefaulted ( ) const

Returns true if the temperature difference upper limit for minimum venting factor is defaulted.

bool openstudio::model::AirflowNetworkZone::isMinimumVentingOpenFactorDefaulted ( ) const

Returns true if the minimum venting open factor is defaulted.

bool openstudio::model::AirflowNetworkZone::isSingleSidedWindPressureCoefficientAlgorithmDefaulted ( ) const

Returns true if the single sided wind pressure algorithm is defaulted.

bool openstudio::model::AirflowNetworkZone::isVentilationControlModeDefaulted ( ) const

Returns true if the ventilation control mode is defaulted.

double openstudio::model::AirflowNetworkZone::minimumVentingOpenFactor ( ) const

Returns the minimum venting open factor.

boost::optional<AirflowNetworkOccupantVentilationControl> openstudio::model::AirflowNetworkZone::occupantVentilationControl ( ) const

Returns the occupant ventilation control object for this zone, if any.

void openstudio::model::AirflowNetworkZone::resetFacadeWidth ( )

Resets the single sided wind pressure algorithm facade width.

void openstudio::model::AirflowNetworkZone::resetIndoorandOutdoorEnthalpyDifferenceLowerLimitForMaximumVentingOpenFactor ( )

Resets the enthalpy difference lower limit for maximum venting factor.

void openstudio::model::AirflowNetworkZone::resetIndoorandOutdoorEnthalpyDifferenceUpperLimitforMinimumVentingOpenFactor ( )

Resets the enthalphy difference upper limit for minimum venting factor.

void openstudio::model::AirflowNetworkZone::resetIndoorandOutdoorTemperatureDifferenceLowerLimitForMaximumVentingOpenFactor ( )

Resets the temperature difference lower limit for maximum venting factor.

void openstudio::model::AirflowNetworkZone::resetIndoorandOutdoorTemperatureDifferenceUpperLimitforMinimumVentingOpenFactor ( )

Resets the temperature difference upper limit for minimum venting factor.

void openstudio::model::AirflowNetworkZone::resetMinimumVentingOpenFactor ( )

Resets the minimum venting open factor.

void openstudio::model::AirflowNetworkZone::resetOccupantVentilationControl ( )

Resets the occupant ventilation control object.

void openstudio::model::AirflowNetworkZone::resetSingleSidedWindPressureCoefficientAlgorithm ( )

Resets the single sided wind pressure algorithm.

void openstudio::model::AirflowNetworkZone::resetVentilationControlMode ( )

Resets the ventilation control mode.

void openstudio::model::AirflowNetworkZone::resetVentilationControlZoneTemperatureSetpointSchedule ( )

Resets the ventilation control zone temperature setpoint schedule.

void openstudio::model::AirflowNetworkZone::resetVentingAvailabilitySchedule ( )

Resets the venting availability schedule.

bool openstudio::model::AirflowNetworkZone::setFacadeWidth ( double  facadeWidth)

Sets the single sided wind pressure algorithm facade width.

bool openstudio::model::AirflowNetworkZone::setIndoorandOutdoorEnthalpyDifferenceLowerLimitForMaximumVentingOpenFactor ( double  indoorandOutdoorEnthalpyDifferenceLowerLimitForMaximumVentingOpenFactor)

Sets the enthalpy difference lower limit for maximum venting factor.

bool openstudio::model::AirflowNetworkZone::setIndoorandOutdoorEnthalpyDifferenceUpperLimitforMinimumVentingOpenFactor ( double  indoorandOutdoorEnthalpyDifferenceUpperLimitforMinimumVentingOpenFactor)

Sets the enthalphy difference upper limit for minimum venting factor.

bool openstudio::model::AirflowNetworkZone::setIndoorandOutdoorTemperatureDifferenceLowerLimitForMaximumVentingOpenFactor ( double  indoorandOutdoorTemperatureDifferenceLowerLimitForMaximumVentingOpenFactor)

Sets the temperature difference lower limit for maximum venting factor.

bool openstudio::model::AirflowNetworkZone::setIndoorandOutdoorTemperatureDifferenceUpperLimitforMinimumVentingOpenFactor ( double  indoorandOutdoorTemperatureDifferenceUpperLimitforMinimumVentingOpenFactor)

Sets the temperature difference upper limit for minimum venting factor.

bool openstudio::model::AirflowNetworkZone::setMinimumVentingOpenFactor ( double  minimumVentingOpenFactor)

Sets the minimum venting open factor.

bool openstudio::model::AirflowNetworkZone::setOccupantVentilationControl ( const AirflowNetworkOccupantVentilationControl airflowNetworkOccupantVentilationControl)

Sets the occupant ventilation control object for this zone.

bool openstudio::model::AirflowNetworkZone::setSingleSidedWindPressureCoefficientAlgorithm ( const std::string &  singleSidedWindPressureCoefficientAlgorithm)

Sets the single sided wind pressure algorithm.

bool openstudio::model::AirflowNetworkZone::setVentilationControlMode ( const std::string &  ventilationControlMode)

Sets the ventilation control mode.

bool openstudio::model::AirflowNetworkZone::setVentilationControlZoneTemperatureSetpointSchedule ( Schedule schedule)

Sets the ventilation control zone temperature setpoint schedule.

bool openstudio::model::AirflowNetworkZone::setVentingAvailabilitySchedule ( Schedule schedule)

Sets the venting availability schedule.

std::string openstudio::model::AirflowNetworkZone::singleSidedWindPressureCoefficientAlgorithm ( ) const

Returns the single sided wind pressure algorithm.

static std::vector<std::string> openstudio::model::AirflowNetworkZone::singleSidedWindPressureCoefficientAlgorithmValues ( )
static
ThermalZone openstudio::model::AirflowNetworkZone::thermalZone ( ) const

Returns the associated thermal zone.

std::string openstudio::model::AirflowNetworkZone::ventilationControlMode ( ) const

Returns the ventilation control mode.

static std::vector<std::string> openstudio::model::AirflowNetworkZone::ventilationControlModeValues ( )
static
boost::optional<Schedule> openstudio::model::AirflowNetworkZone::ventilationControlZoneTemperatureSetpointSchedule ( ) const

Returns the ventilation control zone temperature setpoint schedule, if any.

boost::optional<Schedule> openstudio::model::AirflowNetworkZone::ventingAvailabilitySchedule ( ) const

Returns the venting availability schedule, if any.

Friends And Related Function Documentation

typedef std::vector<AirflowNetworkZone> AirflowNetworkZoneVector
related
typedef boost::optional<AirflowNetworkZone> OptionalAirflowNetworkZone
related