openstudio::model::SizingZone Class Reference

#include <SizingZone.hpp>

Inheritance diagram for openstudio::model::SizingZone:

Public Member Functions
Constructors and Destructors
	SizingZone (const Model &model, const ThermalZone &thermalZone)
virtual	~SizingZone ()
Getters
ThermalZone	thermalZone () const
std::string	zoneCoolingDesignSupplyAirTemperatureInputMethod () const
double	zoneCoolingDesignSupplyAirTemperature () const
double	zoneCoolingDesignSupplyAirTemperatureDifference () const
std::string	zoneHeatingDesignSupplyAirTemperatureInputMethod () const
double	zoneHeatingDesignSupplyAirTemperature () const
double	zoneHeatingDesignSupplyAirTemperatureDifference () const
double	zoneCoolingDesignSupplyAirHumidityRatio () const
double	zoneHeatingDesignSupplyAirHumidityRatio () const
boost::optional< double >	zoneHeatingSizingFactor () const
boost::optional< double >	zoneCoolingSizingFactor () const
std::string	coolingDesignAirFlowMethod () const
bool	isCoolingDesignAirFlowMethodDefaulted () const
double	coolingDesignAirFlowRate () const
bool	isCoolingDesignAirFlowRateDefaulted () const
double	coolingMinimumAirFlowperZoneFloorArea () const
bool	isCoolingMinimumAirFlowperZoneFloorAreaDefaulted () const
double	coolingMinimumAirFlow () const
bool	isCoolingMinimumAirFlowDefaulted () const
double	coolingMinimumAirFlowFraction () const
bool	isCoolingMinimumAirFlowFractionDefaulted () const
std::string	heatingDesignAirFlowMethod () const
bool	isHeatingDesignAirFlowMethodDefaulted () const
double	heatingDesignAirFlowRate () const
bool	isHeatingDesignAirFlowRateDefaulted () const
double	heatingMaximumAirFlowperZoneFloorArea () const
bool	isHeatingMaximumAirFlowperZoneFloorAreaDefaulted () const
double	heatingMaximumAirFlow () const
bool	isHeatingMaximumAirFlowDefaulted () const
double	heatingMaximumAirFlowFraction () const
bool	isHeatingMaximumAirFlowFractionDefaulted () const
bool	accountforDedicatedOutdoorAirSystem () const
std::string	dedicatedOutdoorAirSystemControlStrategy () const
boost::optional< double >	dedicatedOutdoorAirLowSetpointTemperatureforDesign () const
bool	isDedicatedOutdoorAirLowSetpointTemperatureforDesignAutosized () const
boost::optional< double >	dedicatedOutdoorAirHighSetpointTemperatureforDesign () const
bool	isDedicatedOutdoorAirHighSetpointTemperatureforDesignAutosized () const
double	designZoneAirDistributionEffectivenessinCoolingMode () const
bool	isDesignZoneAirDistributionEffectivenessinCoolingModeDefaulted () const
double	designZoneAirDistributionEffectivenessinHeatingMode () const
bool	isDesignZoneAirDistributionEffectivenessinHeatingModeDefaulted () const
double	designZoneSecondaryRecirculationFraction () const
bool	isDesignZoneSecondaryRecirculationFractionDefaulted () const
double	designMinimumZoneVentilationEfficiency () const
bool	isDesignMinimumZoneVentilationEfficiencyDefaulted () const
Setters
bool	setZoneCoolingDesignSupplyAirTemperatureInputMethod (const std::string &value)
bool	setZoneCoolingDesignSupplyAirTemperature (double zoneCoolingDesignSupplyAirTemperature)
bool	setZoneCoolingDesignSupplyAirTemperatureDifference (double value)
bool	setZoneHeatingDesignSupplyAirTemperatureInputMethod (const std::string &value)
bool	setZoneHeatingDesignSupplyAirTemperature (double zoneHeatingDesignSupplyAirTemperature)
bool	setZoneHeatingDesignSupplyAirTemperatureDifference (double value)
bool	setZoneCoolingDesignSupplyAirHumidityRatio (double zoneCoolingDesignSupplyAirHumidityRatio)
bool	setZoneHeatingDesignSupplyAirHumidityRatio (double zoneHeatingDesignSupplyAirHumidityRatio)
bool	setZoneHeatingSizingFactor (double zoneHeatingSizingFactor)
void	resetZoneHeatingSizingFactor ()
bool	setZoneCoolingSizingFactor (double zoneCoolingSizingFactor)
void	resetZoneCoolingSizingFactor ()
bool	setCoolingDesignAirFlowMethod (const std::string &coolingDesignAirFlowMethod)
void	resetCoolingDesignAirFlowMethod ()
bool	setCoolingDesignAirFlowRate (double coolingDesignAirFlowRate)
void	resetCoolingDesignAirFlowRate ()
bool	setCoolingMinimumAirFlowperZoneFloorArea (double coolingMinimumAirFlowperZoneFloorArea)
void	resetCoolingMinimumAirFlowperZoneFloorArea ()
bool	setCoolingMinimumAirFlow (double coolingMinimumAirFlow)
void	resetCoolingMinimumAirFlow ()
bool	setCoolingMinimumAirFlowFraction (double coolingMinimumAirFlowFraction)
void	resetCoolingMinimumAirFlowFraction ()
bool	setHeatingDesignAirFlowMethod (const std::string &heatingDesignAirFlowMethod)
void	resetHeatingDesignAirFlowMethod ()
bool	setHeatingDesignAirFlowRate (double heatingDesignAirFlowRate)
void	resetHeatingDesignAirFlowRate ()
bool	setHeatingMaximumAirFlowperZoneFloorArea (double heatingMaximumAirFlowperZoneFloorArea)
void	resetHeatingMaximumAirFlowperZoneFloorArea ()
bool	setHeatingMaximumAirFlow (double heatingMaximumAirFlow)
void	resetHeatingMaximumAirFlow ()
bool	setHeatingMaximumAirFlowFraction (double heatingMaximumAirFlowFraction)
void	resetHeatingMaximumAirFlowFraction ()
bool	setAccountforDedicatedOutdoorAirSystem (bool accountforDedicatedOutdoorAirSystem)
bool	setDedicatedOutdoorAirSystemControlStrategy (std::string dedicatedOutdoorAirSystemControlStrategy)
bool	setDedicatedOutdoorAirLowSetpointTemperatureforDesign (double dedicatedOutdoorAirLowSetpointTemperatureforDesign)
void	autosizeDedicatedOutdoorAirLowSetpointTemperatureforDesign ()
bool	setDedicatedOutdoorAirHighSetpointTemperatureforDesign (double dedicatedOutdoorAirHighSetpointTemperatureforDesign)
void	autosizeDedicatedOutdoorAirHighSetpointTemperatureforDesign ()
bool	setDesignZoneAirDistributionEffectivenessinCoolingMode (double designZoneAirDistributionEffectivenessinCoolingMode)
void	resetDesignZoneAirDistributionEffectivenessinCoolingMode ()
bool	setDesignZoneAirDistributionEffectivenessinHeatingMode (double designZoneAirDistributionEffectivenessinHeatingMode)
void	resetDesignZoneAirDistributionEffectivenessinHeatingMode ()
bool	setDesignZoneSecondaryRecirculationFraction (double designZoneSecondaryRecirculationFraction)
void	resetDesignZoneSecondaryRecirculationFraction ()
bool	setDesignMinimumZoneVentilationEfficiency (double designMinimumZoneVentilationEfficiency)
void	resetDesignMinimumZoneVentilationEfficiency ()
Other
boost::optional< double >	autosizedDedicatedOutdoorAirLowSetpointTemperatureforDesign () const
boost::optional< double >	autosizedDedicatedOutdoorAirHighSetpointTemperatureforDesign () const
void	autosize ()
void	applySizingValues ()
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...
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

Static Public Member Functions
static std::vector< std::string >	coolingDesignAirFlowMethodValues ()
static std::vector< std::string >	heatingDesignAirFlowMethodValues ()
static IddObjectType	iddObjectType ()
static std::vector< std::string >	zoneCoolingDesignSupplyAirTemperatureInputMethodValues ()
static std::vector< std::string >	zoneHeatingDesignSupplyAirTemperatureInputMethodValues ()

Protected Member Functions
bool	setThermalZone (const ThermalZone &thermalZone)
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
(Note that these are not member functions.)
typedef boost::optional < SizingZone >	OptionalSizingZone
typedef std::vector< SizingZone >	SizingZoneVector
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...

Additional Inherited Members
Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl	ImplType

Detailed Description

SizingZone is a ModelObject that wraps the OpenStudio IDD object 'OS:Sizing:Zone'.

Constructor & Destructor Documentation

openstudio::model::SizingZone::SizingZone ( const Model &  model, const ThermalZone &  thermalZone  )

explicit

virtual openstudio::model::SizingZone::~SizingZone ( )

inlinevirtual

Member Function Documentation

bool openstudio::model::SizingZone::accountforDedicatedOutdoorAirSystem

(

)

const

void openstudio::model::SizingZone::applySizingValues

(

)

void openstudio::model::SizingZone::autosize

(

)

boost::optional<double> openstudio::model::SizingZone::autosizedDedicatedOutdoorAirHighSetpointTemperatureforDesign

(

)

const

boost::optional<double> openstudio::model::SizingZone::autosizedDedicatedOutdoorAirLowSetpointTemperatureforDesign

(

)

const

void openstudio::model::SizingZone::autosizeDedicatedOutdoorAirHighSetpointTemperatureforDesign

(

)

void openstudio::model::SizingZone::autosizeDedicatedOutdoorAirLowSetpointTemperatureforDesign

(

)

std::string openstudio::model::SizingZone::coolingDesignAirFlowMethod

(

)

const

static std::vector<std::string> openstudio::model::SizingZone::coolingDesignAirFlowMethodValues ( )

static

double openstudio::model::SizingZone::coolingDesignAirFlowRate

(

)

const

double openstudio::model::SizingZone::coolingMinimumAirFlow

(

)

const

double openstudio::model::SizingZone::coolingMinimumAirFlowFraction

(

)

const

double openstudio::model::SizingZone::coolingMinimumAirFlowperZoneFloorArea

(

)

const

boost::optional<double> openstudio::model::SizingZone::dedicatedOutdoorAirHighSetpointTemperatureforDesign

(

)

const

boost::optional<double> openstudio::model::SizingZone::dedicatedOutdoorAirLowSetpointTemperatureforDesign

(

)

const

std::string openstudio::model::SizingZone::dedicatedOutdoorAirSystemControlStrategy

(

)

const

double openstudio::model::SizingZone::designMinimumZoneVentilationEfficiency

(

)

const

double openstudio::model::SizingZone::designZoneAirDistributionEffectivenessinCoolingMode

(

)

const

double openstudio::model::SizingZone::designZoneAirDistributionEffectivenessinHeatingMode

(

)

const

double openstudio::model::SizingZone::designZoneSecondaryRecirculationFraction

(

)

const

std::string openstudio::model::SizingZone::heatingDesignAirFlowMethod

(

)

const

static std::vector<std::string> openstudio::model::SizingZone::heatingDesignAirFlowMethodValues ( )

static

double openstudio::model::SizingZone::heatingDesignAirFlowRate

(

)

const

double openstudio::model::SizingZone::heatingMaximumAirFlow

(

)

const

double openstudio::model::SizingZone::heatingMaximumAirFlowFraction

(

)

const

double openstudio::model::SizingZone::heatingMaximumAirFlowperZoneFloorArea

(

)

const

static IddObjectType openstudio::model::SizingZone::iddObjectType ( )

static

bool openstudio::model::SizingZone::isCoolingDesignAirFlowMethodDefaulted

(

)

const

bool openstudio::model::SizingZone::isCoolingDesignAirFlowRateDefaulted

(

)

const

bool openstudio::model::SizingZone::isCoolingMinimumAirFlowDefaulted

(

)

const

bool openstudio::model::SizingZone::isCoolingMinimumAirFlowFractionDefaulted

(

)

const

bool openstudio::model::SizingZone::isCoolingMinimumAirFlowperZoneFloorAreaDefaulted

(

)

const

bool openstudio::model::SizingZone::isDedicatedOutdoorAirHighSetpointTemperatureforDesignAutosized

(

)

const

bool openstudio::model::SizingZone::isDedicatedOutdoorAirLowSetpointTemperatureforDesignAutosized

(

)

const

bool openstudio::model::SizingZone::isDesignMinimumZoneVentilationEfficiencyDefaulted

(

)

const

bool openstudio::model::SizingZone::isDesignZoneAirDistributionEffectivenessinCoolingModeDefaulted

(

)

const

bool openstudio::model::SizingZone::isDesignZoneAirDistributionEffectivenessinHeatingModeDefaulted

(

)

const

bool openstudio::model::SizingZone::isDesignZoneSecondaryRecirculationFractionDefaulted

(

)

const

bool openstudio::model::SizingZone::isHeatingDesignAirFlowMethodDefaulted

(

)

const

bool openstudio::model::SizingZone::isHeatingDesignAirFlowRateDefaulted

(

)

const

bool openstudio::model::SizingZone::isHeatingMaximumAirFlowDefaulted

(

)

const

bool openstudio::model::SizingZone::isHeatingMaximumAirFlowFractionDefaulted

(

)

const

bool openstudio::model::SizingZone::isHeatingMaximumAirFlowperZoneFloorAreaDefaulted

(

)

const

void openstudio::model::SizingZone::resetCoolingDesignAirFlowMethod

(

)

void openstudio::model::SizingZone::resetCoolingDesignAirFlowRate

(

)

void openstudio::model::SizingZone::resetCoolingMinimumAirFlow

(

)

void openstudio::model::SizingZone::resetCoolingMinimumAirFlowFraction

(

)

void openstudio::model::SizingZone::resetCoolingMinimumAirFlowperZoneFloorArea

(

)

void openstudio::model::SizingZone::resetDesignMinimumZoneVentilationEfficiency

(

)

void openstudio::model::SizingZone::resetDesignZoneAirDistributionEffectivenessinCoolingMode

(

)

void openstudio::model::SizingZone::resetDesignZoneAirDistributionEffectivenessinHeatingMode

(

)

void openstudio::model::SizingZone::resetDesignZoneSecondaryRecirculationFraction

(

)

void openstudio::model::SizingZone::resetHeatingDesignAirFlowMethod

(

)

void openstudio::model::SizingZone::resetHeatingDesignAirFlowRate

(

)

void openstudio::model::SizingZone::resetHeatingMaximumAirFlow

(

)

void openstudio::model::SizingZone::resetHeatingMaximumAirFlowFraction

(

)

void openstudio::model::SizingZone::resetHeatingMaximumAirFlowperZoneFloorArea

(

)

void openstudio::model::SizingZone::resetZoneCoolingSizingFactor

(

)

void openstudio::model::SizingZone::resetZoneHeatingSizingFactor

(

)

bool openstudio::model::SizingZone::setAccountforDedicatedOutdoorAirSystem

(

bool

accountforDedicatedOutdoorAirSystem

)

bool openstudio::model::SizingZone::setCoolingDesignAirFlowMethod

(

const std::string &

coolingDesignAirFlowMethod

)

bool openstudio::model::SizingZone::setCoolingDesignAirFlowRate

(

double

coolingDesignAirFlowRate

)

bool openstudio::model::SizingZone::setCoolingMinimumAirFlow

(

double

coolingMinimumAirFlow

)

bool openstudio::model::SizingZone::setCoolingMinimumAirFlowFraction

(

double

coolingMinimumAirFlowFraction

)

bool openstudio::model::SizingZone::setCoolingMinimumAirFlowperZoneFloorArea

(

double

coolingMinimumAirFlowperZoneFloorArea

)

bool openstudio::model::SizingZone::setDedicatedOutdoorAirHighSetpointTemperatureforDesign

(

double

dedicatedOutdoorAirHighSetpointTemperatureforDesign

)

bool openstudio::model::SizingZone::setDedicatedOutdoorAirLowSetpointTemperatureforDesign

(

double

dedicatedOutdoorAirLowSetpointTemperatureforDesign

)

bool openstudio::model::SizingZone::setDedicatedOutdoorAirSystemControlStrategy

(

std::string

dedicatedOutdoorAirSystemControlStrategy

)

bool openstudio::model::SizingZone::setDesignMinimumZoneVentilationEfficiency

(

double

designMinimumZoneVentilationEfficiency

)

bool openstudio::model::SizingZone::setDesignZoneAirDistributionEffectivenessinCoolingMode

(

double

designZoneAirDistributionEffectivenessinCoolingMode

)

bool openstudio::model::SizingZone::setDesignZoneAirDistributionEffectivenessinHeatingMode

(

double

designZoneAirDistributionEffectivenessinHeatingMode

)

bool openstudio::model::SizingZone::setDesignZoneSecondaryRecirculationFraction

(

double

designZoneSecondaryRecirculationFraction

)

bool openstudio::model::SizingZone::setHeatingDesignAirFlowMethod

(

const std::string &

heatingDesignAirFlowMethod

)

bool openstudio::model::SizingZone::setHeatingDesignAirFlowRate

(

double

heatingDesignAirFlowRate

)

bool openstudio::model::SizingZone::setHeatingMaximumAirFlow

(

double

heatingMaximumAirFlow

)

bool openstudio::model::SizingZone::setHeatingMaximumAirFlowFraction

(

double

heatingMaximumAirFlowFraction

)

bool openstudio::model::SizingZone::setHeatingMaximumAirFlowperZoneFloorArea

(

double

heatingMaximumAirFlowperZoneFloorArea

)

bool openstudio::model::SizingZone::setThermalZone ( const ThermalZone &  thermalZone )

protected

bool openstudio::model::SizingZone::setZoneCoolingDesignSupplyAirHumidityRatio

(

double

zoneCoolingDesignSupplyAirHumidityRatio

)

bool openstudio::model::SizingZone::setZoneCoolingDesignSupplyAirTemperature

(

double

zoneCoolingDesignSupplyAirTemperature

)

bool openstudio::model::SizingZone::setZoneCoolingDesignSupplyAirTemperatureDifference

(

double

value

)

bool openstudio::model::SizingZone::setZoneCoolingDesignSupplyAirTemperatureInputMethod

(

const std::string &

value

)

bool openstudio::model::SizingZone::setZoneCoolingSizingFactor

(

double

zoneCoolingSizingFactor

)

bool openstudio::model::SizingZone::setZoneHeatingDesignSupplyAirHumidityRatio

(

double

zoneHeatingDesignSupplyAirHumidityRatio

)

bool openstudio::model::SizingZone::setZoneHeatingDesignSupplyAirTemperature

(

double

zoneHeatingDesignSupplyAirTemperature

)

bool openstudio::model::SizingZone::setZoneHeatingDesignSupplyAirTemperatureDifference

(

double

value

)

bool openstudio::model::SizingZone::setZoneHeatingDesignSupplyAirTemperatureInputMethod

(

const std::string &

value

)

bool openstudio::model::SizingZone::setZoneHeatingSizingFactor

(

double

zoneHeatingSizingFactor

)

ThermalZone openstudio::model::SizingZone::thermalZone

(

)

const

double openstudio::model::SizingZone::zoneCoolingDesignSupplyAirHumidityRatio

(

)

const

double openstudio::model::SizingZone::zoneCoolingDesignSupplyAirTemperature

(

)

const

double openstudio::model::SizingZone::zoneCoolingDesignSupplyAirTemperatureDifference

(

)

const

std::string openstudio::model::SizingZone::zoneCoolingDesignSupplyAirTemperatureInputMethod

(

)

const

static std::vector<std::string> openstudio::model::SizingZone::zoneCoolingDesignSupplyAirTemperatureInputMethodValues ( )

static

boost::optional<double> openstudio::model::SizingZone::zoneCoolingSizingFactor

(

)

const

double openstudio::model::SizingZone::zoneHeatingDesignSupplyAirHumidityRatio

(

)

const

double openstudio::model::SizingZone::zoneHeatingDesignSupplyAirTemperature

(

)

const

double openstudio::model::SizingZone::zoneHeatingDesignSupplyAirTemperatureDifference

(

)

const

std::string openstudio::model::SizingZone::zoneHeatingDesignSupplyAirTemperatureInputMethod

(

)

const

static std::vector<std::string> openstudio::model::SizingZone::zoneHeatingDesignSupplyAirTemperatureInputMethodValues ( )

static

boost::optional<double> openstudio::model::SizingZone::zoneHeatingSizingFactor

(

)

const

Friends And Related Function Documentation

typedef boost::optional<SizingZone> OptionalSizingZone

related

typedef std::vector<SizingZone> SizingZoneVector

related