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

#include <HeaderedPumpsConstantSpeed.hpp>

+ Inheritance diagram for openstudio::model::HeaderedPumpsConstantSpeed:

Public Member Functions

Constructors and Destructors
 HeaderedPumpsConstantSpeed (const Model &model)
virtual ~HeaderedPumpsConstantSpeed ()
boost::optional< double > totalRatedFlowRate () const
 In EnergyPlus 8.5.0 and above this property maps to the EnergyPlus field "Total Design Flow Rate". More...
bool isTotalRatedFlowRateAutosized () const
int numberofPumpsinBank () const
std::string flowSequencingControlScheme () const
double ratedPumpHead () const
 In EnergyPlus 8.5.0 and above this property maps to the EnergyPlus field "Design Pump Head". More...
boost::optional< double > ratedPowerConsumption () const
 In EnergyPlus 8.5.0 and above this property maps to the EnergyPlus field "Design Power Consumption". More...
bool isRatedPowerConsumptionAutosized () const
double motorEfficiency () const
double fractionofMotorInefficienciestoFluidStream () const
std::string pumpControlType () const
boost::optional< SchedulepumpFlowRateSchedule () const
boost::optional< ThermalZonethermalZone () const
double skinLossRadiativeFraction () const
std::string designPowerSizingMethod () const
double designElectricPowerPerUnitFlowRate () const
double designShaftPowerPerUnitFlowRatePerUnitHead () const
std::string endUseSubcategory () const
bool setTotalRatedFlowRate (double totalRatedFlowRate)
void autosizeTotalRatedFlowRate ()
bool setNumberofPumpsinBank (int numberofPumpsinBank)
bool setFlowSequencingControlScheme (const std::string &flowSequencingControlScheme)
bool setRatedPumpHead (double ratedPumpHead)
bool setRatedPowerConsumption (double ratedPowerConsumption)
void autosizeRatedPowerConsumption ()
bool setMotorEfficiency (double motorEfficiency)
bool setFractionofMotorInefficienciestoFluidStream (double fractionofMotorInefficienciestoFluidStream)
bool setPumpControlType (const std::string &pumpControlType)
bool setPumpFlowRateSchedule (Schedule &schedule)
void resetPumpFlowRateSchedule ()
bool setThermalZone (const ThermalZone &thermalZone)
void resetThermalZone ()
bool setSkinLossRadiativeFraction (double skinLossRadiativeFraction)
bool setDesignPowerSizingMethod (const std::string &designPowerSizingMethod)
bool setDesignElectricPowerPerUnitFlowRate (double designElectricPowerPerUnitFlowRate)
bool setDesignShaftPowerPerUnitFlowRatePerUnitHead (double designShaftPowerPerUnitFlowRatePerUnitHead)
bool setEndUseSubcategory (const std::string &endUseSubcategory)
boost::optional< double > autosizedTotalRatedFlowRate () const
boost::optional< double > autosizedRatedPowerConsumption () const
- 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 > designPowerSizingMethodValues ()
static std::vector< std::string > flowSequencingControlSchemeValues ()
static IddObjectType iddObjectType ()
static std::vector< std::string > pumpControlTypeValues ()

Related Functions

(Note that these are not member functions.)

typedef std::vector
< HeaderedPumpsConstantSpeed
typedef boost::optional
< HeaderedPumpsConstantSpeed

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

HeaderedPumpsConstantSpeed is a StraightComponent that wraps the OpenStudio IDD object 'OS:HeaderedPumps:ConstantSpeed'.

Constructor & Destructor Documentation

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

Member Function Documentation

boost::optional<double> openstudio::model::HeaderedPumpsConstantSpeed::autosizedRatedPowerConsumption ( ) const
boost::optional<double> openstudio::model::HeaderedPumpsConstantSpeed::autosizedTotalRatedFlowRate ( ) const
void openstudio::model::HeaderedPumpsConstantSpeed::autosizeRatedPowerConsumption ( )
void openstudio::model::HeaderedPumpsConstantSpeed::autosizeTotalRatedFlowRate ( )
double openstudio::model::HeaderedPumpsConstantSpeed::designElectricPowerPerUnitFlowRate ( ) const
std::string openstudio::model::HeaderedPumpsConstantSpeed::designPowerSizingMethod ( ) const
static std::vector<std::string> openstudio::model::HeaderedPumpsConstantSpeed::designPowerSizingMethodValues ( )
double openstudio::model::HeaderedPumpsConstantSpeed::designShaftPowerPerUnitFlowRatePerUnitHead ( ) const
std::string openstudio::model::HeaderedPumpsConstantSpeed::endUseSubcategory ( ) const
std::string openstudio::model::HeaderedPumpsConstantSpeed::flowSequencingControlScheme ( ) const
static std::vector<std::string> openstudio::model::HeaderedPumpsConstantSpeed::flowSequencingControlSchemeValues ( )
double openstudio::model::HeaderedPumpsConstantSpeed::fractionofMotorInefficienciestoFluidStream ( ) const
static IddObjectType openstudio::model::HeaderedPumpsConstantSpeed::iddObjectType ( )
bool openstudio::model::HeaderedPumpsConstantSpeed::isRatedPowerConsumptionAutosized ( ) const
bool openstudio::model::HeaderedPumpsConstantSpeed::isTotalRatedFlowRateAutosized ( ) const
double openstudio::model::HeaderedPumpsConstantSpeed::motorEfficiency ( ) const
int openstudio::model::HeaderedPumpsConstantSpeed::numberofPumpsinBank ( ) const
std::string openstudio::model::HeaderedPumpsConstantSpeed::pumpControlType ( ) const
static std::vector<std::string> openstudio::model::HeaderedPumpsConstantSpeed::pumpControlTypeValues ( )
boost::optional<Schedule> openstudio::model::HeaderedPumpsConstantSpeed::pumpFlowRateSchedule ( ) const
boost::optional<double> openstudio::model::HeaderedPumpsConstantSpeed::ratedPowerConsumption ( ) const

In EnergyPlus 8.5.0 and above this property maps to the EnergyPlus field "Design Power Consumption".

double openstudio::model::HeaderedPumpsConstantSpeed::ratedPumpHead ( ) const

In EnergyPlus 8.5.0 and above this property maps to the EnergyPlus field "Design Pump Head".

void openstudio::model::HeaderedPumpsConstantSpeed::resetPumpFlowRateSchedule ( )
void openstudio::model::HeaderedPumpsConstantSpeed::resetThermalZone ( )
bool openstudio::model::HeaderedPumpsConstantSpeed::setDesignElectricPowerPerUnitFlowRate ( double  designElectricPowerPerUnitFlowRate)
bool openstudio::model::HeaderedPumpsConstantSpeed::setDesignPowerSizingMethod ( const std::string &  designPowerSizingMethod)
bool openstudio::model::HeaderedPumpsConstantSpeed::setDesignShaftPowerPerUnitFlowRatePerUnitHead ( double  designShaftPowerPerUnitFlowRatePerUnitHead)
bool openstudio::model::HeaderedPumpsConstantSpeed::setEndUseSubcategory ( const std::string &  endUseSubcategory)
bool openstudio::model::HeaderedPumpsConstantSpeed::setFlowSequencingControlScheme ( const std::string &  flowSequencingControlScheme)
bool openstudio::model::HeaderedPumpsConstantSpeed::setFractionofMotorInefficienciestoFluidStream ( double  fractionofMotorInefficienciestoFluidStream)
bool openstudio::model::HeaderedPumpsConstantSpeed::setMotorEfficiency ( double  motorEfficiency)
bool openstudio::model::HeaderedPumpsConstantSpeed::setNumberofPumpsinBank ( int  numberofPumpsinBank)
bool openstudio::model::HeaderedPumpsConstantSpeed::setPumpControlType ( const std::string &  pumpControlType)
bool openstudio::model::HeaderedPumpsConstantSpeed::setPumpFlowRateSchedule ( Schedule schedule)
bool openstudio::model::HeaderedPumpsConstantSpeed::setRatedPowerConsumption ( double  ratedPowerConsumption)
bool openstudio::model::HeaderedPumpsConstantSpeed::setRatedPumpHead ( double  ratedPumpHead)
bool openstudio::model::HeaderedPumpsConstantSpeed::setSkinLossRadiativeFraction ( double  skinLossRadiativeFraction)
bool openstudio::model::HeaderedPumpsConstantSpeed::setThermalZone ( const ThermalZone thermalZone)
bool openstudio::model::HeaderedPumpsConstantSpeed::setTotalRatedFlowRate ( double  totalRatedFlowRate)
double openstudio::model::HeaderedPumpsConstantSpeed::skinLossRadiativeFraction ( ) const
boost::optional<ThermalZone> openstudio::model::HeaderedPumpsConstantSpeed::thermalZone ( ) const
boost::optional<double> openstudio::model::HeaderedPumpsConstantSpeed::totalRatedFlowRate ( ) const

In EnergyPlus 8.5.0 and above this property maps to the EnergyPlus field "Total Design Flow Rate".

Friends And Related Function Documentation