|
|
| CoilCoolingDXSingleSpeed (const Model &model, Schedule &availabilitySchedule, const Curve &coolingCurveFofTemp, const Curve &coolingCurveFofFlow, const Curve &energyInputRatioFofTemp, const Curve &energyInputRatioFofFlow, const Curve &partLoadFraction) |
| Constructs a new CoilCoolingDXSingleSpeed object and places it inside the model. More...
|
|
| CoilCoolingDXSingleSpeed (const Model &model) |
|
virtual | ~CoilCoolingDXSingleSpeed () |
|
|
Schedule | availabilitySchedule () const |
| Returns the Schedule referred to by the AvailabilitySchedule field. More...
|
|
boost::optional< double > | ratedCOP () const |
| Returns the value of the RatedCOP field. More...
|
|
boost::optional< double > | ratedEvaporatorFanPowerPerVolumeFlowRate () const |
| Returns the value of the RatedEvaporatorFanPowerPerVolumeFlowRate field. More...
|
|
Curve | totalCoolingCapacityFunctionOfTemperatureCurve () const |
| Returns the CurveBiquadratic referred to by the TotalCoolingCapacityFunctionOfTemperatureCurveName field. More...
|
|
Curve | totalCoolingCapacityFunctionOfFlowFractionCurve () const |
| Returns the CurveQuadratic referred to by the TotalCoolingCapacityFunctionOfFlowFractionCurveName field. More...
|
|
Curve | energyInputRatioFunctionOfTemperatureCurve () const |
| Returns the CurveBiquadratic referred to by the EnergyInputRatioFunctionOfTemperatureCurveName field. More...
|
|
Curve | energyInputRatioFunctionOfFlowFractionCurve () const |
| Returns the CurveQuadratic referred to by the EnergyInputRatioFunctionOfFlowFractionCurveName field. More...
|
|
Curve | partLoadFractionCorrelationCurve () const |
| Returns the CurveQuadratic referred to by the PartLoadFractionCorrelationCurveName field. More...
|
|
boost::optional< double > | nominalTimeForCondensateRemovalToBegin () const |
| Returns the value of the NominalTimeForCondensateRemovalToBegin field. More...
|
|
boost::optional< double > | ratioOfInitialMoistureEvaporationRateAndSteadyStateLatentCapacity () const |
| Returns the value of the RatioOfInitialMoistureEvaporationRateAndSteadyStateLatentCapacity field. More...
|
|
boost::optional< double > | maximumCyclingRate () |
| Returns the value of the MaximumCyclingRate field. More...
|
|
boost::optional< double > | latentCapacityTimeConstant () const |
| Returns the value of the latentCapacityTimeConstant field. More...
|
|
OptionalString | condenserAirInletNodeName () const |
|
std::string | condenserType () const |
| Returns the value of the CondenserType field. More...
|
|
boost::optional< double > | evaporativeCondenserEffectiveness () const |
| Returns the value of the EvaporativeCondenserEffectiveness field. More...
|
|
boost::optional< double > | evaporativeCondenserAirFlowRate () const |
| Returns the value of the EvaporativeCondenserAirFlowRate field. More...
|
|
boost::optional< double > | evaporativeCondenserPumpRatedPowerConsumption () const |
| Returns the value of the EvaporativeCondenserPumpRatedPowerConsumption field. More...
|
|
boost::optional< double > | crankcaseHeaterCapacity () const |
| Returns the value of the crankcaseHeaterCapacity field. More...
|
|
boost::optional< double > | maximumOutdoorDryBulbTemperatureForCrankcaseHeaterOperation () const |
| Returns the value of the MaximumOutdoorDryBulbTemperatureForCrankcaseHeaterOperation field. More...
|
|
boost::optional< double > | basinHeaterCapacity () const |
| Returns the value of the BasinHeaterCapacity field. More...
|
|
boost::optional< double > | basinHeaterSetpointTemperature () const |
| Returns the value of the BasinHeaterSetpointTemperature field. More...
|
|
boost::optional< Schedule > | basinHeaterOperatingSchedule () const |
| Returns the Schedule referred to by the BasinHeaterOperatingSchedule field. More...
|
|
Schedule | getAvailabilitySchedule () const |
|
boost::optional< double > | getRatedCOP () const |
|
boost::optional< double > | getRatedEvaporatorFanPowerPerVolumeFlowRate () const |
|
Curve | getTotalCoolingCapacityFunctionOfTemperatureCurve () const |
|
Curve | getTotalCoolingCapacityFunctionOfFlowFractionCurve () const |
|
Curve | getEnergyInputRatioFunctionOfTemperatureCurve () const |
|
Curve | getEnergyInputRatioFunctionOfFlowFractionCurve () const |
|
Curve | getPartLoadFractionCorrelationCurve () const |
|
boost::optional< double > | getNominalTimeForCondensateRemovalToBegin () const |
|
boost::optional< double > | getRatioOfInitialMoistureEvaporationRateAndSteadyStateLatentCapacity () const |
|
boost::optional< double > | getMaximumCyclingRate () |
|
boost::optional< double > | getLatentCapacityTimeConstant () const |
|
OptionalString | getCondenserAirInletNodeName () const |
|
std::string | getCondenserType () const |
|
boost::optional< double > | getEvaporativeCondenserEffectiveness () const |
|
boost::optional< double > | getEvaporativeCondenserAirFlowRate () const |
|
boost::optional< double > | getEvaporativeCondenserPumpRatedPowerConsumption () const |
|
boost::optional< double > | getCrankcaseHeaterCapacity () const |
|
boost::optional< double > | getMaximumOutdoorDryBulbTemperatureForCrankcaseHeaterOperation () const |
|
boost::optional< double > | getBasinHeaterCapacity () const |
|
boost::optional< double > | getBasinHeaterSetpointTemperature () const |
|
boost::optional< Schedule > | getBasinHeaterOperatingSchedule () const |
|
|
bool | setAvailabilitySchedule (Schedule &schedule) |
| Sets the Schedule referred to by the AvailabilitySchedule field. More...
|
|
void | setRatedCOP (boost::optional< double > value) |
| Sets the value of the RatedCOP field. More...
|
|
void | setRatedEvaporatorFanPowerPerVolumeFlowRate (boost::optional< double > value) |
| Sets the value of the RatedEvaporatorFanPowerPerVolumeFlowRate field. More...
|
|
void | setTotalCoolingCapacityFunctionOfTemperatureCurve (const Curve &curve) |
| Sets the CurveBiquadratic referred to by the TotalCoolingCapacityFunctionOfTemperatureCurveName field. More...
|
|
void | setTotalCoolingCapacityFunctionOfFlowFractionCurve (const Curve &curve) |
| Sets the CurveQuadratic referred to by the TotalCoolingCapacityFunctionOfFlowFractionCurnveName field. More...
|
|
void | setEnergyInputRatioFunctionOfTemperatureCurve (const Curve &curve) |
| Sets the CurveBiquadratic referred to by the EnergyInputRatioFunctionOfTemperatureCurveName field. More...
|
|
void | setEnergyInputRatioFunctionOfFlowFractionCurve (const Curve &curve) |
| Sets the CurveQuadratic referred to by the EnergyInputRatioFunctionOfFlowFractionCurveName field. More...
|
|
void | setPartLoadFractionCorrelationCurve (const Curve &curve) |
| Sets the CurveQuadratic referred to by the PartLoadFractionCorrelationCurveName field. More...
|
|
void | setNominalTimeForCondensateRemovalToBegin (boost::optional< double > value) |
| Sets the value of the NominalTimeForCondensateRemovalToBegin field. More...
|
|
void | setRatioOfInitialMoistureEvaporationRateAndSteadyStateLatentCapacity (boost::optional< double > value) |
| Sets the value of the RatioOfInitialMoistureEvaporationRateAndSteadyStateLatentCapacity field. More...
|
|
void | setMaximumCyclingRate (boost::optional< double > value) |
| Sets the value of the MaximumCyclingRate field. More...
|
|
void | setLatentCapacityTimeConstant (boost::optional< double > value) |
| Sets the value of the latentCapacityTimeConstant field. More...
|
|
void | setCondenserAirInletNodeName (const boost::optional< std::string > &) |
|
void | setCondenserType (const std::string &value) |
| Sets the value of the CondenserType field. More...
|
|
void | setEvaporativeCondenserEffectiveness (boost::optional< double > value) |
| Sets the value of the EvaporativeCondenserEffectiveness field. More...
|
|
void | setEvaporativeCondenserAirFlowRate (boost::optional< double > value) |
| Sets the value of the EvaporativeCondenserAirFlowRate field. More...
|
|
void | setEvaporativeCondenserPumpRatedPowerConsumption (boost::optional< double > value) |
| Sets the value of the EvaporativeCondenserPumpRatedPowerConsumption field. More...
|
|
void | setCrankcaseHeaterCapacity (boost::optional< double > value) |
| Sets the value of the crankcaseHeaterCapacity field. More...
|
|
void | setMaximumOutdoorDryBulbTemperatureForCrankcaseHeaterOperation (boost::optional< double > value) |
| Sets the value of the MaximumOutdoorDryBulbTemperatureForCrankcaseHeaterOperation field. More...
|
|
void | setBasinHeaterCapacity (boost::optional< double > value) |
| Sets the value of the BasinHeaterCapacity field. More...
|
|
void | setBasinHeaterSetpointTemperature (boost::optional< double > value) |
| Sets the value of the BasinHeaterSetpointTemperature field. More...
|
|
bool | setBasinHeaterOperatingSchedule (Schedule &schedule) |
| Sets the Schedule referred to by the BasinHeaterOperatingSchedule field. More...
|
|
void | resetBasinHeaterOperatingSchedule () |
|
boost::optional< double > | ratedTotalCoolingCapacity () const |
|
OSOptionalQuantity | getRatedTotalCoolingCapacity (bool returnIP=false) const |
|
bool | isRatedTotalCoolingCapacityAutosized () const |
|
bool | setRatedTotalCoolingCapacity (double ratedTotalCoolingCapacity) |
|
bool | setRatedTotalCoolingCapacity (const Quantity &ratedTotalCoolingCapacity) |
|
void | autosizeRatedTotalCoolingCapacity () |
|
boost::optional< double > | ratedSensibleHeatRatio () const |
|
OSOptionalQuantity | getRatedSensibleHeatRatio (bool returnIP=false) const |
|
bool | isRatedSensibleHeatRatioAutosized () const |
|
bool | setRatedSensibleHeatRatio (double ratedSensibleHeatRatio) |
|
bool | setRatedSensibleHeatRatio (const Quantity &ratedSensibleHeatRatio) |
|
void | autosizeRatedSensibleHeatRatio () |
|
boost::optional< double > | ratedAirFlowRate () const |
|
OSOptionalQuantity | getRatedAirFlowRate (bool returnIP=false) const |
|
bool | isRatedAirFlowRateAutosized () const |
|
bool | setRatedAirFlowRate (double ratedAirFlowRate) |
|
bool | setRatedAirFlowRate (const Quantity &ratedAirFlowRate) |
|
void | autosizeRatedAirFlowRate () |
|
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 () |
| Returns the optional ModelObject connected to the inlet port. More...
|
|
unsigned | inletPort () |
| Returns the inlet port. More...
|
|
boost::optional< ModelObject > | outletModelObject () |
| Returns the optional ModelObject connected to the outlet port. More...
|
|
unsigned | outletPort () |
| 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...
|
|
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 () |
|