 |
OpenStudio:model |
#include <Facility.hpp>
Inheritance diagram for openstudio::model::Facility:Public Member Functions | |
| virtual | ~Facility () |
Children | |
| boost::optional< Building > | building () const |
| Returns the child Building. More... | |
| std::vector< OutputMeter > | meters () const |
| Returns all OutputMeters at the Facility level. More... | |
| boost::optional< OutputMeter > | getMeterByFuelType (const FuelType &fuelType, const std::string &reportingFrequency="Hourly", const boost::optional< EndUseType > &endUseType=boost::none, const boost::optional< std::string > &specificEndUse=boost::none) const |
| std::vector< ExteriorLights > | exteriorLights () const |
| Returns all ExteriorLights. More... | |
| std::vector < ExteriorFuelEquipment > | exteriorFuelEquipments () const |
| Returns all ExteriorFuelEquipment. More... | |
| std::vector < ExteriorWaterEquipment > | exteriorWaterEquipments () const |
| Returns all ExteriorWaterEquipment. More... | |
Other | |
| boost::optional< double > | totalSiteEnergy () const |
| Returns the total site energy in gigajoules. Requires EnergyPlus simulation output to calculate. More... | |
| boost::optional< double > | netSiteEnergy () const |
| Returns the net site energy in gigajoules. Requires EnergyPlus simulation output to calculate. More... | |
| boost::optional< double > | totalSourceEnergy () const |
| Returns the total source energy in gigajoules. Requires EnergyPlus simulation output to calculate. More... | |
| boost::optional< double > | netSourceEnergy () const |
| Returns the net source energy in gigajoules. Requires EnergyPlus simulation output to calculate. More... | |
| boost::optional< double > | annualTotalCost (const FuelType &fuel) const |
| Returns the annual total cost associated with the given fuel type in dollars. More... | |
| boost::optional< double > | annualTotalCostPerBldgArea (const FuelType &fuel) const |
| Returns the annual total cost per total building area associated with the given fuel type in dollars per square meter. More... | |
| boost::optional< double > | annualTotalCostPerNetConditionedBldgArea (const FuelType &fuel) const |
| Returns the annual total cost per net conditioned building area associated with the given fuel type in dollars per square meter. More... | |
| boost::optional< double > | annualTotalUtilityCost () const |
| Returns the annual total cost for all fuel types in dollars. Requires EnergyPlus simulation output to calculate. More... | |
| boost::optional< double > | annualElectricTotalCost () const |
| Returns the annual electric total cost in dollars. Requires EnergyPlus simulation output to calculate. More... | |
| boost::optional< double > | annualGasTotalCost () const |
| Returns the annual gas total cost in dollars. Requires EnergyPlus simulation output to calculate. More... | |
| boost::optional< double > | annualDistrictCoolingTotalCost () const |
| Returns the annual district cooling total cost in dollars. Requires EnergyPlus simulation output to calculate. More... | |
| boost::optional< double > | annualDistrictHeatingTotalCost () const |
| Returns the annual district heating total cost in dollars. Requires EnergyPlus simulation output to calculate. More... | |
| boost::optional< double > | annualWaterTotalCost () const |
| Returns the annual water total cost in dollars. Requires EnergyPlus simulation output to calculate. More... | |
| boost::optional< double > | economicsCapitalCost () const |
| Returns the total capital cost associated with the building in dollars by summing all costs from all ComponentCost_LineItem objects. More... | |
| boost::optional< double > | economicsEnergyCost () const |
| Returns the total energy cost over the analysis period in dollars according to the discounting convention. More... | |
| boost::optional< double > | economicsTLCC () const |
| Returns the total life cycle cost over the analysis period in dollars according to the discounting convention. More... | |
| boost::optional< double > | economicsVirtualRateGas () const |
| Returns the virtual rate of gas energy in dollars per gigajoule. More... | |
| boost::optional< double > | economicsVirtualRateElec () const |
| Returns the virtual rate of electric energy in dollars per gigajoule. More... | |
| boost::optional< double > | economicsVirtualRateCombined () const |
| Returns the virtual rate of all energy in dollars per gigajoule. More... | |
| boost::optional< double > | economicsSPB () const |
| Returns the simple payback period in years. More... | |
| boost::optional< double > | economicsDPB () const |
| Returns the discounted payback period in years. More... | |
| boost::optional< double > | economicsNPV () const |
| Returns the net present value in dollars. More... | |
| boost::optional< double > | economicsIRR () const |
| Returns the internal rate of return as a fractional rate (e.g. More... | |
| boost::optional< double > | electricityHeating () const |
| Returns the electric energy used for heating in gigajoules. More... | |
| boost::optional< double > | electricityCooling () const |
| Returns the electric energy used for cooling in gigajoules. More... | |
| boost::optional< double > | electricityInteriorLighting () const |
| Returns the electric energy used for interior lighting in gigajoules. More... | |
| boost::optional< double > | electricityExteriorLighting () const |
| Returns the electric energy used for exterior lighting in gigajoules. More... | |
| boost::optional< double > | electricityInteriorEquipment () const |
| Returns the electric energy used for interior equipment in gigajoules. More... | |
| boost::optional< double > | electricityExteriorEquipment () const |
| Returns the electric energy used for exterior equipment in gigajoules. More... | |
| boost::optional< double > | electricityFans () const |
| Returns the electric energy used for fans in gigajoules. More... | |
| boost::optional< double > | electricityPumps () const |
| Returns the electric energy used for pumps in gigajoules. More... | |
| boost::optional< double > | electricityHeatRejection () const |
| Returns the electric energy used for heat rejection in gigajoules. More... | |
| boost::optional< double > | electricityHumidification () const |
| Returns the electric energy used for humidification in gigajoules. More... | |
| boost::optional< double > | electricityHeatRecovery () const |
| Returns the electric energy used for heat recovery in gigajoules. More... | |
| boost::optional< double > | electricityWaterSystems () const |
| Returns the electric energy used for water systems in gigajoules. More... | |
| boost::optional< double > | electricityRefrigeration () const |
| Returns the electric energy used for refrigeration in gigajoules. More... | |
| boost::optional< double > | electricityGenerators () const |
| Returns the electric energy used for generators in gigajoules. More... | |
| boost::optional< double > | electricityTotalEndUses () const |
| Returns the electric energy used for all uses in gigajoules. More... | |
| boost::optional< double > | naturalGasHeating () const |
| Returns the natural gas energy used for heating in gigajoules. More... | |
| boost::optional< double > | naturalGasCooling () const |
| Returns the natural gas energy used for cooling in gigajoules. More... | |
| boost::optional< double > | naturalGasInteriorLighting () const |
| Returns the natural gas energy used for interior lighting in gigajoules. More... | |
| boost::optional< double > | naturalGasExteriorLighting () const |
| Returns the natural gas energy used for exterior lighting in gigajoules. More... | |
| boost::optional< double > | naturalGasInteriorEquipment () const |
| Returns the natural gas energy used for interior equipment in gigajoules. More... | |
| boost::optional< double > | naturalGasExteriorEquipment () const |
| Returns the natural gas energy used for exterior equipment in gigajoules. More... | |
| boost::optional< double > | naturalGasFans () const |
| Returns the natural gas energy used for fans in gigajoules. More... | |
| boost::optional< double > | naturalGasPumps () const |
| Returns the natural gas energy used for pumps in gigajoules. More... | |
| boost::optional< double > | naturalGasHeatRejection () const |
| Returns the natural gas energy used for heat rejection in gigajoules. More... | |
| boost::optional< double > | naturalGasHumidification () const |
| Returns the natural gas energy used for humidification in gigajoules. More... | |
| boost::optional< double > | naturalGasHeatRecovery () const |
| Returns the natural gas energy used for heat recovery in gigajoules. More... | |
| boost::optional< double > | naturalGasWaterSystems () const |
| Returns the natural gas energy used for water systems in gigajoules. More... | |
| boost::optional< double > | naturalGasRefrigeration () const |
| Returns the natural gas energy used for refrigeration in gigajoules. More... | |
| boost::optional< double > | naturalGasGenerators () const |
| Returns the natural gas energy used for generators in gigajoules. More... | |
| boost::optional< double > | naturalGasTotalEndUses () const |
| Returns the natural gas energy used for all end uses in gigajoules. More... | |
| boost::optional< double > | otherFuelHeating () const |
| Returns the energy used for heating from other fuel in gigajoules. More... | |
| boost::optional< double > | otherFuelCooling () const |
| Returns the energy used for cooling from other fuel in gigajoules. More... | |
| boost::optional< double > | otherFuelInteriorLighting () const |
| Returns the energy used for interior lighting from other fuel in gigajoules. More... | |
| boost::optional< double > | otherFuelExteriorLighting () const |
| Returns the energy used for exterior lighting from other fuel in gigajoules. More... | |
| boost::optional< double > | otherFuelInteriorEquipment () const |
| Returns the energy used for interior equipment from other fuel in gigajoules. More... | |
| boost::optional< double > | otherFuelExteriorEquipment () const |
| Returns the energy used for exterior equipment from other fuel in gigajoules. More... | |
| boost::optional< double > | otherFuelFans () const |
| Returns the energy used for fans from other fuel in gigajoules. More... | |
| boost::optional< double > | otherFuelPumps () const |
| Returns the energy used for pumps from other fuel in gigajoules. More... | |
| boost::optional< double > | otherFuelHeatRejection () const |
| Returns the energy used for heat rejection from other fuel in gigajoules. More... | |
| boost::optional< double > | otherFuelHumidification () const |
| Returns the energy used for humidification from other fuel in gigajoules. More... | |
| boost::optional< double > | otherFuelHeatRecovery () const |
| Returns the energy used for heat recovery from other fuel in gigajoules. More... | |
| boost::optional< double > | otherFuelWaterSystems () const |
| Returns the energy used for water systems from other fuel in gigajoules. More... | |
| boost::optional< double > | otherFuelRefrigeration () const |
| Returns the energy used for refrigeration from other fuel in gigajoules. More... | |
| boost::optional< double > | otherFuelGenerators () const |
| Returns the energy used for generators from other fuel in gigajoules. More... | |
| boost::optional< double > | otherFuelTotalEndUses () const |
| Returns the energy used for all end uses from other fuel in gigajoules. More... | |
| boost::optional< double > | districtCoolingHeating () const |
| Returns the district cooling energy used for heating in gigajoules. More... | |
| boost::optional< double > | districtCoolingCooling () const |
| Returns the district cooling energy used for cooling in gigajoules. More... | |
| boost::optional< double > | districtCoolingInteriorLighting () const |
| Returns the district cooling energy used for interior lighting in gigajoules. More... | |
| boost::optional< double > | districtCoolingExteriorLighting () const |
| Returns the district cooling energy used for exterior lighting in gigajoules. More... | |
| boost::optional< double > | districtCoolingInteriorEquipment () const |
| Returns the district cooling energy used for interior equipment in gigajoules. More... | |
| boost::optional< double > | districtCoolingExteriorEquipment () const |
| Returns the district cooling energy used for exterior equipment in gigajoules. More... | |
| boost::optional< double > | districtCoolingFans () const |
| Returns the district cooling energy used for fans in gigajoules. More... | |
| boost::optional< double > | districtCoolingPumps () const |
| Returns the district cooling energy used for pumps in gigajoules. More... | |
| boost::optional< double > | districtCoolingHeatRejection () const |
| Returns the district cooling energy used for heat rejection in gigajoules. More... | |
| boost::optional< double > | districtCoolingHumidification () const |
| Returns the district cooling energy used for humidification in gigajoules. More... | |
| boost::optional< double > | districtCoolingHeatRecovery () const |
| Returns the district cooling energy used for heat recovery in gigajoules. More... | |
| boost::optional< double > | districtCoolingWaterSystems () const |
| Returns the district cooling energy used for water systems in gigajoules. More... | |
| boost::optional< double > | districtCoolingRefrigeration () const |
| Returns the district cooling energy used for refrigeration in gigajoules. More... | |
| boost::optional< double > | districtCoolingGenerators () const |
| Returns the district cooling energy used for generators in gigajoules. More... | |
| boost::optional< double > | districtCoolingTotalEndUses () const |
| Returns the district cooling energy used for all end uses in gigajoules. More... | |
| boost::optional< double > | districtHeatingHeating () const |
| Returns the district heating energy used for heating in gigajoules. More... | |
| boost::optional< double > | districtHeatingCooling () const |
| Returns the district heating energy used for cooling in gigajoules. More... | |
| boost::optional< double > | districtHeatingInteriorLighting () const |
| Returns the district heating energy used for interior lighting in gigajoules. More... | |
| boost::optional< double > | districtHeatingExteriorLighting () const |
| Returns the district heating energy used for exterior lighting in gigajoules. More... | |
| boost::optional< double > | districtHeatingInteriorEquipment () const |
| Returns the district heating energy used for interior equipment in gigajoules. More... | |
| boost::optional< double > | districtHeatingExteriorEquipment () const |
| Returns the district heating energy used for exterior equipment in gigajoules. More... | |
| boost::optional< double > | districtHeatingFans () const |
| Returns the district heating energy used for fans in gigajoules. More... | |
| boost::optional< double > | districtHeatingPumps () const |
| Returns the district heating energy used for pumps in gigajoules. More... | |
| boost::optional< double > | districtHeatingHeatRejection () const |
| Returns the district heating energy used for heat rejection in gigajoules. More... | |
| boost::optional< double > | districtHeatingHumidification () const |
| Returns the district heating energy used for humidification in gigajoules. More... | |
| boost::optional< double > | districtHeatingHeatRecovery () const |
| Returns the district heating energy used for heat recovery in gigajoules. More... | |
| boost::optional< double > | districtHeatingWaterSystems () const |
| Returns the district heating energy used for water systems in gigajoules. More... | |
| boost::optional< double > | districtHeatingRefrigeration () const |
| Returns the district heating energy used for refrigeration in gigajoules. More... | |
| boost::optional< double > | districtHeatingGenerators () const |
| Returns the district heating energy used for generators in gigajoules. More... | |
| boost::optional< double > | districtHeatingTotalEndUses () const |
| Returns the district heating energy used for all end uses in gigajoules. More... | |
| boost::optional< double > | waterHeating () const |
| Returns the water used for heating in cubic meters. More... | |
| boost::optional< double > | waterCooling () const |
| Returns the water used for cooling in cubic meters. More... | |
| boost::optional< double > | waterInteriorLighting () const |
| Returns the water used for interior lighting in cubic meters. More... | |
| boost::optional< double > | waterExteriorLighting () const |
| Returns the water used for exterior lighting in cubic meters. More... | |
| boost::optional< double > | waterInteriorEquipment () const |
| Returns the water used for interior equipment in cubic meters. More... | |
| boost::optional< double > | waterExteriorEquipment () const |
| Returns the water used for exterior equipment in cubic meters. More... | |
| boost::optional< double > | waterFans () const |
| Returns the water used for fans in cubic meters. More... | |
| boost::optional< double > | waterPumps () const |
| Returns the water used for pumps in cubic meters. More... | |
| boost::optional< double > | waterHeatRejection () const |
| Returns the water used for heat rejection in cubic meters. More... | |
| boost::optional< double > | waterHumidification () const |
| Returns the water used for humidification in cubic meters. More... | |
| boost::optional< double > | waterHeatRecovery () const |
| Returns the water used for heat recovery in cubic meters. More... | |
| boost::optional< double > | waterWaterSystems () const |
| Returns the water used for water systems in cubic meters. More... | |
| boost::optional< double > | waterRefrigeration () const |
| Returns the water used for refrigeration in cubic meters. More... | |
| boost::optional< double > | waterGenerators () const |
| Returns the water used for generators in cubic meters. More... | |
| boost::optional< double > | waterTotalEndUses () const |
| Returns the water used for all uses in cubic meters. More... | |
| boost::optional< double > | hoursHeatingSetpointNotMet () const |
| Returns the total number of hours the heating setpoint is not met. More... | |
| boost::optional< double > | hoursCoolingSetpointNotMet () const |
| Returns the total number of hours the cooling setpoint is not met. More... | |
| boost::optional< EndUses > | endUses () const |
| Returns an EndUse object containing all end uses for the simulation. More... | |
| boost::optional < CalibrationResult > | calibrationResult () const |
| Returns a CalibrationResult object containing data related to model calibration. More... | |
| 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... | |
| 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... | |
| 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 |
Static Public Member Functions | |
| static std::vector< FuelType > | fossilFuels () |
| Returns all FuelTypes which are fossil fuels. More... | |
| static IddObjectType | iddObjectType () |
Protected Member Functions | |
Constructors and Destructors | |
| Facility (Model &model) | |
| 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) | |
Related Functions | |
(Note that these are not member functions.) | |
| typedef boost::optional< Facility > | OptionalFacility |
| 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::ModelObject | |
| typedef detail::ModelObject_Impl | ImplType |
Facility derives from ParentObject and is an interface to the OpenStudio IDD object named "OS:Facility".
Facility is a unique object which parents the Building in the model. Conceptually, the Facility object includes the Building as well as exterior equipment, parking lot lighting, water systems for grounds, etc. The Facility object currently does not have any fields, it is simply used to access OutputMeters and high level results which include exterior end uses. Facility does not have a public constructor because it is a unique ModelObject. To get the Facility object for a Model or create one if it does not yet exist use model.getUniqueObject<Facility>(). To get the Facility object for a Model but not create one if it does not yet exist use model.getOptionalUniqueObject<Facility>().
|
inlinevirtual |
|
explicitprotected |
| boost::optional<double> openstudio::model::Facility::annualDistrictCoolingTotalCost | ( | ) | const |
Returns the annual district cooling total cost in dollars. Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::annualDistrictHeatingTotalCost | ( | ) | const |
Returns the annual district heating total cost in dollars. Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::annualElectricTotalCost | ( | ) | const |
Returns the annual electric total cost in dollars. Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::annualGasTotalCost | ( | ) | const |
Returns the annual gas total cost in dollars. Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::annualTotalCost | ( | const FuelType & | fuel | ) | const |
Returns the annual total cost associated with the given fuel type in dollars.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::annualTotalCostPerBldgArea | ( | const FuelType & | fuel | ) | const |
Returns the annual total cost per total building area associated with the given fuel type in dollars per square meter.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::annualTotalCostPerNetConditionedBldgArea | ( | const FuelType & | fuel | ) | const |
Returns the annual total cost per net conditioned building area associated with the given fuel type in dollars per square meter.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::annualTotalUtilityCost | ( | ) | const |
Returns the annual total cost for all fuel types in dollars. Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::annualWaterTotalCost | ( | ) | const |
Returns the annual water total cost in dollars. Requires EnergyPlus simulation output to calculate.
| boost::optional<Building> openstudio::model::Facility::building | ( | ) | const |
Returns the child Building.
| boost::optional<CalibrationResult> openstudio::model::Facility::calibrationResult | ( | ) | const |
Returns a CalibrationResult object containing data related to model calibration.
| boost::optional<double> openstudio::model::Facility::districtCoolingCooling | ( | ) | const |
Returns the district cooling energy used for cooling in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::districtCoolingExteriorEquipment | ( | ) | const |
Returns the district cooling energy used for exterior equipment in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::districtCoolingExteriorLighting | ( | ) | const |
Returns the district cooling energy used for exterior lighting in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::districtCoolingFans | ( | ) | const |
Returns the district cooling energy used for fans in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::districtCoolingGenerators | ( | ) | const |
Returns the district cooling energy used for generators in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::districtCoolingHeating | ( | ) | const |
Returns the district cooling energy used for heating in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::districtCoolingHeatRecovery | ( | ) | const |
Returns the district cooling energy used for heat recovery in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::districtCoolingHeatRejection | ( | ) | const |
Returns the district cooling energy used for heat rejection in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::districtCoolingHumidification | ( | ) | const |
Returns the district cooling energy used for humidification in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::districtCoolingInteriorEquipment | ( | ) | const |
Returns the district cooling energy used for interior equipment in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::districtCoolingInteriorLighting | ( | ) | const |
Returns the district cooling energy used for interior lighting in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::districtCoolingPumps | ( | ) | const |
Returns the district cooling energy used for pumps in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::districtCoolingRefrigeration | ( | ) | const |
Returns the district cooling energy used for refrigeration in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::districtCoolingTotalEndUses | ( | ) | const |
Returns the district cooling energy used for all end uses in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::districtCoolingWaterSystems | ( | ) | const |
Returns the district cooling energy used for water systems in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::districtHeatingCooling | ( | ) | const |
Returns the district heating energy used for cooling in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::districtHeatingExteriorEquipment | ( | ) | const |
Returns the district heating energy used for exterior equipment in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::districtHeatingExteriorLighting | ( | ) | const |
Returns the district heating energy used for exterior lighting in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::districtHeatingFans | ( | ) | const |
Returns the district heating energy used for fans in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::districtHeatingGenerators | ( | ) | const |
Returns the district heating energy used for generators in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::districtHeatingHeating | ( | ) | const |
Returns the district heating energy used for heating in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::districtHeatingHeatRecovery | ( | ) | const |
Returns the district heating energy used for heat recovery in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::districtHeatingHeatRejection | ( | ) | const |
Returns the district heating energy used for heat rejection in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::districtHeatingHumidification | ( | ) | const |
Returns the district heating energy used for humidification in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::districtHeatingInteriorEquipment | ( | ) | const |
Returns the district heating energy used for interior equipment in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::districtHeatingInteriorLighting | ( | ) | const |
Returns the district heating energy used for interior lighting in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::districtHeatingPumps | ( | ) | const |
Returns the district heating energy used for pumps in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::districtHeatingRefrigeration | ( | ) | const |
Returns the district heating energy used for refrigeration in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::districtHeatingTotalEndUses | ( | ) | const |
Returns the district heating energy used for all end uses in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::districtHeatingWaterSystems | ( | ) | const |
Returns the district heating energy used for water systems in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::economicsCapitalCost | ( | ) | const |
Returns the total capital cost associated with the building in dollars by summing all costs from all ComponentCost_LineItem objects.
Requires EnergyPlus simulation output and LifeCycleCost_Parameters input object to calculate.
: only ComponentCost_LineItem of line item type "Construction" are currently handled
: this should not require life cycle parameters to calculate
| boost::optional<double> openstudio::model::Facility::economicsDPB | ( | ) | const |
Returns the discounted payback period in years.
Requires EnergyPlus simulation output and LifeCycleCost_Parameters input object to calculate.
| boost::optional<double> openstudio::model::Facility::economicsEnergyCost | ( | ) | const |
Returns the total energy cost over the analysis period in dollars according to the discounting convention.
Requires EnergyPlus simulation output and LifeCycleCost_Parameters input object to calculate.
| boost::optional<double> openstudio::model::Facility::economicsIRR | ( | ) | const |
Returns the internal rate of return as a fractional rate (e.g.
5% = 0.05). Requires EnergyPlus simulation output and LifeCycleCost_Parameters input object to calculate.
| boost::optional<double> openstudio::model::Facility::economicsNPV | ( | ) | const |
Returns the net present value in dollars.
Requires EnergyPlus simulation output and LifeCycleCost_Parameters input object to calculate.
| boost::optional<double> openstudio::model::Facility::economicsSPB | ( | ) | const |
Returns the simple payback period in years.
Requires EnergyPlus simulation output and LifeCycleCost_Parameters input object to calculate.
| boost::optional<double> openstudio::model::Facility::economicsTLCC | ( | ) | const |
Returns the total life cycle cost over the analysis period in dollars according to the discounting convention.
Requires EnergyPlus simulation output and LifeCycleCost_Parameters input object to calculate.
| boost::optional<double> openstudio::model::Facility::economicsVirtualRateCombined | ( | ) | const |
Returns the virtual rate of all energy in dollars per gigajoule.
Requires EnergyPlus simulation output and LifeCycleCost_Parameters input object to calculate.
| boost::optional<double> openstudio::model::Facility::economicsVirtualRateElec | ( | ) | const |
Returns the virtual rate of electric energy in dollars per gigajoule.
Requires EnergyPlus simulation output and LifeCycleCost_Parameters input object to calculate.
| boost::optional<double> openstudio::model::Facility::economicsVirtualRateGas | ( | ) | const |
Returns the virtual rate of gas energy in dollars per gigajoule.
Requires EnergyPlus simulation output and LifeCycleCost_Parameters input object to calculate.
| boost::optional<double> openstudio::model::Facility::electricityCooling | ( | ) | const |
Returns the electric energy used for cooling in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::electricityExteriorEquipment | ( | ) | const |
Returns the electric energy used for exterior equipment in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::electricityExteriorLighting | ( | ) | const |
Returns the electric energy used for exterior lighting in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::electricityFans | ( | ) | const |
Returns the electric energy used for fans in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::electricityGenerators | ( | ) | const |
Returns the electric energy used for generators in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::electricityHeating | ( | ) | const |
Returns the electric energy used for heating in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::electricityHeatRecovery | ( | ) | const |
Returns the electric energy used for heat recovery in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::electricityHeatRejection | ( | ) | const |
Returns the electric energy used for heat rejection in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::electricityHumidification | ( | ) | const |
Returns the electric energy used for humidification in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::electricityInteriorEquipment | ( | ) | const |
Returns the electric energy used for interior equipment in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::electricityInteriorLighting | ( | ) | const |
Returns the electric energy used for interior lighting in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::electricityPumps | ( | ) | const |
Returns the electric energy used for pumps in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::electricityRefrigeration | ( | ) | const |
Returns the electric energy used for refrigeration in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::electricityTotalEndUses | ( | ) | const |
Returns the electric energy used for all uses in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::electricityWaterSystems | ( | ) | const |
Returns the electric energy used for water systems in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<EndUses> openstudio::model::Facility::endUses | ( | ) | const |
Returns an EndUse object containing all end uses for the simulation.
| std::vector<ExteriorFuelEquipment> openstudio::model::Facility::exteriorFuelEquipments | ( | ) | const |
Returns all ExteriorFuelEquipment.
| std::vector<ExteriorLights> openstudio::model::Facility::exteriorLights | ( | ) | const |
Returns all ExteriorLights.
| std::vector<ExteriorWaterEquipment> openstudio::model::Facility::exteriorWaterEquipments | ( | ) | const |
Returns all ExteriorWaterEquipment.
|
static |
Returns all FuelTypes which are fossil fuels.
| boost::optional<OutputMeter> openstudio::model::Facility::getMeterByFuelType | ( | const FuelType & | fuelType, |
| const std::string & | reportingFrequency = "Hourly", |
||
| const boost::optional< EndUseType > & | endUseType = boost::none, |
||
| const boost::optional< std::string > & | specificEndUse = boost::none |
||
| ) | const |
| boost::optional<double> openstudio::model::Facility::hoursCoolingSetpointNotMet | ( | ) | const |
Returns the total number of hours the cooling setpoint is not met.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::hoursHeatingSetpointNotMet | ( | ) | const |
Returns the total number of hours the heating setpoint is not met.
Requires EnergyPlus simulation output to calculate.
|
static |
| std::vector<OutputMeter> openstudio::model::Facility::meters | ( | ) | const |
Returns all OutputMeters at the Facility level.
| boost::optional<double> openstudio::model::Facility::naturalGasCooling | ( | ) | const |
Returns the natural gas energy used for cooling in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::naturalGasExteriorEquipment | ( | ) | const |
Returns the natural gas energy used for exterior equipment in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::naturalGasExteriorLighting | ( | ) | const |
Returns the natural gas energy used for exterior lighting in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::naturalGasFans | ( | ) | const |
Returns the natural gas energy used for fans in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::naturalGasGenerators | ( | ) | const |
Returns the natural gas energy used for generators in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::naturalGasHeating | ( | ) | const |
Returns the natural gas energy used for heating in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::naturalGasHeatRecovery | ( | ) | const |
Returns the natural gas energy used for heat recovery in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::naturalGasHeatRejection | ( | ) | const |
Returns the natural gas energy used for heat rejection in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::naturalGasHumidification | ( | ) | const |
Returns the natural gas energy used for humidification in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::naturalGasInteriorEquipment | ( | ) | const |
Returns the natural gas energy used for interior equipment in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::naturalGasInteriorLighting | ( | ) | const |
Returns the natural gas energy used for interior lighting in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::naturalGasPumps | ( | ) | const |
Returns the natural gas energy used for pumps in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::naturalGasRefrigeration | ( | ) | const |
Returns the natural gas energy used for refrigeration in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::naturalGasTotalEndUses | ( | ) | const |
Returns the natural gas energy used for all end uses in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::naturalGasWaterSystems | ( | ) | const |
Returns the natural gas energy used for water systems in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::netSiteEnergy | ( | ) | const |
Returns the net site energy in gigajoules. Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::netSourceEnergy | ( | ) | const |
Returns the net source energy in gigajoules. Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::otherFuelCooling | ( | ) | const |
Returns the energy used for cooling from other fuel in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::otherFuelExteriorEquipment | ( | ) | const |
Returns the energy used for exterior equipment from other fuel in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::otherFuelExteriorLighting | ( | ) | const |
Returns the energy used for exterior lighting from other fuel in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::otherFuelFans | ( | ) | const |
Returns the energy used for fans from other fuel in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::otherFuelGenerators | ( | ) | const |
Returns the energy used for generators from other fuel in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::otherFuelHeating | ( | ) | const |
Returns the energy used for heating from other fuel in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::otherFuelHeatRecovery | ( | ) | const |
Returns the energy used for heat recovery from other fuel in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::otherFuelHeatRejection | ( | ) | const |
Returns the energy used for heat rejection from other fuel in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::otherFuelHumidification | ( | ) | const |
Returns the energy used for humidification from other fuel in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::otherFuelInteriorEquipment | ( | ) | const |
Returns the energy used for interior equipment from other fuel in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::otherFuelInteriorLighting | ( | ) | const |
Returns the energy used for interior lighting from other fuel in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::otherFuelPumps | ( | ) | const |
Returns the energy used for pumps from other fuel in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::otherFuelRefrigeration | ( | ) | const |
Returns the energy used for refrigeration from other fuel in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::otherFuelTotalEndUses | ( | ) | const |
Returns the energy used for all end uses from other fuel in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::otherFuelWaterSystems | ( | ) | const |
Returns the energy used for water systems from other fuel in gigajoules.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::totalSiteEnergy | ( | ) | const |
Returns the total site energy in gigajoules. Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::totalSourceEnergy | ( | ) | const |
Returns the total source energy in gigajoules. Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::waterCooling | ( | ) | const |
Returns the water used for cooling in cubic meters.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::waterExteriorEquipment | ( | ) | const |
Returns the water used for exterior equipment in cubic meters.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::waterExteriorLighting | ( | ) | const |
Returns the water used for exterior lighting in cubic meters.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::waterFans | ( | ) | const |
Returns the water used for fans in cubic meters.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::waterGenerators | ( | ) | const |
Returns the water used for generators in cubic meters.
Requires EnergyPlus simulation output to calculate.class EndUseType;
| boost::optional<double> openstudio::model::Facility::waterHeating | ( | ) | const |
Returns the water used for heating in cubic meters.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::waterHeatRecovery | ( | ) | const |
Returns the water used for heat recovery in cubic meters.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::waterHeatRejection | ( | ) | const |
Returns the water used for heat rejection in cubic meters.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::waterHumidification | ( | ) | const |
Returns the water used for humidification in cubic meters.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::waterInteriorEquipment | ( | ) | const |
Returns the water used for interior equipment in cubic meters.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::waterInteriorLighting | ( | ) | const |
Returns the water used for interior lighting in cubic meters.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::waterPumps | ( | ) | const |
Returns the water used for pumps in cubic meters.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::waterRefrigeration | ( | ) | const |
Returns the water used for refrigeration in cubic meters.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::waterTotalEndUses | ( | ) | const |
Returns the water used for all uses in cubic meters.
Requires EnergyPlus simulation output to calculate.
| boost::optional<double> openstudio::model::Facility::waterWaterSystems | ( | ) | const |
Returns the water used for water systems in cubic meters.
Requires EnergyPlus simulation output to calculate.
|
related |