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

#include <RefrigerationCompressor.hpp>

+ Inheritance diagram for openstudio::model::RefrigerationCompressor:

Public Member Functions

Constructors and Destructors
 RefrigerationCompressor (const Model &model)
 
virtual ~RefrigerationCompressor ()
 
Getters
CurveBicubic refrigerationCompressorPowerCurve () const
 
CurveBicubic refrigerationCompressorCapacityCurve () const
 
boost::optional< double > ratedSuperheat () const
 
boost::optional< double > ratedReturnGasTemperature () const
 
boost::optional< double > ratedLiquidTemperature () const
 
boost::optional< double > ratedSubcooling () const
 
std::string endUseSubcategory () const
 
bool isEndUseSubcategoryDefaulted () const
 
std::string modeofOperation () const
 
boost::optional< CurveBicubictranscriticalCompressorPowerCurve () const
 
boost::optional< CurveBicubictranscriticalCompressorCapacityCurve () const
 
boost::optional
< RefrigerationSystem
system () const
 
Setters
bool setRefrigerationCompressorPowerCurve (const CurveBicubic &curveBicubic)
 
bool setRefrigerationCompressorCapacityCurve (const CurveBicubic &curveBicubic)
 
bool setRatedSuperheat (double ratedSuperheat)
 
void resetRatedSuperheat ()
 
bool setRatedReturnGasTemperature (double ratedReturnGasTemperature)
 
void resetRatedReturnGasTemperature ()
 
bool setRatedLiquidTemperature (double ratedLiquidTemperature)
 
void resetRatedLiquidTemperature ()
 
bool setRatedSubcooling (double ratedSubcooling)
 
void resetRatedSubcooling ()
 
bool setEndUseSubcategory (std::string endUseSubcategory)
 
void resetEndUseSubcategory ()
 
bool setTranscriticalCompressorPowerCurve (const CurveBicubic &curveBicubic)
 
void resetTranscriticalCompressorPowerCurve ()
 
bool setTranscriticalCompressorCapacityCurve (const CurveBicubic &curveBicubic)
 
void resetTranscriticalCompressorCapacityCurve ()
 
void removeFromSystem ()
 
- Public Member Functions inherited from openstudio::model::ParentObject
std::vector< IddObjectType > allowableChildTypes () const
 Returns a vector of allowable children types. More...
 
std::vector< ModelObjectchildren () const
 Return direct child objects in the Model. More...
 
virtual ~ParentObject ()
 
- Public Member Functions inherited from openstudio::model::ModelObject
virtual ~ModelObject ()
 
ModelObject clone () const
 Creates a deep copy of this object, placing it in this object's model(). More...
 
ModelObject clone (Model model) const
 Creates a deep copy of this object, placing it in model. More...
 
Component createComponent () const
 Method for creating sharable Model snippets. More...
 
Model model () const
 Returns the Model that contains this object. More...
 
boost::optional< ParentObjectparent () const
 Return this object's parent in the hierarchy, if it has one. More...
 
std::vector< ResourceObjectresources () const
 Get the resources directly used by this ModelObject. More...
 
template<typename T >
std::vector< T > getModelObjectSources () const
 Get all objects of type T that point to this object. More...
 
template<typename T >
std::vector< T > getModelObjectSources (IddObjectType iddObjectType) const
 Get all objects of type T that point to this object. More...
 
template<typename T >
boost::optional< T > getModelObjectTarget (unsigned index) const
 Get the object of type T pointed to by this object from field index. More...
 
template<typename T >
std::vector< T > getModelObjectTargets () const
 Get all objects of type T to which this object points. More...
 
const std::vector< std::string > & outputVariableNames () const
 Get all output variables names that could be associated with this object. More...
 
std::vector< OutputVariableoutputVariables () const
 Get all output variables associated with this object, must run simulation to generate data. More...
 
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...
 
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 > modeofOperationValues ()
 

Related Functions

(Note that these are not member functions.)

typedef boost::optional
< RefrigerationCompressor
OptionalRefrigerationCompressor
 
typedef std::vector
< RefrigerationCompressor
RefrigerationCompressorVector
 

Additional Inherited Members

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

Detailed Description

RefrigerationCompressor is a ParentObject that wraps the OpenStudio IDD object 'OS:Refrigeration:Compressor'.

Constructor & Destructor Documentation

openstudio::model::RefrigerationCompressor::RefrigerationCompressor ( const Model model)
explicit
virtual openstudio::model::RefrigerationCompressor::~RefrigerationCompressor ( )
inlinevirtual

Member Function Documentation

std::string openstudio::model::RefrigerationCompressor::endUseSubcategory ( ) const
static IddObjectType openstudio::model::RefrigerationCompressor::iddObjectType ( )
static
bool openstudio::model::RefrigerationCompressor::isEndUseSubcategoryDefaulted ( ) const
std::string openstudio::model::RefrigerationCompressor::modeofOperation ( ) const
static std::vector<std::string> openstudio::model::RefrigerationCompressor::modeofOperationValues ( )
static
boost::optional<double> openstudio::model::RefrigerationCompressor::ratedLiquidTemperature ( ) const
boost::optional<double> openstudio::model::RefrigerationCompressor::ratedReturnGasTemperature ( ) const
boost::optional<double> openstudio::model::RefrigerationCompressor::ratedSubcooling ( ) const
boost::optional<double> openstudio::model::RefrigerationCompressor::ratedSuperheat ( ) const
CurveBicubic openstudio::model::RefrigerationCompressor::refrigerationCompressorCapacityCurve ( ) const
CurveBicubic openstudio::model::RefrigerationCompressor::refrigerationCompressorPowerCurve ( ) const
void openstudio::model::RefrigerationCompressor::removeFromSystem ( )
void openstudio::model::RefrigerationCompressor::resetEndUseSubcategory ( )
void openstudio::model::RefrigerationCompressor::resetRatedLiquidTemperature ( )
void openstudio::model::RefrigerationCompressor::resetRatedReturnGasTemperature ( )
void openstudio::model::RefrigerationCompressor::resetRatedSubcooling ( )
void openstudio::model::RefrigerationCompressor::resetRatedSuperheat ( )
void openstudio::model::RefrigerationCompressor::resetTranscriticalCompressorCapacityCurve ( )
void openstudio::model::RefrigerationCompressor::resetTranscriticalCompressorPowerCurve ( )
bool openstudio::model::RefrigerationCompressor::setEndUseSubcategory ( std::string  endUseSubcategory)
bool openstudio::model::RefrigerationCompressor::setRatedLiquidTemperature ( double  ratedLiquidTemperature)
bool openstudio::model::RefrigerationCompressor::setRatedReturnGasTemperature ( double  ratedReturnGasTemperature)
bool openstudio::model::RefrigerationCompressor::setRatedSubcooling ( double  ratedSubcooling)
bool openstudio::model::RefrigerationCompressor::setRatedSuperheat ( double  ratedSuperheat)
bool openstudio::model::RefrigerationCompressor::setRefrigerationCompressorCapacityCurve ( const CurveBicubic curveBicubic)
bool openstudio::model::RefrigerationCompressor::setRefrigerationCompressorPowerCurve ( const CurveBicubic curveBicubic)
bool openstudio::model::RefrigerationCompressor::setTranscriticalCompressorCapacityCurve ( const CurveBicubic curveBicubic)
bool openstudio::model::RefrigerationCompressor::setTranscriticalCompressorPowerCurve ( const CurveBicubic curveBicubic)
boost::optional<RefrigerationSystem> openstudio::model::RefrigerationCompressor::system ( ) const
boost::optional<CurveBicubic> openstudio::model::RefrigerationCompressor::transcriticalCompressorCapacityCurve ( ) const
boost::optional<CurveBicubic> openstudio::model::RefrigerationCompressor::transcriticalCompressorPowerCurve ( ) const

Friends And Related Function Documentation

typedef boost::optional<RefrigerationCompressor> OptionalRefrigerationCompressor
related