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

#include <CoilCoolingDXMultiSpeed.hpp>

+ Inheritance diagram for openstudio::model::CoilCoolingDXMultiSpeed:

Public Member Functions

Constructors and Destructors
 CoilCoolingDXMultiSpeed (const Model &model)
virtual ~CoilCoolingDXMultiSpeed ()
boost::optional< ScheduleavailabilitySchedule () const
std::string condenserType () const
bool applyPartLoadFractiontoSpeedsGreaterthan1 () const
bool applyLatentDegradationtoSpeedsGreaterthan1 () const
bool isApplyLatentDegradationtoSpeedsGreaterthan1Defaulted () const
double crankcaseHeaterCapacity () const
double maximumOutdoorDryBulbTemperatureforCrankcaseHeaterOperation () const
double basinHeaterCapacity () const
double basinHeaterSetpointTemperature () const
boost::optional< SchedulebasinHeaterOperatingSchedule () const
std::string fuelType () const
double minimumOutdoorDryBulbTemperatureforCompressorOperation () const
bool setAvailabilitySchedule (Schedule &schedule)
void resetAvailabilitySchedule ()
bool setCondenserType (std::string condenserType)
bool setApplyPartLoadFractiontoSpeedsGreaterthan1 (bool applyPartLoadFractiontoSpeedsGreaterthan1)
bool setApplyLatentDegradationtoSpeedsGreaterthan1 (bool applyLatentDegradationtoSpeedsGreaterthan1)
void resetApplyLatentDegradationtoSpeedsGreaterthan1 ()
bool setCrankcaseHeaterCapacity (double crankcaseHeaterCapacity)
bool setMaximumOutdoorDryBulbTemperatureforCrankcaseHeaterOperation (double maximumOutdoorDryBulbTemperatureforCrankcaseHeaterOperation)
bool setBasinHeaterCapacity (double basinHeaterCapacity)
bool setBasinHeaterSetpointTemperature (double basinHeaterSetpointTemperature)
bool setBasinHeaterOperatingSchedule (Schedule &schedule)
void resetBasinHeaterOperatingSchedule ()
bool setFuelType (std::string fuelType)
bool setMinimumOutdoorDryBulbTemperatureforCompressorOperation (double minimumOutdoorDryBulbTemperatureforCompressorOperation)
< CoilCoolingDXMultiSpeedStageData
stages () const
 Return the performance data for each stage. More...
unsigned numberOfStages () const
boost::optional< unsigned > stageIndex (const CoilCoolingDXMultiSpeedStageData &stage) const
bool addStage (const CoilCoolingDXMultiSpeedStageData &stage)
bool addStage (const CoilCoolingDXMultiSpeedStageData &stage, unsigned index)
bool setStageIndex (const CoilCoolingDXMultiSpeedStageData &stage, unsigned index)
bool setStages (const std::vector< CoilCoolingDXMultiSpeedStageData > &stages)
void removeAllStages ()
bool removeStage (const CoilCoolingDXMultiSpeedStageData &stage)
bool removeStage (unsigned index)
AirflowNetworkEquivalentDuct getAirflowNetworkEquivalentDuct (double length, double diameter)
 Creates a new equivalent duct object if an object is not already attached. More...
< AirflowNetworkEquivalentDuct
airflowNetworkEquivalentDuct () const
 Returns the attached equivalent duct object, if any. More...
- Public Member Functions inherited from openstudio::model::StraightComponent
bool addToNode (Node &node)
boost::optional< AirLoopHVACairLoopHVAC () const
 Returns the optional AirLoopHVAC object that this AirToAirComponent is attached to. More...
ModelObject clone (Model model) const
void disconnect ()
boost::optional< ModelObjectinletModelObject () const
 Returns the optional ModelObject connected to the inlet port. More...
unsigned inletPort () const
 Returns the inlet port. More...
boost::optional< ModelObjectoutletModelObject () const
 Returns the optional ModelObject connected to the outlet port. More...
unsigned outletPort () const
 Returns the outlet port. More...
< openstudio::IdfObject > 
remove ()
bool removeFromLoop ()
 StraightComponent (IddObjectType type, const Model &model)
virtual ~StraightComponent ()
- Public Member Functions inherited from openstudio::model::HVACComponent
bool addToNode (Node &node)
 Adds this object to a new system node and returns a boolean indicating if the addition was successful. More...
bool addToSplitter (Splitter &splitter)
 Adds this object to a splitter by creating a new branch. More...
boost::optional< AirLoopHVACairLoopHVAC () const
 Returns the optional AirLoopHVAC object that the HVAC component is attached to. More...
< AirLoopHVACOutdoorAirSystem
airLoopHVACOutdoorAirSystem () const
 Returns the optional AirLoopHVACOutdoorAirSystem that the HVAC component is attached to. More...
void applySizingValues ()
void autosize ()
 Returns the optional ModelObject connected to this object's port. More...
boost::optional< HVACComponentcontainingHVACComponent () const
 EnergyPlus unitary equipment and air terminals are typically composed of other HVAC components. More...
< StraightComponent
containingStraightComponent () const
< ZoneHVACComponent
containingZoneHVACComponent () const
 Returns any ZoneHVACComponent that contains this HVACComponent. More...
void disconnect ()
 Removes all connections to other HVACComponent objects. More...
bool isRemovable () const
 Indicates if the HVACComponent can be removed from the model. More...
boost::optional< Looploop () const
 Returns the optional Loop object that the HVAC component is attached to. More...
boost::optional< PlantLoopplantLoop () const
 Returns the optional PlantLoop object that the HVAC component is attached to. More...
std::vector< IdfObject > remove ()
 Removes the HVACComponent from the model only if isRemovable() return true. More...
virtual ~HVACComponent ()
- 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...
< 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 std::vector< std::string > condenserTypeValues ()
static std::vector< std::string > fuelTypeValues ()
static IddObjectType iddObjectType ()

Related Functions

(Note that these are not member functions.)

typedef std::vector
< CoilCoolingDXMultiSpeed
typedef boost::optional
< CoilCoolingDXMultiSpeed

Additional Inherited Members

- Protected Types inherited from openstudio::model::HVACComponent
typedef detail::HVACComponent_Impl ImplType
- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl ImplType
- Protected Member Functions inherited from openstudio::model::HVACComponent
virtual std::vector< ModelObjectchildren () const
 HVACComponent (IddObjectType type, const Model &model)
 HVACComponent (std::shared_ptr< ImplType > impl)
- 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

CoilCoolingDXMultiSpeed is a StraightComponent that wraps the OpenStudio IDD object 'OS:Coil:Cooling:DX:MultiSpeed'.

Performance data for each stage is contained in a separate ModelObject called CoilCoolingDXMultiSpeedStageData

Constructor & Destructor Documentation

openstudio::model::CoilCoolingDXMultiSpeed::CoilCoolingDXMultiSpeed ( const Model model)
virtual openstudio::model::CoilCoolingDXMultiSpeed::~CoilCoolingDXMultiSpeed ( )

Member Function Documentation

bool openstudio::model::CoilCoolingDXMultiSpeed::addStage ( const CoilCoolingDXMultiSpeedStageData stage)
bool openstudio::model::CoilCoolingDXMultiSpeed::addStage ( const CoilCoolingDXMultiSpeedStageData stage,
unsigned  index 
boost::optional<AirflowNetworkEquivalentDuct> openstudio::model::CoilCoolingDXMultiSpeed::airflowNetworkEquivalentDuct ( ) const

Returns the attached equivalent duct object, if any.

bool openstudio::model::CoilCoolingDXMultiSpeed::applyLatentDegradationtoSpeedsGreaterthan1 ( ) const
bool openstudio::model::CoilCoolingDXMultiSpeed::applyPartLoadFractiontoSpeedsGreaterthan1 ( ) const
boost::optional<Schedule> openstudio::model::CoilCoolingDXMultiSpeed::availabilitySchedule ( ) const
double openstudio::model::CoilCoolingDXMultiSpeed::basinHeaterCapacity ( ) const
boost::optional<Schedule> openstudio::model::CoilCoolingDXMultiSpeed::basinHeaterOperatingSchedule ( ) const
double openstudio::model::CoilCoolingDXMultiSpeed::basinHeaterSetpointTemperature ( ) const
std::string openstudio::model::CoilCoolingDXMultiSpeed::condenserType ( ) const
static std::vector<std::string> openstudio::model::CoilCoolingDXMultiSpeed::condenserTypeValues ( )
double openstudio::model::CoilCoolingDXMultiSpeed::crankcaseHeaterCapacity ( ) const
std::string openstudio::model::CoilCoolingDXMultiSpeed::fuelType ( ) const
static std::vector<std::string> openstudio::model::CoilCoolingDXMultiSpeed::fuelTypeValues ( )
AirflowNetworkEquivalentDuct openstudio::model::CoilCoolingDXMultiSpeed::getAirflowNetworkEquivalentDuct ( double  length,
double  diameter 

Creates a new equivalent duct object if an object is not already attached.

static IddObjectType openstudio::model::CoilCoolingDXMultiSpeed::iddObjectType ( )
bool openstudio::model::CoilCoolingDXMultiSpeed::isApplyLatentDegradationtoSpeedsGreaterthan1Defaulted ( ) const
double openstudio::model::CoilCoolingDXMultiSpeed::maximumOutdoorDryBulbTemperatureforCrankcaseHeaterOperation ( ) const
double openstudio::model::CoilCoolingDXMultiSpeed::minimumOutdoorDryBulbTemperatureforCompressorOperation ( ) const
unsigned openstudio::model::CoilCoolingDXMultiSpeed::numberOfStages ( ) const
void openstudio::model::CoilCoolingDXMultiSpeed::removeAllStages ( )
bool openstudio::model::CoilCoolingDXMultiSpeed::removeStage ( const CoilCoolingDXMultiSpeedStageData stage)
bool openstudio::model::CoilCoolingDXMultiSpeed::removeStage ( unsigned  index)
void openstudio::model::CoilCoolingDXMultiSpeed::resetApplyLatentDegradationtoSpeedsGreaterthan1 ( )
void openstudio::model::CoilCoolingDXMultiSpeed::resetAvailabilitySchedule ( )
void openstudio::model::CoilCoolingDXMultiSpeed::resetBasinHeaterOperatingSchedule ( )
bool openstudio::model::CoilCoolingDXMultiSpeed::setApplyLatentDegradationtoSpeedsGreaterthan1 ( bool  applyLatentDegradationtoSpeedsGreaterthan1)
bool openstudio::model::CoilCoolingDXMultiSpeed::setApplyPartLoadFractiontoSpeedsGreaterthan1 ( bool  applyPartLoadFractiontoSpeedsGreaterthan1)
bool openstudio::model::CoilCoolingDXMultiSpeed::setAvailabilitySchedule ( Schedule schedule)
bool openstudio::model::CoilCoolingDXMultiSpeed::setBasinHeaterCapacity ( double  basinHeaterCapacity)
bool openstudio::model::CoilCoolingDXMultiSpeed::setBasinHeaterOperatingSchedule ( Schedule schedule)
bool openstudio::model::CoilCoolingDXMultiSpeed::setBasinHeaterSetpointTemperature ( double  basinHeaterSetpointTemperature)
bool openstudio::model::CoilCoolingDXMultiSpeed::setCondenserType ( std::string  condenserType)
bool openstudio::model::CoilCoolingDXMultiSpeed::setCrankcaseHeaterCapacity ( double  crankcaseHeaterCapacity)
bool openstudio::model::CoilCoolingDXMultiSpeed::setFuelType ( std::string  fuelType)
bool openstudio::model::CoilCoolingDXMultiSpeed::setMaximumOutdoorDryBulbTemperatureforCrankcaseHeaterOperation ( double  maximumOutdoorDryBulbTemperatureforCrankcaseHeaterOperation)
bool openstudio::model::CoilCoolingDXMultiSpeed::setMinimumOutdoorDryBulbTemperatureforCompressorOperation ( double  minimumOutdoorDryBulbTemperatureforCompressorOperation)
bool openstudio::model::CoilCoolingDXMultiSpeed::setStageIndex ( const CoilCoolingDXMultiSpeedStageData stage,
unsigned  index 
bool openstudio::model::CoilCoolingDXMultiSpeed::setStages ( const std::vector< CoilCoolingDXMultiSpeedStageData > &  stages)
boost::optional<unsigned> openstudio::model::CoilCoolingDXMultiSpeed::stageIndex ( const CoilCoolingDXMultiSpeedStageData stage) const
std::vector<CoilCoolingDXMultiSpeedStageData> openstudio::model::CoilCoolingDXMultiSpeed::stages ( ) const

Return the performance data for each stage.

Friends And Related Function Documentation

typedef boost::optional<CoilCoolingDXMultiSpeed> OptionalCoilCoolingDXMultiSpeed