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

#include <PumpConstantSpeed.hpp>

+ Inheritance diagram for openstudio::model::PumpConstantSpeed:

Public Member Functions

void autosizeRatedFlowRate ()
void autosizeRatedPowerConsumption ()
double fractionofMotorInefficienciestoFluidStream () const
Quantity getFractionofMotorInefficienciestoFluidStream (bool returnIP=false) const
OSOptionalQuantity getImpellerDiameter (bool returnIP=false) const
Quantity getMotorEfficiency (bool returnIP=false) const
OSOptionalQuantity getRatedFlowRate (bool returnIP=false) const
OSOptionalQuantity getRatedPowerConsumption (bool returnIP=false) const
Quantity getRatedPumpHead (bool returnIP=false) const
OSOptionalQuantity getRotationalSpeed (bool returnIP=false) const
OSOptionalQuantity getSkinLossRadiativeFraction (bool returnIP=false) const
boost::optional< double > impellerDiameter () const
bool isFractionofMotorInefficienciestoFluidStreamDefaulted () const
bool isMotorEfficiencyDefaulted () const
bool isPumpControlTypeDefaulted () const
bool isRatedFlowRateAutosized () const
bool isRatedPowerConsumptionAutosized () const
bool isRatedPumpHeadDefaulted () const
double motorEfficiency () const
 PumpConstantSpeed (const Model &model)
std::string pumpControlType () const
boost::optional< CurvepumpCurve () const
boost::optional< SchedulepumpFlowRateSchedule () const
boost::optional< double > ratedFlowRate () const
boost::optional< double > ratedPowerConsumption () const
double ratedPumpHead () const
void resetFractionofMotorInefficienciestoFluidStream ()
void resetImpellerDiameter ()
void resetMotorEfficiency ()
void resetPumpControlType ()
void resetPumpCurve ()
void resetPumpFlowRateSchedule ()
void resetRatedFlowRate ()
void resetRatedPowerConsumption ()
void resetRatedPumpHead ()
void resetRotationalSpeed ()
void resetSkinLossRadiativeFraction ()
void resetZone ()
boost::optional< double > rotationalSpeed () const
bool setFractionofMotorInefficienciestoFluidStream (double fractionofMotorInefficienciestoFluidStream)
bool setFractionofMotorInefficienciestoFluidStream (const Quantity &fractionofMotorInefficienciestoFluidStream)
void setImpellerDiameter (double impellerDiameter)
bool setImpellerDiameter (const Quantity &impellerDiameter)
bool setMotorEfficiency (double motorEfficiency)
bool setMotorEfficiency (const Quantity &motorEfficiency)
bool setPumpControlType (std::string pumpControlType)
bool setPumpCurve (const Curve &curve)
bool setPumpFlowRateSchedule (Schedule &schedule)
void setRatedFlowRate (double ratedFlowRate)
bool setRatedFlowRate (const Quantity &ratedFlowRate)
void setRatedPowerConsumption (double ratedPowerConsumption)
bool setRatedPowerConsumption (const Quantity &ratedPowerConsumption)
void setRatedPumpHead (double ratedPumpHead)
bool setRatedPumpHead (const Quantity &ratedPumpHead)
void setRotationalSpeed (double rotationalSpeed)
bool setRotationalSpeed (const Quantity &rotationalSpeed)
bool setSkinLossRadiativeFraction (double skinLossRadiativeFraction)
bool setSkinLossRadiativeFraction (const Quantity &skinLossRadiativeFraction)
bool setZone (const ThermalZone &thermalZone)
boost::optional< double > skinLossRadiativeFraction () const
boost::optional< ThermalZonezone () const
virtual ~PumpConstantSpeed ()
- 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 ()
 Returns the optional ModelObject connected to the inlet port. More...
unsigned inletPort ()
 Returns the inlet port. More...
boost::optional< ModelObjectoutletModelObject ()
 Returns the optional ModelObject connected to the outlet port. More...
unsigned outletPort ()
 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...
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< IdfObjectremove ()
 Removes the HVACComponent from the model only if isRemovable() return true. More...
virtual ~HVACComponent ()
- 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...
< openstudio::Attribute
attributes () const
 Return all Attributes for this ModelObject. More...
< 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...
< 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)
< 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
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 (const std::vector< std::string > &values)
IdfExtensibleGroup pushExtensibleGroup ()
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 IddObjectType iddObjectType ()
static std::vector< std::string > pumpControlTypeValues ()
- 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
< PumpConstantSpeed
typedef std::vector
< PumpConstantSpeed

Additional Inherited Members

- Public Types inherited from openstudio::WorkspaceObject
typedef boost::optional
< WorkspaceObject
typedef std::vector
< WorkspaceObject
- Public Types inherited from openstudio::IdfObject
typedef std::pair< IdfObject,
typedef std::vector< IdfObjectIdfObjectVector
typedef boost::optional
< IdfObject
- 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 Types inherited from openstudio::WorkspaceObject
- Protected Types inherited from openstudio::IdfObject
typedef detail::IdfObject_Impl ImplType
- Protected Member Functions inherited from openstudio::model::HVACComponent
virtual std::vector< ModelObjectchildren () const
 HVACComponent (IddObjectType type, const Model &model)
 Returns the optional ModelObject connected to this object's port. More...
 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)
- 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

PumpConstantSpeed is a StraightComponent that wraps the OpenStudio IDD object 'OS:Pump:ConstantSpeed'.

Constructor & Destructor Documentation

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

Member Function Documentation

void openstudio::model::PumpConstantSpeed::autosizeRatedFlowRate ( )
void openstudio::model::PumpConstantSpeed::autosizeRatedPowerConsumption ( )
double openstudio::model::PumpConstantSpeed::fractionofMotorInefficienciestoFluidStream ( ) const
Quantity openstudio::model::PumpConstantSpeed::getFractionofMotorInefficienciestoFluidStream ( bool  returnIP = false) const
OSOptionalQuantity openstudio::model::PumpConstantSpeed::getImpellerDiameter ( bool  returnIP = false) const
Quantity openstudio::model::PumpConstantSpeed::getMotorEfficiency ( bool  returnIP = false) const
OSOptionalQuantity openstudio::model::PumpConstantSpeed::getRatedFlowRate ( bool  returnIP = false) const
OSOptionalQuantity openstudio::model::PumpConstantSpeed::getRatedPowerConsumption ( bool  returnIP = false) const
Quantity openstudio::model::PumpConstantSpeed::getRatedPumpHead ( bool  returnIP = false) const
OSOptionalQuantity openstudio::model::PumpConstantSpeed::getRotationalSpeed ( bool  returnIP = false) const
OSOptionalQuantity openstudio::model::PumpConstantSpeed::getSkinLossRadiativeFraction ( bool  returnIP = false) const
static IddObjectType openstudio::model::PumpConstantSpeed::iddObjectType ( )
boost::optional<double> openstudio::model::PumpConstantSpeed::impellerDiameter ( ) const
bool openstudio::model::PumpConstantSpeed::isFractionofMotorInefficienciestoFluidStreamDefaulted ( ) const
bool openstudio::model::PumpConstantSpeed::isMotorEfficiencyDefaulted ( ) const
bool openstudio::model::PumpConstantSpeed::isPumpControlTypeDefaulted ( ) const
bool openstudio::model::PumpConstantSpeed::isRatedFlowRateAutosized ( ) const
bool openstudio::model::PumpConstantSpeed::isRatedPowerConsumptionAutosized ( ) const
bool openstudio::model::PumpConstantSpeed::isRatedPumpHeadDefaulted ( ) const
double openstudio::model::PumpConstantSpeed::motorEfficiency ( ) const
std::string openstudio::model::PumpConstantSpeed::pumpControlType ( ) const
static std::vector<std::string> openstudio::model::PumpConstantSpeed::pumpControlTypeValues ( )
boost::optional<Curve> openstudio::model::PumpConstantSpeed::pumpCurve ( ) const
boost::optional<Schedule> openstudio::model::PumpConstantSpeed::pumpFlowRateSchedule ( ) const
boost::optional<double> openstudio::model::PumpConstantSpeed::ratedFlowRate ( ) const
boost::optional<double> openstudio::model::PumpConstantSpeed::ratedPowerConsumption ( ) const
double openstudio::model::PumpConstantSpeed::ratedPumpHead ( ) const
void openstudio::model::PumpConstantSpeed::resetFractionofMotorInefficienciestoFluidStream ( )
void openstudio::model::PumpConstantSpeed::resetImpellerDiameter ( )
void openstudio::model::PumpConstantSpeed::resetMotorEfficiency ( )
void openstudio::model::PumpConstantSpeed::resetPumpControlType ( )
void openstudio::model::PumpConstantSpeed::resetPumpCurve ( )
void openstudio::model::PumpConstantSpeed::resetPumpFlowRateSchedule ( )
void openstudio::model::PumpConstantSpeed::resetRatedFlowRate ( )
void openstudio::model::PumpConstantSpeed::resetRatedPowerConsumption ( )
void openstudio::model::PumpConstantSpeed::resetRatedPumpHead ( )
void openstudio::model::PumpConstantSpeed::resetRotationalSpeed ( )
void openstudio::model::PumpConstantSpeed::resetSkinLossRadiativeFraction ( )
void openstudio::model::PumpConstantSpeed::resetZone ( )
boost::optional<double> openstudio::model::PumpConstantSpeed::rotationalSpeed ( ) const
bool openstudio::model::PumpConstantSpeed::setFractionofMotorInefficienciestoFluidStream ( double  fractionofMotorInefficienciestoFluidStream)
bool openstudio::model::PumpConstantSpeed::setFractionofMotorInefficienciestoFluidStream ( const Quantity fractionofMotorInefficienciestoFluidStream)
void openstudio::model::PumpConstantSpeed::setImpellerDiameter ( double  impellerDiameter)
bool openstudio::model::PumpConstantSpeed::setImpellerDiameter ( const Quantity impellerDiameter)
bool openstudio::model::PumpConstantSpeed::setMotorEfficiency ( double  motorEfficiency)
bool openstudio::model::PumpConstantSpeed::setMotorEfficiency ( const Quantity motorEfficiency)
bool openstudio::model::PumpConstantSpeed::setPumpControlType ( std::string  pumpControlType)
bool openstudio::model::PumpConstantSpeed::setPumpCurve ( const Curve curve)
bool openstudio::model::PumpConstantSpeed::setPumpFlowRateSchedule ( Schedule schedule)
void openstudio::model::PumpConstantSpeed::setRatedFlowRate ( double  ratedFlowRate)
bool openstudio::model::PumpConstantSpeed::setRatedFlowRate ( const Quantity ratedFlowRate)
void openstudio::model::PumpConstantSpeed::setRatedPowerConsumption ( double  ratedPowerConsumption)
bool openstudio::model::PumpConstantSpeed::setRatedPowerConsumption ( const Quantity ratedPowerConsumption)
void openstudio::model::PumpConstantSpeed::setRatedPumpHead ( double  ratedPumpHead)
bool openstudio::model::PumpConstantSpeed::setRatedPumpHead ( const Quantity ratedPumpHead)
void openstudio::model::PumpConstantSpeed::setRotationalSpeed ( double  rotationalSpeed)
bool openstudio::model::PumpConstantSpeed::setRotationalSpeed ( const Quantity rotationalSpeed)
bool openstudio::model::PumpConstantSpeed::setSkinLossRadiativeFraction ( double  skinLossRadiativeFraction)
bool openstudio::model::PumpConstantSpeed::setSkinLossRadiativeFraction ( const Quantity skinLossRadiativeFraction)
bool openstudio::model::PumpConstantSpeed::setZone ( const ThermalZone thermalZone)
boost::optional<double> openstudio::model::PumpConstantSpeed::skinLossRadiativeFraction ( ) const
boost::optional<ThermalZone> openstudio::model::PumpConstantSpeed::zone ( ) const

Friends And Related Function Documentation

typedef boost::optional<PumpConstantSpeed> OptionalPumpConstantSpeed
typedef std::vector<PumpConstantSpeed> PumpConstantSpeedVector