|
|
| PumpVariableSpeed (const Model &model) |
|
virtual | ~PumpVariableSpeed () |
|
|
boost::optional< double > | ratedFlowRate () const |
| In EnergyPlus 8.5.0 and above this property maps to the EnergyPlus field "Design Maximum Flow Rate". More...
|
|
OSOptionalQuantity | getRatedFlowRate (bool returnIP=false) const |
|
bool | isRatedFlowRateDefaulted () const |
|
bool | isRatedFlowRateAutosized () const |
|
double | ratedPumpHead () const |
| In EnergyPlus 8.5.0 and above this property maps to the EnergyPlus field "Design Pump Head". More...
|
|
Quantity | getRatedPumpHead (bool returnIP=false) const |
|
bool | isRatedPumpHeadDefaulted () const |
|
boost::optional< double > | ratedPowerConsumption () const |
| In EnergyPlus 8.5.0 and above this property maps to the EnergyPlus field "Design Power Consumption". More...
|
|
OSOptionalQuantity | getRatedPowerConsumption (bool returnIP=false) const |
|
bool | isRatedPowerConsumptionDefaulted () const |
|
bool | isRatedPowerConsumptionAutosized () const |
|
double | motorEfficiency () const |
|
Quantity | getMotorEfficiency (bool returnIP=false) const |
|
bool | isMotorEfficiencyDefaulted () const |
|
double | fractionofMotorInefficienciestoFluidStream () const |
|
Quantity | getFractionofMotorInefficienciestoFluidStream (bool returnIP=false) const |
|
bool | isFractionofMotorInefficienciestoFluidStreamDefaulted () const |
|
double | coefficient1ofthePartLoadPerformanceCurve () const |
|
Quantity | getCoefficient1ofthePartLoadPerformanceCurve (bool returnIP=false) const |
|
bool | isCoefficient1ofthePartLoadPerformanceCurveDefaulted () const |
|
double | coefficient2ofthePartLoadPerformanceCurve () const |
|
Quantity | getCoefficient2ofthePartLoadPerformanceCurve (bool returnIP=false) const |
|
bool | isCoefficient2ofthePartLoadPerformanceCurveDefaulted () const |
|
double | coefficient3ofthePartLoadPerformanceCurve () const |
|
Quantity | getCoefficient3ofthePartLoadPerformanceCurve (bool returnIP=false) const |
|
bool | isCoefficient3ofthePartLoadPerformanceCurveDefaulted () const |
|
double | coefficient4ofthePartLoadPerformanceCurve () const |
|
Quantity | getCoefficient4ofthePartLoadPerformanceCurve (bool returnIP=false) const |
|
bool | isCoefficient4ofthePartLoadPerformanceCurveDefaulted () const |
|
double | minimumFlowRate () const |
| In EnergyPlus 8.5.0 and above this property maps to the EnergyPlus field "Design Minimum Flow Rate". More...
|
|
Quantity | getMinimumFlowRate (bool returnIP=false) const |
|
bool | isMinimumFlowRateDefaulted () const |
|
std::string | pumpControlType () const |
|
bool | isPumpControlTypeDefaulted () const |
|
boost::optional< Schedule > | pumpFlowRateSchedule () const |
|
boost::optional< Curve > | pumpCurve () const |
|
boost::optional< double > | impellerDiameter () const |
|
OSOptionalQuantity | getImpellerDiameter (bool returnIP=false) const |
|
boost::optional< std::string > | vFDControlType () const |
|
boost::optional< Schedule > | pumpRPMSchedule () const |
|
boost::optional< Schedule > | minimumPressureSchedule () const |
|
boost::optional< Schedule > | maximumPressureSchedule () const |
|
boost::optional< Schedule > | minimumRPMSchedule () const |
|
boost::optional< Schedule > | maximumRPMSchedule () const |
|
|
bool | setRatedFlowRate (double ratedFlowRate) |
|
bool | setRatedFlowRate (const Quantity &ratedFlowRate) |
|
void | resetRatedFlowRate () |
|
void | autosizeRatedFlowRate () |
|
bool | setRatedPumpHead (double ratedPumpHead) |
|
bool | setRatedPumpHead (const Quantity &ratedPumpHead) |
|
void | resetRatedPumpHead () |
|
bool | setRatedPowerConsumption (double ratedPowerConsumption) |
|
bool | setRatedPowerConsumption (const Quantity &ratedPowerConsumption) |
|
void | resetRatedPowerConsumption () |
|
void | autosizeRatedPowerConsumption () |
|
bool | setMotorEfficiency (double motorEfficiency) |
|
bool | setMotorEfficiency (const Quantity &motorEfficiency) |
|
void | resetMotorEfficiency () |
|
bool | setFractionofMotorInefficienciestoFluidStream (double fractionofMotorInefficienciestoFluidStream) |
|
bool | setFractionofMotorInefficienciestoFluidStream (const Quantity &fractionofMotorInefficienciestoFluidStream) |
|
void | resetFractionofMotorInefficienciestoFluidStream () |
|
bool | setCoefficient1ofthePartLoadPerformanceCurve (double coefficient1ofthePartLoadPerformanceCurve) |
|
bool | setCoefficient1ofthePartLoadPerformanceCurve (const Quantity &coefficient1ofthePartLoadPerformanceCurve) |
|
void | resetCoefficient1ofthePartLoadPerformanceCurve () |
|
bool | setCoefficient2ofthePartLoadPerformanceCurve (double coefficient2ofthePartLoadPerformanceCurve) |
|
bool | setCoefficient2ofthePartLoadPerformanceCurve (const Quantity &coefficient2ofthePartLoadPerformanceCurve) |
|
void | resetCoefficient2ofthePartLoadPerformanceCurve () |
|
bool | setCoefficient3ofthePartLoadPerformanceCurve (double coefficient3ofthePartLoadPerformanceCurve) |
|
bool | setCoefficient3ofthePartLoadPerformanceCurve (const Quantity &coefficient3ofthePartLoadPerformanceCurve) |
|
void | resetCoefficient3ofthePartLoadPerformanceCurve () |
|
bool | setCoefficient4ofthePartLoadPerformanceCurve (double coefficient4ofthePartLoadPerformanceCurve) |
|
bool | setCoefficient4ofthePartLoadPerformanceCurve (const Quantity &coefficient4ofthePartLoadPerformanceCurve) |
|
void | resetCoefficient4ofthePartLoadPerformanceCurve () |
|
bool | setMinimumFlowRate (double minimumFlowRate) |
|
bool | setMinimumFlowRate (const Quantity &minimumFlowRate) |
|
void | resetMinimumFlowRate () |
|
bool | setPumpControlType (std::string pumpControlType) |
|
void | resetPumpControlType () |
|
bool | setPumpFlowRateSchedule (Schedule &schedule) |
|
void | resetPumpFlowRateSchedule () |
|
bool | setPumpCurve (const Curve &curve) |
| Returns false if curve is not a CurveLinear, CurveQuadratic, CurveCubic or CurveQuartic. More...
|
|
void | resetPumpCurve () |
|
bool | setImpellerDiameter (double impellerDiameter) |
|
bool | setImpellerDiameter (const Quantity &impellerDiameter) |
|
void | resetImpellerDiameter () |
|
bool | setVFDControlType (std::string vFDControlType) |
|
void | resetVFDControlType () |
|
bool | setPumpRPMSchedule (Schedule &schedule) |
|
void | resetPumpRPMSchedule () |
|
bool | setMinimumPressureSchedule (Schedule &schedule) |
|
void | resetMinimumPressureSchedule () |
|
bool | setMaximumPressureSchedule (Schedule &schedule) |
|
void | resetMaximumPressureSchedule () |
|
bool | setMinimumRPMSchedule (Schedule &schedule) |
|
void | resetMinimumRPMSchedule () |
|
bool | setMaximumRPMSchedule (Schedule &schedule) |
|
void | resetMaximumRPMSchedule () |
|
boost::optional< double > | autosizedRatedFlowRate () const |
|
boost::optional< double > | autosizedRatedPowerConsumption () const |
|
std::string | designPowerSizingMethod () const |
|
bool | setDesignPowerSizingMethod (const std::string &designPowerSizingMethod) |
|
double | designElectricPowerPerUnitFlowRate () const |
|
bool | setDesignElectricPowerPerUnitFlowRate (double designElectricPowerPerUnitFlowRate) |
|
double | designShaftPowerPerUnitFlowRatePerUnitHead () const |
|
bool | setDesignShaftPowerPerUnitFlowRatePerUnitHead (double designShaftPowerPerUnitFlowRatePerUnitHead) |
|
boost::optional< ThermalZone > | zone () const |
|
bool | setZone (const ThermalZone &thermalZone) |
|
void | resetZone () |
|
double | skinLossRadiativeFraction () const |
|
bool | setSkinLossRadiativeFraction (double skinLossRadiativeFraction) |
|
double | designMinimumFlowRateFraction () const |
|
bool | setDesignMinimumFlowRateFraction (double designMinimumFlowRateFraction) |
|
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...
|
|
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) |
|
virtual | ~StraightComponent () |
|
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...
|
|
void | applySizingValues () |
|
void | autosize () |
| Returns the optional ModelObject connected to this object's port. More...
|
|
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...
|
|
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< Loop > | loop () const |
| Returns the optional Loop object that the HVAC component is attached to. More...
|
|
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 () |
|
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...
|
|
virtual | ~ParentObject () |
|
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< 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...
|
|
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 (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< ModelObject > | connectedObject (unsigned port) const |
|
boost::optional< unsigned > | connectedObjectPort (unsigned port) const |
|
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< WorkspaceObject > | getSources (IddObjectType type) const |
|
boost::optional< WorkspaceObject > | getTarget (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) |
|
std::vector
< openstudio::IdfObject > | remove () |
|
bool | setPointer (unsigned index, const Handle &targetHandle) |
|
std::vector< WorkspaceObject > | sources () const |
|
std::vector< WorkspaceObject > | targets () const |
|
Workspace | workspace () const |
|
virtual | ~WorkspaceObject () |
|
std::string | briefDescription () const |
|
T | 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< IdfExtensibleGroup > | extensibleGroups () 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< int > | getInt (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, bool checkNames=false) 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 |
|
std::string | nameString (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 () |
|
IdfExtensibleGroup | pushExtensibleGroup (const std::vector< std::string > &values) |
|
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=false) const |
|
virtual | ~IdfObject () |
|