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

#include <RefrigerationCase.hpp>

+ Inheritance diagram for openstudio::model::RefrigerationCase:

Public Member Functions

Constructors and Destructors
 RefrigerationCase (const Model &model, Schedule &caseDefrostSchedule)
 
virtual ~RefrigerationCase ()
 
Getters
boost::optional< ScheduleavailabilitySchedule () const
 
boost::optional< ThermalZonethermalZone () const
 
double ratedAmbientTemperature () const
 
bool isRatedAmbientTemperatureDefaulted () const
 
double ratedAmbientRelativeHumidity () const
 
bool isRatedAmbientRelativeHumidityDefaulted () const
 
double ratedTotalCoolingCapacityperUnitLength () const
 
bool isRatedTotalCoolingCapacityperUnitLengthDefaulted () const
 
double ratedLatentHeatRatio () const
 
bool isRatedLatentHeatRatioDefaulted () const
 
double ratedRuntimeFraction () const
 
bool isRatedRuntimeFractionDefaulted () const
 
double caseLength () const
 
bool isCaseLengthDefaulted () const
 
double caseOperatingTemperature () const
 
bool isCaseOperatingTemperatureDefaulted () const
 
std::string latentCaseCreditCurveType () const
 
bool isLatentCaseCreditCurveTypeDefaulted () const
 
CurveCubic latentCaseCreditCurve () const
 
double standardCaseFanPowerperUnitLength () const
 
bool isStandardCaseFanPowerperUnitLengthDefaulted () const
 
double operatingCaseFanPowerperUnitLength () const
 
bool isOperatingCaseFanPowerperUnitLengthDefaulted () const
 
double standardCaseLightingPowerperUnitLength () const
 
bool isStandardCaseLightingPowerperUnitLengthDefaulted () const
 
boost::optional< double > installedCaseLightingPowerperUnitLength () const
 
boost::optional< SchedulecaseLightingSchedule () const
 
double fractionofLightingEnergytoCase () const
 
bool isFractionofLightingEnergytoCaseDefaulted () const
 
double caseAntiSweatHeaterPowerperUnitLength () const
 
bool isCaseAntiSweatHeaterPowerperUnitLengthDefaulted () const
 
double minimumAntiSweatHeaterPowerperUnitLength () const
 
bool isMinimumAntiSweatHeaterPowerperUnitLengthDefaulted () const
 
std::string antiSweatHeaterControlType () const
 
bool isAntiSweatHeaterControlTypeDefaulted () const
 
double humidityatZeroAntiSweatHeaterEnergy () const
 
bool isHumidityatZeroAntiSweatHeaterEnergyDefaulted () const
 
double caseHeight () const
 
bool isCaseHeightDefaulted () const
 
double fractionofAntiSweatHeaterEnergytoCase () const
 
bool isFractionofAntiSweatHeaterEnergytoCaseDefaulted () const
 
double caseDefrostPowerperUnitLength () const
 
bool isCaseDefrostPowerperUnitLengthDefaulted () const
 
std::string caseDefrostType () const
 
bool isCaseDefrostTypeDefaulted () const
 
boost::optional< SchedulecaseDefrostSchedule () const
 
boost::optional< SchedulecaseDefrostDripDownSchedule () const
 
std::string defrostEnergyCorrectionCurveType () const
 
bool isDefrostEnergyCorrectionCurveTypeDefaulted () const
 
boost::optional< CurveCubicdefrostEnergyCorrectionCurve () const
 
double underCaseHVACReturnAirFraction () const
 
bool isUnderCaseHVACReturnAirFractionDefaulted () const
 
boost::optional< SchedulerefrigeratedCaseRestockingSchedule () const
 
boost::optional< SchedulecaseCreditFractionSchedule () const
 
boost::optional< double > designEvaporatorTemperatureorBrineInletTemperature () const
 
double averageRefrigerantChargeInventory () const
 
bool isAverageRefrigerantChargeInventoryDefaulted () const
 
boost::optional< intnumberOfDoors () const
 
boost::optional< double > ratedTotalCoolingCapacityperDoor () const
 
boost::optional< double > standardCaseFanPowerperDoor () const
 
boost::optional< double > operatingCaseFanPowerperDoor () const
 
boost::optional< double > standardCaseLightingPowerperDoor () const
 
boost::optional< double > installedCaseLightingPowerperDoor () const
 
boost::optional< double > caseAntiSweatHeaterPowerperDoor () const
 
boost::optional< double > minimumAntiSweatHeaterPowerperDoor () const
 
boost::optional< double > caseDefrostPowerperDoor () const
 
std::string unitType () const
 Read the method for defining loads. More...
 
bool isUnitTypeDefaulted () const
 
boost::optional< intdurationofDefrostCycle () const
 
boost::optional< intdripDownTime () const
 
boost::optional< openstudio::Timedefrost1StartTime () const
 
boost::optional< openstudio::Timedefrost2StartTime () const
 
boost::optional< openstudio::Timedefrost3StartTime () const
 
boost::optional< openstudio::Timedefrost4StartTime () const
 
boost::optional< openstudio::Timedefrost5StartTime () const
 
boost::optional< openstudio::Timedefrost6StartTime () const
 
boost::optional< openstudio::Timedefrost7StartTime () const
 
boost::optional< openstudio::Timedefrost8StartTime () const
 
boost::optional
< RefrigerationSystem
system () const
 
Setters
bool setAvailabilitySchedule (Schedule &schedule)
 
void resetAvailabilitySchedule ()
 
bool setThermalZone (const ThermalZone &thermalZone)
 
void resetThermalZone ()
 
bool setRatedAmbientTemperature (double ratedAmbientTemperature)
 
void resetRatedAmbientTemperature ()
 
bool setRatedAmbientRelativeHumidity (double ratedAmbientRelativeHumidity)
 
void resetRatedAmbientRelativeHumidity ()
 
bool setRatedTotalCoolingCapacityperUnitLength (double ratedTotalCoolingCapacityperUnitLength)
 
void resetRatedTotalCoolingCapacityperUnitLength ()
 
bool setRatedLatentHeatRatio (double ratedLatentHeatRatio)
 
void resetRatedLatentHeatRatio ()
 
bool setRatedRuntimeFraction (double ratedRuntimeFraction)
 
void resetRatedRuntimeFraction ()
 
bool setCaseLength (double caseLength)
 
void resetCaseLength ()
 
bool setCaseOperatingTemperature (double caseOperatingTemperature)
 
void resetCaseOperatingTemperature ()
 
bool setLatentCaseCreditCurveType (std::string latentCaseCreditCurveType)
 
void resetLatentCaseCreditCurveType ()
 
bool setLatentCaseCreditCurve (const CurveCubic &curveCubic)
 
bool setStandardCaseFanPowerperUnitLength (double standardCaseFanPowerperUnitLength)
 
void resetStandardCaseFanPowerperUnitLength ()
 
bool setOperatingCaseFanPowerperUnitLength (double operatingCaseFanPowerperUnitLength)
 
void resetOperatingCaseFanPowerperUnitLength ()
 
void setStandardCaseLightingPowerperUnitLength (double standardCaseLightingPowerperUnitLength)
 
void resetStandardCaseLightingPowerperUnitLength ()
 
void setInstalledCaseLightingPowerperUnitLength (double installedCaseLightingPowerperUnitLength)
 
void resetInstalledCaseLightingPowerperUnitLength ()
 
bool setCaseLightingSchedule (Schedule &schedule)
 
void resetCaseLightingSchedule ()
 
bool setFractionofLightingEnergytoCase (double fractionofLightingEnergytoCase)
 
void resetFractionofLightingEnergytoCase ()
 
bool setCaseAntiSweatHeaterPowerperUnitLength (double caseAntiSweatHeaterPowerperUnitLength)
 
void resetCaseAntiSweatHeaterPowerperUnitLength ()
 
bool setMinimumAntiSweatHeaterPowerperUnitLength (double minimumAntiSweatHeaterPowerperUnitLength)
 
void resetMinimumAntiSweatHeaterPowerperUnitLength ()
 
bool setAntiSweatHeaterControlType (std::string antiSweatHeaterControlType)
 
void resetAntiSweatHeaterControlType ()
 
void setHumidityatZeroAntiSweatHeaterEnergy (double humidityatZeroAntiSweatHeaterEnergy)
 
void resetHumidityatZeroAntiSweatHeaterEnergy ()
 
bool setCaseHeight (double caseHeight)
 
void resetCaseHeight ()
 
bool setFractionofAntiSweatHeaterEnergytoCase (double fractionofAntiSweatHeaterEnergytoCase)
 
void resetFractionofAntiSweatHeaterEnergytoCase ()
 
bool setCaseDefrostPowerperUnitLength (double caseDefrostPowerperUnitLength)
 
void resetCaseDefrostPowerperUnitLength ()
 
bool setCaseDefrostType (std::string caseDefrostType)
 
void resetCaseDefrostType ()
 
bool setCaseDefrostSchedule (Schedule &schedule)
 
void resetCaseDefrostSchedule ()
 
bool setCaseDefrostDripDownSchedule (Schedule &schedule)
 
void resetCaseDefrostDripDownSchedule ()
 
bool setDefrostEnergyCorrectionCurveType (std::string defrostEnergyCorrectionCurveType)
 
void resetDefrostEnergyCorrectionCurveType ()
 
bool setDefrostEnergyCorrectionCurve (const CurveCubic &curveCubic)
 
void resetDefrostEnergyCorrectionCurve ()
 
bool setUnderCaseHVACReturnAirFraction (double underCaseHVACReturnAirFraction)
 
void resetUnderCaseHVACReturnAirFraction ()
 
bool setRefrigeratedCaseRestockingSchedule (Schedule &schedule)
 
void resetRefrigeratedCaseRestockingSchedule ()
 
bool setCaseCreditFractionSchedule (Schedule &schedule)
 
void resetCaseCreditFractionSchedule ()
 
bool setDesignEvaporatorTemperatureorBrineInletTemperature (double designEvaporatorTemperatureorBrineInletTemperature)
 
void resetDesignEvaporatorTemperatureorBrineInletTemperature ()
 
void setAverageRefrigerantChargeInventory (double averageRefrigerantChargeInventory)
 
void resetAverageRefrigerantChargeInventory ()
 
bool setNumberOfDoors (int numberOfDoors)
 
void resetNumberOfDoors ()
 
bool setRatedTotalCoolingCapacityperDoor (double ratedTotalCoolingCapacityperDoor)
 
void resetRatedTotalCoolingCapacityperDoor ()
 
bool setStandardCaseFanPowerperDoor (double standardCaseFanPowerperDoor)
 
void resetStandardCaseFanPowerperDoor ()
 
bool setOperatingCaseFanPowerperDoor (double operatingCaseFanPowerperDoor)
 
void resetOperatingCaseFanPowerperDoor ()
 
bool setStandardCaseLightingPowerperDoor (double standardCaseLightingPowerperDoor)
 
void resetStandardCaseLightingPowerperDoor ()
 
bool setInstalledCaseLightingPowerperDoor (double installedCaseLightingPowerperDoor)
 
void resetInstalledCaseLightingPowerperDoor ()
 
bool setCaseAntiSweatHeaterPowerperDoor (double caseAntiSweatHeaterPowerperDoor)
 
void resetCaseAntiSweatHeaterPowerperDoor ()
 
bool setMinimumAntiSweatHeaterPowerperDoor (double minimumAntiSweatHeaterPowerperDoor)
 
void resetMinimumAntiSweatHeaterPowerperDoor ()
 
bool setCaseDefrostPowerperDoor (double caseDefrostPowerperDoor)
 
void resetCaseDefrostPowerperDoor ()
 
bool setUnitType (std::string unitType)
 Set the method for defining loads. More...
 
void resetUnitType ()
 Reset unit type to the default, "UnitLength". More...
 
bool setDurationofDefrostCycle (int durationofDefrostCycle)
 
void resetDurationofDefrostCycle ()
 
bool setDripDownTime (int dripDownTime)
 
void resetDripDownTime ()
 
bool setDefrost1StartTime (const openstudio::Time &defrost1StartTime)
 
void resetDefrost1StartTime ()
 
bool setDefrost2StartTime (const openstudio::Time &defrost2StartTime)
 
void resetDefrost2StartTime ()
 
bool setDefrost3StartTime (const openstudio::Time &defrost3StartTime)
 
void resetDefrost3StartTime ()
 
bool setDefrost4StartTime (const openstudio::Time &defrost4StartTime)
 
void resetDefrost4StartTime ()
 
bool setDefrost5StartTime (const openstudio::Time &defrost5StartTime)
 
void resetDefrost5StartTime ()
 
bool setDefrost6StartTime (const openstudio::Time &defrost6StartTime)
 
void resetDefrost6StartTime ()
 
bool setDefrost7StartTime (const openstudio::Time &defrost7StartTime)
 
void resetDefrost7StartTime ()
 
bool setDefrost8StartTime (const openstudio::Time &defrost8StartTime)
 
void resetDefrost8StartTime ()
 
bool addToSystem (RefrigerationSystem &system)
 
void removeFromSystem ()
 
- Public Member Functions inherited from openstudio::model::ParentObject
std::vector< IddObjectTypeallowableChildTypes () 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...
 
std::vector< std::string > relationshipNames () const
 Return all valid relationship names. More...
 
std::vector< Relationshiprelationships () const
 Return all relationships for this ModelObject. More...
 
boost::optional< RelationshipgetRelationship (const std::string &name) const
 Get the relationship named name, if it exists. More...
 
bool setRelationship (const std::string &name, boost::optional< ModelObject > relatedModelObject)
 Set this ModelObject's relationship name to point to relatedModelObject (or clear the relationship if relatedModelObject == boost::none). More...
 
bool setRelationship (const std::string &name, const Component &component)
 Inserts component into this model and sets this ModelObject's relationship name to point to component.primaryObject(). More...
 
std::vector< std::string > attributeNames () const
 Return all valid attribute names. More...
 
std::vector
< openstudio::Attribute
attributes () const
 Return all Attributes for this ModelObject. More...
 
boost::optional
< openstudio::Attribute
getAttribute (const std::string &name) const
 Get the attribute named name, if it exists. More...
 
bool isSettableAttribute (const std::string &name) const
 Is the named attribute settable. More...
 
bool isOptionalAttribute (const std::string &name) const
 Is the named attribute optional. More...
 
bool setAttribute (const std::string &name, bool value)
 Set the attribute named name, if it exists. More...
 
bool setAttribute (const std::string &name, int value)
 
bool setAttribute (const std::string &name, unsigned value)
 
bool setAttribute (const std::string &name, double value)
 
bool setAttribute (const std::string &name, const Quantity &value)
 
bool setAttribute (const std::string &name, const std::string &value)
 
bool setAttribute (const std::string &name, const char *value)
 
bool resetAttribute (const std::string &name)
 Reset the attribute named name. 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< IdfObjectremoveLifeCycleCosts ()
 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...
 
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< ModelObjectconnectedObject (unsigned port) const
 
boost::optional< unsigned > connectedObjectPort (unsigned port) const
 
- Public Member Functions inherited from openstudio::WorkspaceObject
bool canBeSource () const
 
bool canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const
 
std::vector< std::string > canBeTarget () const
 
std::vector< unsigned > getSourceIndices (const Handle &targetHandle) const
 
std::vector< WorkspaceObjectgetSources (IddObjectType type) const
 
boost::optional< WorkspaceObjectgetTarget (unsigned index) const
 
IdfObject idfObject ()
 
IdfObject idfObject () const
 
bool initialized () const
 
bool isSource () const
 
bool isTarget () const
 
unsigned numSources () const
 
bool objectListFieldsEqual (const WorkspaceObject &other) const
 
bool objectListFieldsNonConflicting (const WorkspaceObject &other) const
 
bool operator< (const WorkspaceObject &right) const
 
std::ostream & operator<< (std::ostream &os, const WorkspaceObject &workspaceObject)
 
std::vector
< openstudio::IdfObject
remove ()
 
bool setPointer (unsigned index, const Handle &targetHandle)
 
std::vector< WorkspaceObjectsources () const
 
std::vector< WorkspaceObjecttargets () const
 
Workspace workspace () const
 
virtual ~WorkspaceObject ()
 
- Public Member Functions inherited from openstudio::IdfObject
std::string briefDescription () const
 
cast () const
 
std::vector< T > castVector (const std::vector< U > &objects)
 
std::vector< std::vector
< std::string > > 
clearExtensibleGroups ()
 
IdfObject clone (bool keepHandle=false) const
 
std::string comment () const
 
boost::optional< std::string > createName (bool overwrite=true)
 
std::vector< unsigned > dataFields () const
 
bool dataFieldsEqual (const IdfObject &other) const
 
std::vector< std::string > eraseExtensibleGroup (unsigned groupIndex)
 
std::vector< IdfExtensibleGroupextensibleGroups () const
 
boost::optional< std::string > fieldComment (unsigned index, bool returnDefault=false) const
 
boost::optional< double > getDouble (unsigned index, bool returnDefault=false) const
 
IdfExtensibleGroup getExtensibleGroup (unsigned groupIndex) const
 
std::vector< Handle > getHandles (const std::vector< T > &objects)
 
boost::optional< intgetInt (unsigned index, bool returnDefault=false) const
 
OSOptionalQuantity getQuantity (unsigned index, bool returnDefault=false, bool returnIP=false) const
 
boost::optional< std::string > getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const
 
boost::optional< unsigned > getUnsigned (unsigned index, bool returnDefault=false) const
 
boost::optional< QUrl > getURL (unsigned index, bool returnDefault=false) const
 
Handle handle () const
 
IddObject iddObject () const
 
 IdfObject (IddObjectType type, bool fastName=false)
 
 IdfObject (const IddObject &, bool fastName=false)
 
 IdfObject (const IdfObject &other)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)
 
bool isDataField (unsigned index) const
 
bool isEmpty (unsigned index) const
 
bool isObjectListField (unsigned index) const
 
bool isValid (StrictnessLevel level) const
 
boost::optional< unsigned > maxExtensibleGroups () const
 
boost::optional< unsigned > maxFields () const
 
unsigned minExtensibleGroups () const
 
unsigned minFields () const
 
boost::optional< std::string > name (bool returnDefault=false) const
 
std::string nameString (bool returnDefault=false) const
 
unsigned numExtensibleGroups () const
 
unsigned numFields () const
 
unsigned numNonextensibleFields () const
 
std::vector< unsigned > objectListFields () const
 
bool objectListFieldsEqual (const IdfObject &other) const
 
bool objectListFieldsNonConflicting (const IdfObject &other) const
 
bool operator!= (const IdfObject &other) const
 
std::ostream & operator<< (std::ostream &os, const IdfObject &IdfObject)
 
bool operator== (const IdfObject &other) const
 
boost::optional< T > optionalCast () const
 
std::vector< std::string > popExtensibleGroup ()
 
std::ostream & print (std::ostream &os) const
 
std::ostream & printField (std::ostream &os, unsigned index, bool isLastField=false) const
 
std::ostream & printName (std::ostream &os, bool hasFields=true) const
 
IdfExtensibleGroup pushExtensibleGroup ()
 
IdfExtensibleGroup pushExtensibleGroup (const std::vector< std::string > &values)
 
std::vector< unsigned > requiredFields () const
 
void setComment (const std::string &msg)
 
bool setDouble (unsigned index, double value)
 
bool setFieldComment (unsigned index, const std::string &cmnt)
 
bool setInt (unsigned index, int value)
 
boost::optional< std::string > setName (const std::string &newName)
 
bool setQuantity (unsigned index, const Quantity &q)
 
bool setString (unsigned index, const std::string &value)
 
bool setUnsigned (unsigned index, unsigned value)
 
std::vector< T > subsetCastVector (const std::vector< U > &original)
 
ValidityReport validityReport (StrictnessLevel level, bool checkNames=true) const
 
virtual ~IdfObject ()
 

Static Public Member Functions

static std::vector< std::string > antiSweatHeaterControlTypeValues ()
 
static std::vector< std::string > caseDefrostTypeValues ()
 
static std::vector< std::string > defrostEnergyCorrectionCurveTypeValues ()
 
static IddObjectType iddObjectType ()
 
static std::vector< std::string > latentCaseCreditCurveTypeValues ()
 
static std::vector< std::string > unitTypeValues ()
 
- Static Public Member Functions inherited from openstudio::IdfObject
static boost::optional< IdfObjectload (const std::string &text)
 
static boost::optional< IdfObjectload (const std::string &text, const IddObject &iddObject)
 
static int printedFieldSpace ()
 

Related Functions

(Note that these are not member functions.)

typedef boost::optional
< RefrigerationCase
OptionalRefrigerationCase
 
typedef std::vector
< RefrigerationCase
RefrigerationCaseVector
 

Additional Inherited Members

- Public Types inherited from openstudio::WorkspaceObject
typedef boost::optional
< WorkspaceObject
OptionalWorkspaceObject
 
typedef std::vector
< WorkspaceObject
WorkspaceObjectVector
 
- Public Types inherited from openstudio::IdfObject
typedef std::pair< IdfObject,
IdfObject
IdfObjectPair
 
typedef std::vector< IdfObjectIdfObjectVector
 
typedef boost::optional
< IdfObject
OptionalIdfObject
 
- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl ImplType
 
- Protected Types inherited from openstudio::WorkspaceObject
typedef
detail::WorkspaceObject_Impl 
ImplType
 
- Protected Types inherited from openstudio::IdfObject
typedef detail::IdfObject_Impl ImplType
 
- 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)
 
- Protected Member Functions inherited from openstudio::WorkspaceObject
 WorkspaceObject (std::shared_ptr< detail::WorkspaceObject_Impl > impl)
 
- Protected Member Functions inherited from openstudio::IdfObject
 IdfObject (std::shared_ptr< detail::IdfObject_Impl > impl)
 

Detailed Description

RefrigerationCase is a ParentObject that wraps the OpenStudio IDD object 'OS:Refrigeration:Case'.

Constructor & Destructor Documentation

openstudio::model::RefrigerationCase::RefrigerationCase ( const Model model,
Schedule caseDefrostSchedule 
)
explicit
virtual openstudio::model::RefrigerationCase::~RefrigerationCase ( )
inlinevirtual

Member Function Documentation

bool openstudio::model::RefrigerationCase::addToSystem ( RefrigerationSystem system)
std::string openstudio::model::RefrigerationCase::antiSweatHeaterControlType ( ) const
static std::vector<std::string> openstudio::model::RefrigerationCase::antiSweatHeaterControlTypeValues ( )
static
boost::optional<Schedule> openstudio::model::RefrigerationCase::availabilitySchedule ( ) const
double openstudio::model::RefrigerationCase::averageRefrigerantChargeInventory ( ) const
boost::optional<double> openstudio::model::RefrigerationCase::caseAntiSweatHeaterPowerperDoor ( ) const
double openstudio::model::RefrigerationCase::caseAntiSweatHeaterPowerperUnitLength ( ) const
boost::optional<Schedule> openstudio::model::RefrigerationCase::caseCreditFractionSchedule ( ) const
boost::optional<Schedule> openstudio::model::RefrigerationCase::caseDefrostDripDownSchedule ( ) const
boost::optional<double> openstudio::model::RefrigerationCase::caseDefrostPowerperDoor ( ) const
double openstudio::model::RefrigerationCase::caseDefrostPowerperUnitLength ( ) const
boost::optional<Schedule> openstudio::model::RefrigerationCase::caseDefrostSchedule ( ) const
std::string openstudio::model::RefrigerationCase::caseDefrostType ( ) const
static std::vector<std::string> openstudio::model::RefrigerationCase::caseDefrostTypeValues ( )
static
double openstudio::model::RefrigerationCase::caseHeight ( ) const
double openstudio::model::RefrigerationCase::caseLength ( ) const
boost::optional<Schedule> openstudio::model::RefrigerationCase::caseLightingSchedule ( ) const
double openstudio::model::RefrigerationCase::caseOperatingTemperature ( ) const
boost::optional<openstudio::Time> openstudio::model::RefrigerationCase::defrost1StartTime ( ) const
boost::optional<openstudio::Time> openstudio::model::RefrigerationCase::defrost2StartTime ( ) const
boost::optional<openstudio::Time> openstudio::model::RefrigerationCase::defrost3StartTime ( ) const
boost::optional<openstudio::Time> openstudio::model::RefrigerationCase::defrost4StartTime ( ) const
boost::optional<openstudio::Time> openstudio::model::RefrigerationCase::defrost5StartTime ( ) const
boost::optional<openstudio::Time> openstudio::model::RefrigerationCase::defrost6StartTime ( ) const
boost::optional<openstudio::Time> openstudio::model::RefrigerationCase::defrost7StartTime ( ) const
boost::optional<openstudio::Time> openstudio::model::RefrigerationCase::defrost8StartTime ( ) const
boost::optional<CurveCubic> openstudio::model::RefrigerationCase::defrostEnergyCorrectionCurve ( ) const
std::string openstudio::model::RefrigerationCase::defrostEnergyCorrectionCurveType ( ) const
static std::vector<std::string> openstudio::model::RefrigerationCase::defrostEnergyCorrectionCurveTypeValues ( )
static
boost::optional<double> openstudio::model::RefrigerationCase::designEvaporatorTemperatureorBrineInletTemperature ( ) const
boost::optional<int> openstudio::model::RefrigerationCase::dripDownTime ( ) const
boost::optional<int> openstudio::model::RefrigerationCase::durationofDefrostCycle ( ) const
double openstudio::model::RefrigerationCase::fractionofAntiSweatHeaterEnergytoCase ( ) const
double openstudio::model::RefrigerationCase::fractionofLightingEnergytoCase ( ) const
double openstudio::model::RefrigerationCase::humidityatZeroAntiSweatHeaterEnergy ( ) const
static IddObjectType openstudio::model::RefrigerationCase::iddObjectType ( )
static
boost::optional<double> openstudio::model::RefrigerationCase::installedCaseLightingPowerperDoor ( ) const
boost::optional<double> openstudio::model::RefrigerationCase::installedCaseLightingPowerperUnitLength ( ) const
bool openstudio::model::RefrigerationCase::isAntiSweatHeaterControlTypeDefaulted ( ) const
bool openstudio::model::RefrigerationCase::isAverageRefrigerantChargeInventoryDefaulted ( ) const
bool openstudio::model::RefrigerationCase::isCaseAntiSweatHeaterPowerperUnitLengthDefaulted ( ) const
bool openstudio::model::RefrigerationCase::isCaseDefrostPowerperUnitLengthDefaulted ( ) const
bool openstudio::model::RefrigerationCase::isCaseDefrostTypeDefaulted ( ) const
bool openstudio::model::RefrigerationCase::isCaseHeightDefaulted ( ) const
bool openstudio::model::RefrigerationCase::isCaseLengthDefaulted ( ) const
bool openstudio::model::RefrigerationCase::isCaseOperatingTemperatureDefaulted ( ) const
bool openstudio::model::RefrigerationCase::isDefrostEnergyCorrectionCurveTypeDefaulted ( ) const
bool openstudio::model::RefrigerationCase::isFractionofAntiSweatHeaterEnergytoCaseDefaulted ( ) const
bool openstudio::model::RefrigerationCase::isFractionofLightingEnergytoCaseDefaulted ( ) const
bool openstudio::model::RefrigerationCase::isHumidityatZeroAntiSweatHeaterEnergyDefaulted ( ) const
bool openstudio::model::RefrigerationCase::isLatentCaseCreditCurveTypeDefaulted ( ) const
bool openstudio::model::RefrigerationCase::isMinimumAntiSweatHeaterPowerperUnitLengthDefaulted ( ) const
bool openstudio::model::RefrigerationCase::isOperatingCaseFanPowerperUnitLengthDefaulted ( ) const
bool openstudio::model::RefrigerationCase::isRatedAmbientRelativeHumidityDefaulted ( ) const
bool openstudio::model::RefrigerationCase::isRatedAmbientTemperatureDefaulted ( ) const
bool openstudio::model::RefrigerationCase::isRatedLatentHeatRatioDefaulted ( ) const
bool openstudio::model::RefrigerationCase::isRatedRuntimeFractionDefaulted ( ) const
bool openstudio::model::RefrigerationCase::isRatedTotalCoolingCapacityperUnitLengthDefaulted ( ) const
bool openstudio::model::RefrigerationCase::isStandardCaseFanPowerperUnitLengthDefaulted ( ) const
bool openstudio::model::RefrigerationCase::isStandardCaseLightingPowerperUnitLengthDefaulted ( ) const
bool openstudio::model::RefrigerationCase::isUnderCaseHVACReturnAirFractionDefaulted ( ) const
bool openstudio::model::RefrigerationCase::isUnitTypeDefaulted ( ) const
CurveCubic openstudio::model::RefrigerationCase::latentCaseCreditCurve ( ) const
std::string openstudio::model::RefrigerationCase::latentCaseCreditCurveType ( ) const
static std::vector<std::string> openstudio::model::RefrigerationCase::latentCaseCreditCurveTypeValues ( )
static
boost::optional<double> openstudio::model::RefrigerationCase::minimumAntiSweatHeaterPowerperDoor ( ) const
double openstudio::model::RefrigerationCase::minimumAntiSweatHeaterPowerperUnitLength ( ) const
boost::optional<int> openstudio::model::RefrigerationCase::numberOfDoors ( ) const
boost::optional<double> openstudio::model::RefrigerationCase::operatingCaseFanPowerperDoor ( ) const
double openstudio::model::RefrigerationCase::operatingCaseFanPowerperUnitLength ( ) const
double openstudio::model::RefrigerationCase::ratedAmbientRelativeHumidity ( ) const
double openstudio::model::RefrigerationCase::ratedAmbientTemperature ( ) const
double openstudio::model::RefrigerationCase::ratedLatentHeatRatio ( ) const
double openstudio::model::RefrigerationCase::ratedRuntimeFraction ( ) const
boost::optional<double> openstudio::model::RefrigerationCase::ratedTotalCoolingCapacityperDoor ( ) const
double openstudio::model::RefrigerationCase::ratedTotalCoolingCapacityperUnitLength ( ) const
boost::optional<Schedule> openstudio::model::RefrigerationCase::refrigeratedCaseRestockingSchedule ( ) const
void openstudio::model::RefrigerationCase::removeFromSystem ( )
void openstudio::model::RefrigerationCase::resetAntiSweatHeaterControlType ( )
void openstudio::model::RefrigerationCase::resetAvailabilitySchedule ( )
void openstudio::model::RefrigerationCase::resetAverageRefrigerantChargeInventory ( )
void openstudio::model::RefrigerationCase::resetCaseAntiSweatHeaterPowerperDoor ( )
void openstudio::model::RefrigerationCase::resetCaseAntiSweatHeaterPowerperUnitLength ( )
void openstudio::model::RefrigerationCase::resetCaseCreditFractionSchedule ( )
void openstudio::model::RefrigerationCase::resetCaseDefrostDripDownSchedule ( )
void openstudio::model::RefrigerationCase::resetCaseDefrostPowerperDoor ( )
void openstudio::model::RefrigerationCase::resetCaseDefrostPowerperUnitLength ( )
void openstudio::model::RefrigerationCase::resetCaseDefrostSchedule ( )
void openstudio::model::RefrigerationCase::resetCaseDefrostType ( )
void openstudio::model::RefrigerationCase::resetCaseHeight ( )
void openstudio::model::RefrigerationCase::resetCaseLength ( )
void openstudio::model::RefrigerationCase::resetCaseLightingSchedule ( )
void openstudio::model::RefrigerationCase::resetCaseOperatingTemperature ( )
void openstudio::model::RefrigerationCase::resetDefrost1StartTime ( )
void openstudio::model::RefrigerationCase::resetDefrost2StartTime ( )
void openstudio::model::RefrigerationCase::resetDefrost3StartTime ( )
void openstudio::model::RefrigerationCase::resetDefrost4StartTime ( )
void openstudio::model::RefrigerationCase::resetDefrost5StartTime ( )
void openstudio::model::RefrigerationCase::resetDefrost6StartTime ( )
void openstudio::model::RefrigerationCase::resetDefrost7StartTime ( )
void openstudio::model::RefrigerationCase::resetDefrost8StartTime ( )
void openstudio::model::RefrigerationCase::resetDefrostEnergyCorrectionCurve ( )
void openstudio::model::RefrigerationCase::resetDefrostEnergyCorrectionCurveType ( )
void openstudio::model::RefrigerationCase::resetDesignEvaporatorTemperatureorBrineInletTemperature ( )
void openstudio::model::RefrigerationCase::resetDripDownTime ( )
void openstudio::model::RefrigerationCase::resetDurationofDefrostCycle ( )
void openstudio::model::RefrigerationCase::resetFractionofAntiSweatHeaterEnergytoCase ( )
void openstudio::model::RefrigerationCase::resetFractionofLightingEnergytoCase ( )
void openstudio::model::RefrigerationCase::resetHumidityatZeroAntiSweatHeaterEnergy ( )
void openstudio::model::RefrigerationCase::resetInstalledCaseLightingPowerperDoor ( )
void openstudio::model::RefrigerationCase::resetInstalledCaseLightingPowerperUnitLength ( )
void openstudio::model::RefrigerationCase::resetLatentCaseCreditCurveType ( )
void openstudio::model::RefrigerationCase::resetMinimumAntiSweatHeaterPowerperDoor ( )
void openstudio::model::RefrigerationCase::resetMinimumAntiSweatHeaterPowerperUnitLength ( )
void openstudio::model::RefrigerationCase::resetNumberOfDoors ( )
void openstudio::model::RefrigerationCase::resetOperatingCaseFanPowerperDoor ( )
void openstudio::model::RefrigerationCase::resetOperatingCaseFanPowerperUnitLength ( )
void openstudio::model::RefrigerationCase::resetRatedAmbientRelativeHumidity ( )
void openstudio::model::RefrigerationCase::resetRatedAmbientTemperature ( )
void openstudio::model::RefrigerationCase::resetRatedLatentHeatRatio ( )
void openstudio::model::RefrigerationCase::resetRatedRuntimeFraction ( )
void openstudio::model::RefrigerationCase::resetRatedTotalCoolingCapacityperDoor ( )
void openstudio::model::RefrigerationCase::resetRatedTotalCoolingCapacityperUnitLength ( )
void openstudio::model::RefrigerationCase::resetRefrigeratedCaseRestockingSchedule ( )
void openstudio::model::RefrigerationCase::resetStandardCaseFanPowerperDoor ( )
void openstudio::model::RefrigerationCase::resetStandardCaseFanPowerperUnitLength ( )
void openstudio::model::RefrigerationCase::resetStandardCaseLightingPowerperDoor ( )
void openstudio::model::RefrigerationCase::resetStandardCaseLightingPowerperUnitLength ( )
void openstudio::model::RefrigerationCase::resetThermalZone ( )
void openstudio::model::RefrigerationCase::resetUnderCaseHVACReturnAirFraction ( )
void openstudio::model::RefrigerationCase::resetUnitType ( )

Reset unit type to the default, "UnitLength".

bool openstudio::model::RefrigerationCase::setAntiSweatHeaterControlType ( std::string  antiSweatHeaterControlType)
bool openstudio::model::RefrigerationCase::setAvailabilitySchedule ( Schedule schedule)
void openstudio::model::RefrigerationCase::setAverageRefrigerantChargeInventory ( double  averageRefrigerantChargeInventory)
bool openstudio::model::RefrigerationCase::setCaseAntiSweatHeaterPowerperDoor ( double  caseAntiSweatHeaterPowerperDoor)
bool openstudio::model::RefrigerationCase::setCaseAntiSweatHeaterPowerperUnitLength ( double  caseAntiSweatHeaterPowerperUnitLength)
bool openstudio::model::RefrigerationCase::setCaseCreditFractionSchedule ( Schedule schedule)
bool openstudio::model::RefrigerationCase::setCaseDefrostDripDownSchedule ( Schedule schedule)
bool openstudio::model::RefrigerationCase::setCaseDefrostPowerperDoor ( double  caseDefrostPowerperDoor)
bool openstudio::model::RefrigerationCase::setCaseDefrostPowerperUnitLength ( double  caseDefrostPowerperUnitLength)
bool openstudio::model::RefrigerationCase::setCaseDefrostSchedule ( Schedule schedule)
bool openstudio::model::RefrigerationCase::setCaseDefrostType ( std::string  caseDefrostType)
bool openstudio::model::RefrigerationCase::setCaseHeight ( double  caseHeight)
bool openstudio::model::RefrigerationCase::setCaseLength ( double  caseLength)
bool openstudio::model::RefrigerationCase::setCaseLightingSchedule ( Schedule schedule)
bool openstudio::model::RefrigerationCase::setCaseOperatingTemperature ( double  caseOperatingTemperature)
bool openstudio::model::RefrigerationCase::setDefrost1StartTime ( const openstudio::Time defrost1StartTime)
bool openstudio::model::RefrigerationCase::setDefrost2StartTime ( const openstudio::Time defrost2StartTime)
bool openstudio::model::RefrigerationCase::setDefrost3StartTime ( const openstudio::Time defrost3StartTime)
bool openstudio::model::RefrigerationCase::setDefrost4StartTime ( const openstudio::Time defrost4StartTime)
bool openstudio::model::RefrigerationCase::setDefrost5StartTime ( const openstudio::Time defrost5StartTime)
bool openstudio::model::RefrigerationCase::setDefrost6StartTime ( const openstudio::Time defrost6StartTime)
bool openstudio::model::RefrigerationCase::setDefrost7StartTime ( const openstudio::Time defrost7StartTime)
bool openstudio::model::RefrigerationCase::setDefrost8StartTime ( const openstudio::Time defrost8StartTime)
bool openstudio::model::RefrigerationCase::setDefrostEnergyCorrectionCurve ( const CurveCubic curveCubic)
bool openstudio::model::RefrigerationCase::setDefrostEnergyCorrectionCurveType ( std::string  defrostEnergyCorrectionCurveType)
bool openstudio::model::RefrigerationCase::setDesignEvaporatorTemperatureorBrineInletTemperature ( double  designEvaporatorTemperatureorBrineInletTemperature)
bool openstudio::model::RefrigerationCase::setDripDownTime ( int  dripDownTime)
bool openstudio::model::RefrigerationCase::setDurationofDefrostCycle ( int  durationofDefrostCycle)
bool openstudio::model::RefrigerationCase::setFractionofAntiSweatHeaterEnergytoCase ( double  fractionofAntiSweatHeaterEnergytoCase)
bool openstudio::model::RefrigerationCase::setFractionofLightingEnergytoCase ( double  fractionofLightingEnergytoCase)
void openstudio::model::RefrigerationCase::setHumidityatZeroAntiSweatHeaterEnergy ( double  humidityatZeroAntiSweatHeaterEnergy)
bool openstudio::model::RefrigerationCase::setInstalledCaseLightingPowerperDoor ( double  installedCaseLightingPowerperDoor)
void openstudio::model::RefrigerationCase::setInstalledCaseLightingPowerperUnitLength ( double  installedCaseLightingPowerperUnitLength)
bool openstudio::model::RefrigerationCase::setLatentCaseCreditCurve ( const CurveCubic curveCubic)
bool openstudio::model::RefrigerationCase::setLatentCaseCreditCurveType ( std::string  latentCaseCreditCurveType)
bool openstudio::model::RefrigerationCase::setMinimumAntiSweatHeaterPowerperDoor ( double  minimumAntiSweatHeaterPowerperDoor)
bool openstudio::model::RefrigerationCase::setMinimumAntiSweatHeaterPowerperUnitLength ( double  minimumAntiSweatHeaterPowerperUnitLength)
bool openstudio::model::RefrigerationCase::setNumberOfDoors ( int  numberOfDoors)
bool openstudio::model::RefrigerationCase::setOperatingCaseFanPowerperDoor ( double  operatingCaseFanPowerperDoor)
bool openstudio::model::RefrigerationCase::setOperatingCaseFanPowerperUnitLength ( double  operatingCaseFanPowerperUnitLength)
bool openstudio::model::RefrigerationCase::setRatedAmbientRelativeHumidity ( double  ratedAmbientRelativeHumidity)
bool openstudio::model::RefrigerationCase::setRatedAmbientTemperature ( double  ratedAmbientTemperature)
bool openstudio::model::RefrigerationCase::setRatedLatentHeatRatio ( double  ratedLatentHeatRatio)
bool openstudio::model::RefrigerationCase::setRatedRuntimeFraction ( double  ratedRuntimeFraction)
bool openstudio::model::RefrigerationCase::setRatedTotalCoolingCapacityperDoor ( double  ratedTotalCoolingCapacityperDoor)
bool openstudio::model::RefrigerationCase::setRatedTotalCoolingCapacityperUnitLength ( double  ratedTotalCoolingCapacityperUnitLength)
bool openstudio::model::RefrigerationCase::setRefrigeratedCaseRestockingSchedule ( Schedule schedule)
bool openstudio::model::RefrigerationCase::setStandardCaseFanPowerperDoor ( double  standardCaseFanPowerperDoor)
bool openstudio::model::RefrigerationCase::setStandardCaseFanPowerperUnitLength ( double  standardCaseFanPowerperUnitLength)
bool openstudio::model::RefrigerationCase::setStandardCaseLightingPowerperDoor ( double  standardCaseLightingPowerperDoor)
void openstudio::model::RefrigerationCase::setStandardCaseLightingPowerperUnitLength ( double  standardCaseLightingPowerperUnitLength)
bool openstudio::model::RefrigerationCase::setThermalZone ( const ThermalZone thermalZone)
bool openstudio::model::RefrigerationCase::setUnderCaseHVACReturnAirFraction ( double  underCaseHVACReturnAirFraction)
bool openstudio::model::RefrigerationCase::setUnitType ( std::string  unitType)

Set the method for defining loads.

Options are UnitLength and NumberOfDoors. If UnitLength values will be used from the *perUnitLength methods. If NumberOfDoors, the values will be used from the *perDoor methods.

boost::optional<double> openstudio::model::RefrigerationCase::standardCaseFanPowerperDoor ( ) const
double openstudio::model::RefrigerationCase::standardCaseFanPowerperUnitLength ( ) const
boost::optional<double> openstudio::model::RefrigerationCase::standardCaseLightingPowerperDoor ( ) const
double openstudio::model::RefrigerationCase::standardCaseLightingPowerperUnitLength ( ) const
boost::optional<RefrigerationSystem> openstudio::model::RefrigerationCase::system ( ) const
boost::optional<ThermalZone> openstudio::model::RefrigerationCase::thermalZone ( ) const
double openstudio::model::RefrigerationCase::underCaseHVACReturnAirFraction ( ) const
std::string openstudio::model::RefrigerationCase::unitType ( ) const

Read the method for defining loads.

Options are UnitLength and NumberOfDoors. If UnitLength values will be used from the *perUnitLength methods. If NumberOfDoors, the values will be used from the *perDoor methods.

static std::vector<std::string> openstudio::model::RefrigerationCase::unitTypeValues ( )
static

Friends And Related Function Documentation

typedef boost::optional<RefrigerationCase> OptionalRefrigerationCase
related
typedef std::vector<RefrigerationCase> RefrigerationCaseVector
related