|
|
| WaterHeaterStratified (const Model &model) |
|
virtual | ~WaterHeaterStratified () |
|
|
std::string | endUseSubcategory () const |
|
boost::optional< double > | tankVolume () const |
|
bool | isTankVolumeAutosized () const |
|
boost::optional< double > | tankHeight () const |
|
bool | isTankHeightAutosized () const |
|
std::string | tankShape () const |
|
boost::optional< double > | tankPerimeter () const |
|
double | maximumTemperatureLimit () const |
|
std::string | heaterPriorityControl () const |
|
Schedule | heater1SetpointTemperatureSchedule () const |
|
double | heater1DeadbandTemperatureDifference () const |
|
boost::optional< double > | heater1Capacity () const |
|
bool | isHeater1CapacityAutosized () const |
|
double | heater1Height () const |
|
Schedule | heater2SetpointTemperatureSchedule () const |
|
double | heater2DeadbandTemperatureDifference () const |
|
double | heater2Capacity () const |
|
double | heater2Height () const |
|
std::string | heaterFuelType () const |
|
double | heaterThermalEfficiency () const |
|
double | offCycleParasiticFuelConsumptionRate () const |
|
std::string | offCycleParasiticFuelType () const |
|
double | offCycleParasiticHeatFractiontoTank () const |
|
double | offCycleParasiticHeight () const |
|
double | onCycleParasiticFuelConsumptionRate () const |
|
std::string | onCycleParasiticFuelType () const |
|
double | onCycleParasiticHeatFractiontoTank () const |
|
double | onCycleParasiticHeight () const |
|
std::string | ambientTemperatureIndicator () const |
|
boost::optional< Schedule > | ambientTemperatureSchedule () const |
|
boost::optional< ThermalZone > | ambientTemperatureThermalZone () const |
|
boost::optional< std::string > | ambientTemperatureOutdoorAirNodeName () const |
|
boost::optional< double > | uniformSkinLossCoefficientperUnitAreatoAmbientTemperature () const |
|
double | skinLossFractiontoZone () const |
|
boost::optional< double > | offCycleFlueLossCoefficienttoAmbientTemperature () const |
|
double | offCycleFlueLossFractiontoZone () const |
|
boost::optional< double > | peakUseFlowRate () const |
|
boost::optional< Schedule > | useFlowRateFractionSchedule () const |
|
boost::optional< Schedule > | coldWaterSupplyTemperatureSchedule () const |
|
double | useSideEffectiveness () const |
|
double | useSideInletHeight () const |
|
boost::optional< double > | useSideOutletHeight () const |
|
bool | isUseSideOutletHeightAutocalculated () const |
|
double | sourceSideEffectiveness () const |
|
boost::optional< double > | sourceSideInletHeight () const |
|
bool | isSourceSideInletHeightAutocalculated () const |
|
double | sourceSideOutletHeight () const |
|
std::string | inletMode () const |
|
boost::optional< double > | useSideDesignFlowRate () const |
|
bool | isUseSideDesignFlowRateAutosized () const |
|
boost::optional< double > | sourceSideDesignFlowRate () const |
|
bool | isSourceSideDesignFlowRateAutosized () const |
|
double | indirectWaterHeatingRecoveryTime () const |
|
int | numberofNodes () const |
|
double | additionalDestratificationConductivity () const |
|
double | node1AdditionalLossCoefficient () const |
|
double | node2AdditionalLossCoefficient () const |
|
double | node3AdditionalLossCoefficient () const |
|
double | node4AdditionalLossCoefficient () const |
|
double | node5AdditionalLossCoefficient () const |
|
double | node6AdditionalLossCoefficient () const |
|
double | node7AdditionalLossCoefficient () const |
|
double | node8AdditionalLossCoefficient () const |
|
double | node9AdditionalLossCoefficient () const |
|
double | node10AdditionalLossCoefficient () const |
|
std::string | sourceSideFlowControlMode () const |
|
boost::optional< Schedule > | indirectAlternateSetpointTemperatureSchedule () const |
|
|
void | setEndUseSubcategory (std::string endUseSubcategory) |
|
bool | setTankVolume (double tankVolume) |
|
void | autosizeTankVolume () |
|
bool | setTankHeight (double tankHeight) |
|
void | autosizeTankHeight () |
|
bool | setTankShape (std::string tankShape) |
|
bool | setTankPerimeter (double tankPerimeter) |
|
void | resetTankPerimeter () |
|
void | setMaximumTemperatureLimit (double maximumTemperatureLimit) |
|
bool | setHeaterPriorityControl (std::string heaterPriorityControl) |
|
bool | setHeater1SetpointTemperatureSchedule (Schedule &schedule) |
|
bool | setHeater1DeadbandTemperatureDifference (double heater1DeadbandTemperatureDifference) |
|
bool | setHeater1Capacity (double heater1Capacity) |
|
void | autosizeHeater1Capacity () |
|
bool | setHeater1Height (double heater1Height) |
|
bool | setHeater2SetpointTemperatureSchedule (Schedule &schedule) |
|
bool | setHeater2DeadbandTemperatureDifference (double heater2DeadbandTemperatureDifference) |
|
bool | setHeater2Capacity (double heater2Capacity) |
|
bool | setHeater2Height (double heater2Height) |
|
bool | setHeaterFuelType (std::string heaterFuelType) |
|
bool | setHeaterThermalEfficiency (double heaterThermalEfficiency) |
|
bool | setOffCycleParasiticFuelConsumptionRate (double offCycleParasiticFuelConsumptionRate) |
|
bool | setOffCycleParasiticFuelType (std::string offCycleParasiticFuelType) |
|
bool | setOffCycleParasiticHeatFractiontoTank (double offCycleParasiticHeatFractiontoTank) |
|
bool | setOffCycleParasiticHeight (double offCycleParasiticHeight) |
|
bool | setOnCycleParasiticFuelConsumptionRate (double onCycleParasiticFuelConsumptionRate) |
|
bool | setOnCycleParasiticFuelType (std::string onCycleParasiticFuelType) |
|
bool | setOnCycleParasiticHeatFractiontoTank (double onCycleParasiticHeatFractiontoTank) |
|
bool | setOnCycleParasiticHeight (double onCycleParasiticHeight) |
|
bool | setAmbientTemperatureIndicator (std::string ambientTemperatureIndicator) |
|
bool | setAmbientTemperatureSchedule (Schedule &schedule) |
|
void | resetAmbientTemperatureSchedule () |
|
bool | setAmbientTemperatureThermalZone (const ThermalZone &thermalZone) |
|
void | resetAmbientTemperatureThermalZone () |
|
void | setAmbientTemperatureOutdoorAirNodeName (std::string ambientTemperatureOutdoorAirNodeName) |
|
void | resetAmbientTemperatureOutdoorAirNodeName () |
|
bool | setUniformSkinLossCoefficientperUnitAreatoAmbientTemperature (double uniformSkinLossCoefficientperUnitAreatoAmbientTemperature) |
|
void | resetUniformSkinLossCoefficientperUnitAreatoAmbientTemperature () |
|
bool | setSkinLossFractiontoZone (double skinLossFractiontoZone) |
|
bool | setOffCycleFlueLossCoefficienttoAmbientTemperature (double offCycleFlueLossCoefficienttoAmbientTemperature) |
|
void | resetOffCycleFlueLossCoefficienttoAmbientTemperature () |
|
bool | setOffCycleFlueLossFractiontoZone (double offCycleFlueLossFractiontoZone) |
|
bool | setPeakUseFlowRate (double peakUseFlowRate) |
|
void | resetPeakUseFlowRate () |
|
bool | setUseFlowRateFractionSchedule (Schedule &schedule) |
|
void | resetUseFlowRateFractionSchedule () |
|
bool | setColdWaterSupplyTemperatureSchedule (Schedule &schedule) |
|
void | resetColdWaterSupplyTemperatureSchedule () |
|
bool | setUseSideEffectiveness (double useSideEffectiveness) |
|
bool | setUseSideInletHeight (double useSideInletHeight) |
|
bool | setUseSideOutletHeight (double useSideOutletHeight) |
|
void | autocalculateUseSideOutletHeight () |
|
bool | setSourceSideEffectiveness (double sourceSideEffectiveness) |
|
bool | setSourceSideInletHeight (double sourceSideInletHeight) |
|
void | autocalculateSourceSideInletHeight () |
|
bool | setSourceSideOutletHeight (double sourceSideOutletHeight) |
|
bool | setInletMode (std::string inletMode) |
|
bool | setUseSideDesignFlowRate (double useSideDesignFlowRate) |
|
void | autosizeUseSideDesignFlowRate () |
|
bool | setSourceSideDesignFlowRate (double sourceSideDesignFlowRate) |
|
void | autosizeSourceSideDesignFlowRate () |
|
bool | setIndirectWaterHeatingRecoveryTime (double indirectWaterHeatingRecoveryTime) |
|
bool | setNumberofNodes (int numberofNodes) |
|
bool | setAdditionalDestratificationConductivity (double additionalDestratificationConductivity) |
|
void | setNode1AdditionalLossCoefficient (double node1AdditionalLossCoefficient) |
|
void | setNode2AdditionalLossCoefficient (double node2AdditionalLossCoefficient) |
|
void | setNode3AdditionalLossCoefficient (double node3AdditionalLossCoefficient) |
|
void | setNode4AdditionalLossCoefficient (double node4AdditionalLossCoefficient) |
|
void | setNode5AdditionalLossCoefficient (double node5AdditionalLossCoefficient) |
|
void | setNode6AdditionalLossCoefficient (double node6AdditionalLossCoefficient) |
|
void | setNode7AdditionalLossCoefficient (double node7AdditionalLossCoefficient) |
|
void | setNode8AdditionalLossCoefficient (double node8AdditionalLossCoefficient) |
|
void | setNode9AdditionalLossCoefficient (double node9AdditionalLossCoefficient) |
|
void | setNode10AdditionalLossCoefficient (double node10AdditionalLossCoefficient) |
|
bool | setSourceSideFlowControlMode (std::string sourceSideFlowControlMode) |
|
bool | setIndirectAlternateSetpointTemperatureSchedule (Schedule &schedule) |
|
void | resetIndirectAlternateSetpointTemperatureSchedule () |
|
virtual bool | addToNode (Node &node) |
|
virtual bool | addToTertiaryNode (Node &node) |
| Add this WaterToWaterComponent to a tertiaryPlantLoop by making connections to the tertiary inlet and outlet. More...
|
|
virtual ModelObject | clone (Model model) const |
|
virtual boost::optional
< ModelObject > | demandInletModelObject () |
| Returns the optional ModelObject connected to the demand inlet port. More...
|
|
virtual unsigned | demandInletPort () |
| Returns the demand inlet port. More...
|
|
virtual boost::optional
< ModelObject > | demandOutletModelObject () |
| Returns the optional ModelObject connected to the demand outlet port. More...
|
|
virtual unsigned | demandOutletPort () |
| Returns the demand outlet port. More...
|
|
void | disconnect () |
|
boost::optional< PlantLoop > | plantLoop () const |
| Returns the optional PlantLoop object that the HVAC component is a supply component on. More...
|
|
virtual std::vector
< openstudio::IdfObject > | remove () |
|
bool | removeFromPlantLoop () |
| Removes the component from the plantLoop if one is attached. More...
|
|
bool | removeFromSecondaryPlantLoop () |
| Removes the component from the secondaryPlantLoop if one is attached. More...
|
|
bool | removeFromTertiaryPlantLoop () |
| Removes the component from the tertiaryPlantLoop if one is attached. More...
|
|
boost::optional< PlantLoop > | secondaryPlantLoop () const |
| Returns the optional PlantLoop object that the HVAC component is a demand component on. More...
|
|
virtual boost::optional
< ModelObject > | supplyInletModelObject () |
| Returns the optional ModelObject connected to the supply inlet port. More...
|
|
virtual unsigned | supplyInletPort () |
| Returns the supply inlet port. More...
|
|
virtual boost::optional
< ModelObject > | supplyOutletModelObject () |
| Returns the optional ModelObject connected to the supply outlet port. More...
|
|
virtual unsigned | supplyOutletPort () |
| Returns the supply outlet port. More...
|
|
boost::optional< ModelObject > | tertiaryInletModelObject () const |
| Returns the optional ModelObject connected to the tertiary inlet. More...
|
|
boost::optional< ModelObject > | tertiaryOutletModelObject () const |
| Returns the optional ModelObject connected to the tertiary outlet. More...
|
|
boost::optional< PlantLoop > | tertiaryPlantLoop () const |
| Tertiary plant loop applies to a limited number of WaterToWaterComponent types that interact with three plant systems. More...
|
|
| WaterToWaterComponent (IddObjectType type, const Model &model) |
|
virtual | ~WaterToWaterComponent () |
|
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...
|
|
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...
|
|
std::vector< std::string > | relationshipNames () const |
| Return all valid relationship names. More...
|
|
std::vector< Relationship > | relationships () const |
| Return all relationships for this ModelObject. More...
|
|
boost::optional< Relationship > | getRelationship (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...
|
|
std::vector
< openstudio::Attribute > | attributes () const |
| Return all Attributes for this ModelObject. More...
|
|
boost::optional
< 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< 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...
|
|
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< 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) 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=true) const |
|
virtual | ~IdfObject () |
|