 |
OpenStudio:model |
#include <HeaderedPumpsVariableSpeed.hpp>
Inheritance diagram for openstudio::model::HeaderedPumpsVariableSpeed:Public Member Functions | |
Constructors and Destructors | |
| HeaderedPumpsVariableSpeed (const Model &model) | |
| virtual | ~HeaderedPumpsVariableSpeed ()=default |
| HeaderedPumpsVariableSpeed (const HeaderedPumpsVariableSpeed &other)=default | |
| HeaderedPumpsVariableSpeed (HeaderedPumpsVariableSpeed &&other)=default | |
| HeaderedPumpsVariableSpeed & | operator= (const HeaderedPumpsVariableSpeed &)=default |
| HeaderedPumpsVariableSpeed & | operator= (HeaderedPumpsVariableSpeed &&)=default |
Getters | |
| 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 |
| double | coefficient1ofthePartLoadPerformanceCurve () const |
| double | coefficient2ofthePartLoadPerformanceCurve () const |
| double | coefficient3ofthePartLoadPerformanceCurve () const |
| double | coefficient4ofthePartLoadPerformanceCurve () const |
| double | minimumFlowRateFraction () const |
| std::string | pumpControlType () const |
| boost::optional< Schedule > | pumpFlowRateSchedule () const |
| boost::optional< ThermalZone > | thermalZone () const |
| double | skinLossRadiativeFraction () const |
| std::string | designPowerSizingMethod () const |
| double | designElectricPowerPerUnitFlowRate () const |
| double | designShaftPowerPerUnitFlowRatePerUnitHead () const |
| std::string | endUseSubcategory () const |
Setters | |
| 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 | setCoefficient1ofthePartLoadPerformanceCurve (double coefficient1ofthePartLoadPerformanceCurve) |
| bool | setCoefficient2ofthePartLoadPerformanceCurve (double coefficient2ofthePartLoadPerformanceCurve) |
| bool | setCoefficient3ofthePartLoadPerformanceCurve (double coefficient3ofthePartLoadPerformanceCurve) |
| bool | setCoefficient4ofthePartLoadPerformanceCurve (double coefficient4ofthePartLoadPerformanceCurve) |
| bool | setMinimumFlowRateFraction (double minimumFlowRateFraction) |
| 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) |
Other | |
| boost::optional< double > | autosizedTotalRatedFlowRate () const |
| boost::optional< double > | autosizedRatedPowerConsumption () const |
| Public Member Functions inherited from openstudio::model::StraightComponent | |
| bool | addToNode (Node &node) |
| boost::optional< AirLoopHVAC > | airLoopHVAC () const |
| Returns the optional AirLoopHVAC object that this AirToAirComponent is attached to. More... | |
| ModelObject | clone (Model model) const |
| void | disconnect () |
| boost::optional< ModelObject > | inletModelObject () const |
| Returns the optional ModelObject connected to the inlet port. More... | |
| unsigned | inletPort () const |
| Returns the inlet port. More... | |
| StraightComponent & | operator= (const StraightComponent &)=default |
| StraightComponent & | operator= (StraightComponent &&)=default |
| boost::optional< ModelObject > | outletModelObject () const |
| Returns the optional ModelObject connected to the outlet port. More... | |
| unsigned | outletPort () const |
| Returns the outlet port. More... | |
| std::vector < openstudio::IdfObject > | remove () |
| bool | removeFromLoop () |
| StraightComponent (IddObjectType type, const Model &model) | |
| StraightComponent (const StraightComponent &other)=default | |
| StraightComponent (StraightComponent &&other)=default | |
| virtual | ~StraightComponent ()=default |
| 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< AirLoopHVAC > | airLoopHVAC () const |
| Returns the optional AirLoopHVAC object that the HVAC component is attached to. More... | |
| boost::optional < AirLoopHVACOutdoorAirSystem > | airLoopHVACOutdoorAirSystem () const |
| Returns the optional AirLoopHVACOutdoorAirSystem that the HVAC component is attached to. More... | |
| std::vector< AppGFuelType > | appGHeatingFuelTypes () const |
| void | applySizingValues () |
| void | autosize () |
| Returns the optional ModelObject connected to this object's port. More... | |
| ComponentType | componentType () const |
| boost::optional< HVACComponent > | containingHVACComponent () const |
| EnergyPlus unitary equipment and air terminals are typically composed of other HVAC components. More... | |
| boost::optional < StraightComponent > | containingStraightComponent () const |
| boost::optional < ZoneHVACComponent > | containingZoneHVACComponent () const |
| Returns any ZoneHVACComponent that contains this HVACComponent. More... | |
| std::vector< FuelType > | coolingFuelTypes () const |
| void | disconnect () |
| Removes all connections to other HVACComponent objects. More... | |
| std::vector< FuelType > | heatingFuelTypes () const |
| HVACComponent (const HVACComponent &other)=default | |
| HVACComponent (HVACComponent &&other)=default | |
| bool | isRemovable () const |
| Indicates if the HVACComponent can be removed from the model. More... | |
| boost::optional< Loop > | loop () const |
| Returns the optional Loop object that the HVAC component is attached to. More... | |
| HVACComponent & | operator= (const HVACComponent &)=default |
| HVACComponent & | operator= (HVACComponent &&)=default |
| boost::optional< PlantLoop > | plantLoop () 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 ()=default |
| Public Member Functions inherited from openstudio::model::ParentObject | |
| std::vector< IddObjectType > | allowableChildTypes () const |
| Returns a vector of allowable children types. More... | |
| std::vector< ModelObject > | children () const |
| Return direct child objects in the Model. More... | |
| ParentObject & | operator= (const ParentObject &)=default |
| ParentObject & | operator= (ParentObject &&)=default |
| ParentObject (const ParentObject &other)=default | |
| ParentObject (ParentObject &&other)=default | |
| virtual | ~ParentObject ()=default |
| Public Member Functions inherited from openstudio::model::ModelObject | |
| virtual | ~ModelObject ()=default |
| ModelObject (const ModelObject &other)=default | |
| ModelObject (ModelObject &&other)=default | |
| ModelObject & | operator= (const ModelObject &)=default |
| ModelObject & | operator= (ModelObject &&)=default |
| 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< ParentObject > | parent () const |
| Return this object's parent in the hierarchy, if it has one. More... | |
| std::vector< ResourceObject > | resources () 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< OutputVariable > | outputVariables () 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< LifeCycleCost > | lifeCycleCosts () 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... | |
| boost::optional< std::string > | cadObjectId () const |
| bool | setCADObjectId (const std::string &cadObjectId) |
| boost::optional< std::string > | gbXMLId () const |
| bool | setGBXMLId (const std::string &gbXMLId) |
| boost::optional< std::string > | displayName () const |
| bool | setDisplayName (const std::string &displayName) |
| 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< ScheduleTypeKey > | getScheduleTypeKeys (const Schedule &schedule) const |
| Return the ScheduleTypeKeys indicating how schedule is used in this object. More... | |
| boost::optional< double > | getAutosizedValue (const std::string &valueName, const std::string &units) 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< ModelObject > | connectedObject (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.) | |
| using | HeaderedPumpsVariableSpeedVector = std::vector< HeaderedPumpsVariableSpeed > |
| using | OptionalHeaderedPumpsVariableSpeed = boost::optional< HeaderedPumpsVariableSpeed > |
| Related Functions inherited from openstudio::model::ParentObject | |
| std::vector< ModelObject > | getRecursiveChildren (const ParentObject &object, bool includeLifeCycleCostsAndAdditionalProperties=false, bool includeUsedResources=true) |
| Returns object and all other objects accessible by calling children() on encountered ParentObjects . More... | |
| std::vector< ModelObject > | getRecursiveChildrenAndResources (const ModelObject &object) |
| Returns object and all other objects accessible by calling children() and resources() on encountered ModelObjects . More... | |
| Related Functions inherited from openstudio::model::ModelObject | |
| std::vector< ResourceObject > | getRecursiveResources (const ModelObject &object) |
| Returns all ResourceObjects accessible by recursively calling .resources() starting from object. More... | |
Additional Inherited Members | |
| Protected Types inherited from openstudio::model::HVACComponent | |
| using | ImplType = detail::HVACComponent_Impl |
| Protected Types inherited from openstudio::model::ModelObject | |
| using | ImplType = detail::ModelObject_Impl |
| Protected Member Functions inherited from openstudio::model::HVACComponent | |
| virtual std::vector< ModelObject > | children () 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) | |
HeaderedPumpsVariableSpeed is a StraightComponent that wraps the OpenStudio IDD object 'OS:HeaderedPumps:VariableSpeed'.
|
explicit |
|
virtualdefault |
|
default |
|
default |
| boost::optional<double> openstudio::model::HeaderedPumpsVariableSpeed::autosizedRatedPowerConsumption | ( | ) | const |
| boost::optional<double> openstudio::model::HeaderedPumpsVariableSpeed::autosizedTotalRatedFlowRate | ( | ) | const |
| void openstudio::model::HeaderedPumpsVariableSpeed::autosizeRatedPowerConsumption | ( | ) |
| void openstudio::model::HeaderedPumpsVariableSpeed::autosizeTotalRatedFlowRate | ( | ) |
| double openstudio::model::HeaderedPumpsVariableSpeed::coefficient1ofthePartLoadPerformanceCurve | ( | ) | const |
| double openstudio::model::HeaderedPumpsVariableSpeed::coefficient2ofthePartLoadPerformanceCurve | ( | ) | const |
| double openstudio::model::HeaderedPumpsVariableSpeed::coefficient3ofthePartLoadPerformanceCurve | ( | ) | const |
| double openstudio::model::HeaderedPumpsVariableSpeed::coefficient4ofthePartLoadPerformanceCurve | ( | ) | const |
| double openstudio::model::HeaderedPumpsVariableSpeed::designElectricPowerPerUnitFlowRate | ( | ) | const |
| std::string openstudio::model::HeaderedPumpsVariableSpeed::designPowerSizingMethod | ( | ) | const |
|
static |
| double openstudio::model::HeaderedPumpsVariableSpeed::designShaftPowerPerUnitFlowRatePerUnitHead | ( | ) | const |
| std::string openstudio::model::HeaderedPumpsVariableSpeed::endUseSubcategory | ( | ) | const |
| std::string openstudio::model::HeaderedPumpsVariableSpeed::flowSequencingControlScheme | ( | ) | const |
|
static |
| double openstudio::model::HeaderedPumpsVariableSpeed::fractionofMotorInefficienciestoFluidStream | ( | ) | const |
|
static |
| bool openstudio::model::HeaderedPumpsVariableSpeed::isRatedPowerConsumptionAutosized | ( | ) | const |
| bool openstudio::model::HeaderedPumpsVariableSpeed::isTotalRatedFlowRateAutosized | ( | ) | const |
| double openstudio::model::HeaderedPumpsVariableSpeed::minimumFlowRateFraction | ( | ) | const |
| double openstudio::model::HeaderedPumpsVariableSpeed::motorEfficiency | ( | ) | const |
| int openstudio::model::HeaderedPumpsVariableSpeed::numberofPumpsinBank | ( | ) | const |
|
default |
|
default |
| std::string openstudio::model::HeaderedPumpsVariableSpeed::pumpControlType | ( | ) | const |
|
static |
| boost::optional<Schedule> openstudio::model::HeaderedPumpsVariableSpeed::pumpFlowRateSchedule | ( | ) | const |
| boost::optional<double> openstudio::model::HeaderedPumpsVariableSpeed::ratedPowerConsumption | ( | ) | const |
In EnergyPlus 8.5.0 and above this property maps to the EnergyPlus field "Design Power Consumption".
| double openstudio::model::HeaderedPumpsVariableSpeed::ratedPumpHead | ( | ) | const |
In EnergyPlus 8.5.0 and above this property maps to the EnergyPlus field "Design Pump Head".
| void openstudio::model::HeaderedPumpsVariableSpeed::resetPumpFlowRateSchedule | ( | ) |
| void openstudio::model::HeaderedPumpsVariableSpeed::resetThermalZone | ( | ) |
| bool openstudio::model::HeaderedPumpsVariableSpeed::setCoefficient1ofthePartLoadPerformanceCurve | ( | double | coefficient1ofthePartLoadPerformanceCurve | ) |
| bool openstudio::model::HeaderedPumpsVariableSpeed::setCoefficient2ofthePartLoadPerformanceCurve | ( | double | coefficient2ofthePartLoadPerformanceCurve | ) |
| bool openstudio::model::HeaderedPumpsVariableSpeed::setCoefficient3ofthePartLoadPerformanceCurve | ( | double | coefficient3ofthePartLoadPerformanceCurve | ) |
| bool openstudio::model::HeaderedPumpsVariableSpeed::setCoefficient4ofthePartLoadPerformanceCurve | ( | double | coefficient4ofthePartLoadPerformanceCurve | ) |
| bool openstudio::model::HeaderedPumpsVariableSpeed::setDesignElectricPowerPerUnitFlowRate | ( | double | designElectricPowerPerUnitFlowRate | ) |
| bool openstudio::model::HeaderedPumpsVariableSpeed::setDesignPowerSizingMethod | ( | const std::string & | designPowerSizingMethod | ) |
| bool openstudio::model::HeaderedPumpsVariableSpeed::setDesignShaftPowerPerUnitFlowRatePerUnitHead | ( | double | designShaftPowerPerUnitFlowRatePerUnitHead | ) |
| bool openstudio::model::HeaderedPumpsVariableSpeed::setEndUseSubcategory | ( | const std::string & | endUseSubcategory | ) |
| bool openstudio::model::HeaderedPumpsVariableSpeed::setFlowSequencingControlScheme | ( | const std::string & | flowSequencingControlScheme | ) |
| bool openstudio::model::HeaderedPumpsVariableSpeed::setFractionofMotorInefficienciestoFluidStream | ( | double | fractionofMotorInefficienciestoFluidStream | ) |
| bool openstudio::model::HeaderedPumpsVariableSpeed::setMinimumFlowRateFraction | ( | double | minimumFlowRateFraction | ) |
| bool openstudio::model::HeaderedPumpsVariableSpeed::setMotorEfficiency | ( | double | motorEfficiency | ) |
| bool openstudio::model::HeaderedPumpsVariableSpeed::setNumberofPumpsinBank | ( | int | numberofPumpsinBank | ) |
| bool openstudio::model::HeaderedPumpsVariableSpeed::setPumpControlType | ( | const std::string & | pumpControlType | ) |
| bool openstudio::model::HeaderedPumpsVariableSpeed::setPumpFlowRateSchedule | ( | Schedule & | schedule | ) |
| bool openstudio::model::HeaderedPumpsVariableSpeed::setRatedPowerConsumption | ( | double | ratedPowerConsumption | ) |
| bool openstudio::model::HeaderedPumpsVariableSpeed::setRatedPumpHead | ( | double | ratedPumpHead | ) |
| bool openstudio::model::HeaderedPumpsVariableSpeed::setSkinLossRadiativeFraction | ( | double | skinLossRadiativeFraction | ) |
| bool openstudio::model::HeaderedPumpsVariableSpeed::setThermalZone | ( | const ThermalZone & | thermalZone | ) |
| bool openstudio::model::HeaderedPumpsVariableSpeed::setTotalRatedFlowRate | ( | double | totalRatedFlowRate | ) |
| double openstudio::model::HeaderedPumpsVariableSpeed::skinLossRadiativeFraction | ( | ) | const |
| boost::optional<ThermalZone> openstudio::model::HeaderedPumpsVariableSpeed::thermalZone | ( | ) | const |
| boost::optional<double> openstudio::model::HeaderedPumpsVariableSpeed::totalRatedFlowRate | ( | ) | const |
In EnergyPlus 8.5.0 and above this property maps to the EnergyPlus field "Total Design Flow Rate".
|
related |
|
related |