openstudio::model::RefrigerationSystem Class Reference

#include <RefrigerationSystem.hpp>

Inheritance diagram for openstudio::model::RefrigerationSystem:

Public Member Functions
bool	addAirChiller (const RefrigerationAirChiller &airChiller)
bool	addCascadeCondenserLoad (const RefrigerationCondenserCascade &refrigerationCondenserCascade)
bool	addCase (const RefrigerationCase &refrigerationCase)
bool	addCompressor (const RefrigerationCompressor &compressor)
bool	addHighStageCompressor (const RefrigerationCompressor &highStageCompressor)
bool	addSecondarySystemLoad (const RefrigerationSecondarySystem &refrigerationSecondarySystem)
bool	addWalkin (const RefrigerationWalkIn &refrigerationWalkin)
std::vector < RefrigerationAirChiller >	airChillers () const
std::vector < RefrigerationCondenserCascade >	cascadeCondenserLoads () const
std::vector< RefrigerationCase >	cases () const
ModelObject	clone (Model model) const
std::vector < RefrigerationCompressor >	compressors () const
std::vector < RefrigerationCompressor >	highStageCompressors () const
std::vector< IdfObject >	remove ()
void	removeAirChiller (const RefrigerationAirChiller &airChiller)
void	removeAllAirChillers ()
void	removeAllCascadeCondenserLoads ()
void	removeAllCases ()
void	removeAllCompressors ()
void	removeAllHighStageCompressors ()
void	removeAllSecondarySystemLoads ()
void	removeAllWalkins ()
void	removeCascadeCondenserLoad (const RefrigerationCondenserCascade &refrigerationCondenserCascade)
void	removeCase (const RefrigerationCase &refrigerationCase)
void	removeCompressor (const RefrigerationCompressor &compressor)
void	removeHighStageCompressor (const RefrigerationCompressor &highStageCompressor)
void	removeSecondarySystemLoad (const RefrigerationSecondarySystem &refrigerationSecondarySystem)
void	removeWalkin (const RefrigerationWalkIn &refrigerationWalkin)
std::vector < RefrigerationSecondarySystem >	secondarySystemLoads () const
std::vector< RefrigerationWalkIn >	walkins () const
Constructors and Destructors
	RefrigerationSystem (const Model &model)
virtual	~RefrigerationSystem ()=default
	RefrigerationSystem (const RefrigerationSystem &other)=default
	RefrigerationSystem (RefrigerationSystem &&other)=default
RefrigerationSystem &	operator= (const RefrigerationSystem &)=default
RefrigerationSystem &	operator= (RefrigerationSystem &&)=default
Getters
boost::optional< ModelObject >	refrigerationCondenser () const
double	minimumCondensingTemperature () const
std::string	refrigerationSystemWorkingFluidType () const
std::string	suctionTemperatureControlType () const
bool	isSuctionTemperatureControlTypeDefaulted () const
boost::optional < RefrigerationSubcoolerMechanical >	mechanicalSubcooler () const
boost::optional < RefrigerationSubcoolerLiquidSuction >	liquidSuctionHeatExchangerSubcooler () const
double	sumUASuctionPiping () const
bool	isSumUASuctionPipingDefaulted () const
boost::optional< ThermalZone >	suctionPipingZone () const
std::string	endUseSubcategory () const
bool	isEndUseSubcategoryDefaulted () const
std::string	numberofCompressorStages () const
std::string	intercoolerType () const
bool	isIntercoolerTypeDefaulted () const
double	shellandCoilIntercoolerEffectiveness () const
bool	isShellandCoilIntercoolerEffectivenessDefaulted () const
Setters
bool	setRefrigerationCondenser (const ModelObject &refrigerationCondenser)
	Sets the refrigeration condenser for this refrigeration system. More...
void	resetRefrigerationCondenser ()
bool	setMinimumCondensingTemperature (double minimumCondensingTemperature)
bool	setRefrigerationSystemWorkingFluidType (const std::string &refrigerationSystemWorkingFluidType)
bool	setSuctionTemperatureControlType (const std::string &suctionTemperatureControlType)
void	resetSuctionTemperatureControlType ()
bool	setMechanicalSubcooler (const RefrigerationSubcoolerMechanical &refrigerationSubcoolerMechanical)
void	resetMechanicalSubcooler ()
bool	setLiquidSuctionHeatExchangerSubcooler (const RefrigerationSubcoolerLiquidSuction &refrigerationSubcoolerLiquidSuction)
void	resetLiquidSuctionHeatExchangerSubcooler ()
bool	setSumUASuctionPiping (double sumUASuctionPiping)
void	resetSumUASuctionPiping ()
bool	setSuctionPipingZone (const ThermalZone &thermalZone)
void	resetSuctionPipingZone ()
bool	setEndUseSubcategory (const std::string &endUseSubcategory)
void	resetEndUseSubcategory ()
bool	setIntercoolerType (const std::string &intercoolerType)
void	resetIntercoolerType ()
bool	setShellandCoilIntercoolerEffectiveness (double shellandCoilIntercoolerEffectiveness)
void	resetShellandCoilIntercoolerEffectiveness ()
Public Member Functions inherited from openstudio::model::ModelObject
virtual	~ModelObject ()=default
	ModelObject (const ModelObject &other)=default
	ModelObject (ModelObject &&other)=default
ModelObject &	operator= (const ModelObject &)=default
ModelObject &	operator= (ModelObject &&)=default
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 (const std::string &valueName, const std::string &units) 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 IddObjectType	iddObjectType ()
static std::vector< std::string >	intercoolerTypeValues ()
static std::vector< std::string >	refrigerationSystemWorkingFluidTypeValues ()
static std::vector< std::string >	suctionTemperatureControlTypeValues ()

Related Functions
(Note that these are not member functions.)
using	OptionalRefrigerationSystem = boost::optional< RefrigerationSystem >
using	RefrigerationSystemVector = std::vector< RefrigerationSystem >
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
using	ImplType = detail::ModelObject_Impl
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

RefrigerationSystem is a ModelObject that wraps the OpenStudio IDD object 'OS:Refrigeration:System'.

Constructor & Destructor Documentation

openstudio::model::RefrigerationSystem::RefrigerationSystem ( const Model &  model )

explicit

virtual openstudio::model::RefrigerationSystem::~RefrigerationSystem ( )

virtualdefault

openstudio::model::RefrigerationSystem::RefrigerationSystem ( const RefrigerationSystem &  other )

default

openstudio::model::RefrigerationSystem::RefrigerationSystem ( RefrigerationSystem &&  other )

default

Member Function Documentation

bool openstudio::model::RefrigerationSystem::addAirChiller

(

const RefrigerationAirChiller &

airChiller

)

bool openstudio::model::RefrigerationSystem::addCascadeCondenserLoad

(

const RefrigerationCondenserCascade &

refrigerationCondenserCascade

)

bool openstudio::model::RefrigerationSystem::addCase

(

const RefrigerationCase &

refrigerationCase

)

bool openstudio::model::RefrigerationSystem::addCompressor

(

const RefrigerationCompressor &

compressor

)

bool openstudio::model::RefrigerationSystem::addHighStageCompressor

(

const RefrigerationCompressor &

highStageCompressor

)

bool openstudio::model::RefrigerationSystem::addSecondarySystemLoad

(

const RefrigerationSecondarySystem &

refrigerationSecondarySystem

)

bool openstudio::model::RefrigerationSystem::addWalkin

(

const RefrigerationWalkIn &

refrigerationWalkin

)

std::vector<RefrigerationAirChiller> openstudio::model::RefrigerationSystem::airChillers

(

)

const

std::vector<RefrigerationCondenserCascade> openstudio::model::RefrigerationSystem::cascadeCondenserLoads

(

)

const

std::vector<RefrigerationCase> openstudio::model::RefrigerationSystem::cases

(

)

const

ModelObject openstudio::model::RefrigerationSystem::clone

(

Model

model

)

const

std::vector<RefrigerationCompressor> openstudio::model::RefrigerationSystem::compressors

(

)

const

std::string openstudio::model::RefrigerationSystem::endUseSubcategory

(

)

const

std::vector<RefrigerationCompressor> openstudio::model::RefrigerationSystem::highStageCompressors

(

)

const

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

static

std::string openstudio::model::RefrigerationSystem::intercoolerType

(

)

const

static std::vector<std::string> openstudio::model::RefrigerationSystem::intercoolerTypeValues ( )

static

bool openstudio::model::RefrigerationSystem::isEndUseSubcategoryDefaulted

(

)

const

bool openstudio::model::RefrigerationSystem::isIntercoolerTypeDefaulted

(

)

const

bool openstudio::model::RefrigerationSystem::isShellandCoilIntercoolerEffectivenessDefaulted

(

)

const

bool openstudio::model::RefrigerationSystem::isSuctionTemperatureControlTypeDefaulted

(

)

const

bool openstudio::model::RefrigerationSystem::isSumUASuctionPipingDefaulted

(

)

const

boost::optional<RefrigerationSubcoolerLiquidSuction> openstudio::model::RefrigerationSystem::liquidSuctionHeatExchangerSubcooler

(

)

const

boost::optional<RefrigerationSubcoolerMechanical> openstudio::model::RefrigerationSystem::mechanicalSubcooler

(

)

const

double openstudio::model::RefrigerationSystem::minimumCondensingTemperature

(

)

const

std::string openstudio::model::RefrigerationSystem::numberofCompressorStages

(

)

const

RefrigerationSystem& openstudio::model::RefrigerationSystem::operator= ( const RefrigerationSystem &  )

default

RefrigerationSystem& openstudio::model::RefrigerationSystem::operator= ( RefrigerationSystem &&  )

default

boost::optional<ModelObject> openstudio::model::RefrigerationSystem::refrigerationCondenser

(

)

const

std::string openstudio::model::RefrigerationSystem::refrigerationSystemWorkingFluidType

(

)

const

static std::vector<std::string> openstudio::model::RefrigerationSystem::refrigerationSystemWorkingFluidTypeValues ( )

static

std::vector<IdfObject> openstudio::model::RefrigerationSystem::remove

(

)

void openstudio::model::RefrigerationSystem::removeAirChiller

(

const RefrigerationAirChiller &

airChiller

)

void openstudio::model::RefrigerationSystem::removeAllAirChillers

(

)

void openstudio::model::RefrigerationSystem::removeAllCascadeCondenserLoads

(

)

void openstudio::model::RefrigerationSystem::removeAllCases

(

)

void openstudio::model::RefrigerationSystem::removeAllCompressors

(

)

void openstudio::model::RefrigerationSystem::removeAllHighStageCompressors

(

)

void openstudio::model::RefrigerationSystem::removeAllSecondarySystemLoads

(

)

void openstudio::model::RefrigerationSystem::removeAllWalkins

(

)

void openstudio::model::RefrigerationSystem::removeCascadeCondenserLoad

(

const RefrigerationCondenserCascade &

refrigerationCondenserCascade

)

void openstudio::model::RefrigerationSystem::removeCase

(

const RefrigerationCase &

refrigerationCase

)

void openstudio::model::RefrigerationSystem::removeCompressor

(

const RefrigerationCompressor &

compressor

)

void openstudio::model::RefrigerationSystem::removeHighStageCompressor

(

const RefrigerationCompressor &

highStageCompressor

)

void openstudio::model::RefrigerationSystem::removeSecondarySystemLoad

(

const RefrigerationSecondarySystem &

refrigerationSecondarySystem

)

void openstudio::model::RefrigerationSystem::removeWalkin

(

const RefrigerationWalkIn &

refrigerationWalkin

)

void openstudio::model::RefrigerationSystem::resetEndUseSubcategory

(

)

void openstudio::model::RefrigerationSystem::resetIntercoolerType

(

)

void openstudio::model::RefrigerationSystem::resetLiquidSuctionHeatExchangerSubcooler

(

)

void openstudio::model::RefrigerationSystem::resetMechanicalSubcooler

(

)

void openstudio::model::RefrigerationSystem::resetRefrigerationCondenser

(

)

void openstudio::model::RefrigerationSystem::resetShellandCoilIntercoolerEffectiveness

(

)

void openstudio::model::RefrigerationSystem::resetSuctionPipingZone

(

)

void openstudio::model::RefrigerationSystem::resetSuctionTemperatureControlType

(

)

void openstudio::model::RefrigerationSystem::resetSumUASuctionPiping

(

)

std::vector<RefrigerationSecondarySystem> openstudio::model::RefrigerationSystem::secondarySystemLoads

(

)

const

bool openstudio::model::RefrigerationSystem::setEndUseSubcategory

(

const std::string &

endUseSubcategory

)

bool openstudio::model::RefrigerationSystem::setIntercoolerType

(

const std::string &

intercoolerType

)

bool openstudio::model::RefrigerationSystem::setLiquidSuctionHeatExchangerSubcooler

(

const RefrigerationSubcoolerLiquidSuction &

refrigerationSubcoolerLiquidSuction

)

bool openstudio::model::RefrigerationSystem::setMechanicalSubcooler

(

const RefrigerationSubcoolerMechanical &

refrigerationSubcoolerMechanical

)

bool openstudio::model::RefrigerationSystem::setMinimumCondensingTemperature

(

double

minimumCondensingTemperature

)

bool openstudio::model::RefrigerationSystem::setRefrigerationCondenser

(

const ModelObject &

refrigerationCondenser

)

Sets the refrigeration condenser for this refrigeration system.

Will remove it from any existing Refrigeration System (unicity enforced)

Parameters

[in]

refrigerationCondenser

The refrigeration condenser.

Valid inputs:
RefrigerationCondenserAirCooled
RefrigerationCondenserCascade
RefrigerationCondenserEvaporativeCooled
RefrigerationCondenserWaterCooled

bool openstudio::model::RefrigerationSystem::setRefrigerationSystemWorkingFluidType

(

const std::string &

refrigerationSystemWorkingFluidType

)

bool openstudio::model::RefrigerationSystem::setShellandCoilIntercoolerEffectiveness

(

double

shellandCoilIntercoolerEffectiveness

)

bool openstudio::model::RefrigerationSystem::setSuctionPipingZone

(

const ThermalZone &

thermalZone

)

bool openstudio::model::RefrigerationSystem::setSuctionTemperatureControlType

(

const std::string &

suctionTemperatureControlType

)

bool openstudio::model::RefrigerationSystem::setSumUASuctionPiping

(

double

sumUASuctionPiping

)

double openstudio::model::RefrigerationSystem::shellandCoilIntercoolerEffectiveness

(

)

const

boost::optional<ThermalZone> openstudio::model::RefrigerationSystem::suctionPipingZone

(

)

const

std::string openstudio::model::RefrigerationSystem::suctionTemperatureControlType

(

)

const

static std::vector<std::string> openstudio::model::RefrigerationSystem::suctionTemperatureControlTypeValues ( )

static

double openstudio::model::RefrigerationSystem::sumUASuctionPiping

(

)

const

std::vector<RefrigerationWalkIn> openstudio::model::RefrigerationSystem::walkins

(

)

const

Friends And Related Function Documentation

using OptionalRefrigerationSystem = boost::optional<RefrigerationSystem>

related

using RefrigerationSystemVector = std::vector<RefrigerationSystem>

related