OpenStudioCore:utilities
openstudio::SqlFile Class Reference

SqlFile class is a transaction script around the sql output of EnergyPlus. More...

#include <SqlFile.hpp>

Public Member Functions

Constructors
 SqlFile ()
 default constructor More...
 
 SqlFile (const openstudio::path &path)
 constructor from path More...
 
 SqlFile (const openstudio::path &t_path, const openstudio::EpwFile &t_epwFile, const openstudio::DateTime &t_simulationTime, const openstudio::Calendar &t_calendar)
 initializes a new sql file for output Does not create the indexes, that must be done manually More...
 
virtual ~SqlFile ()
 
void removeIndexes ()
 
void createIndexes ()
 
File Queries and Operations
bool connectionOpen () const
 returns whether or not connection is open More...
 
openstudio::path path () const
 get the path More...
 
bool supportedVersion () const
 
bool close ()
 close the file More...
 
bool reopen ()
 re-open the file More...
 
std::string energyPlusSqliteFile () const
 Energy Plus eplusout.sql file name. More...
 
Standard Queries
boost::optional< double > hoursSimulated () const
 hours simulated More...
 
boost::optional< double > netSiteEnergy () const
 net site energy in GJ More...
 
boost::optional< double > netSourceEnergy () const
 net source energy in GJ More...
 
boost::optional< double > totalSiteEnergy () const
 total site energy in GJ More...
 
boost::optional< double > totalSourceEnergy () const
 total source energy in GJ 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. More...
 
boost::optional< double > economicsEnergyCost () const
 Returns the total energy cost over the analysis period in dollars according to the discounting convention. More...
 
OptionalDouble getElecOrGasUse (bool getGas=true) const
 
OptionalDouble getElecOrGasCost (bool bGetGas=true) const
 
boost::optional< EndUsesendUses () const
 Returns an EndUses object containing all end uses for the simulation. More...
 
boost::optional< double > energyConsumptionByMonth (const openstudio::EndUseFuelType &t_fuelType, const openstudio::EndUseCategoryType &t_categoryType, const openstudio::MonthOfYear &t_monthOfYear) const
 Returns the energy consumption for the given fuel type, category and month. More...
 
boost::optional< double > peakEnergyDemandByMonth (const openstudio::EndUseFuelType &t_fuelType, const openstudio::EndUseCategoryType &t_categoryType, const openstudio::MonthOfYear &t_monthOfYear) const
 Returns the energy demand for the given fuel type, category and month. 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< std::pair
< DateTime, DateTime > > 
daylightSavingsPeriod () const
 
std::string energyPlusVersion () const
 Energy plus version number. More...
 
Generic TimeSeries Interface
std::vector< std::string > availableTimeSeries ()
 
boost::optional
< openstudio::EnvironmentType > 
environmentType (const std::string &envPeriod) const
 
std::vector< std::string > availableEnvPeriods () const
 
std::vector< std::string > availableReportingFrequencies (const std::string &envPeriod)
 
boost::optional
< openstudio::ReportingFrequency > 
reportingFrequencyFromDB (const std::string &dbReportingFrequency)
 
std::vector< std::string > availableVariableNames (const std::string &envPeriod, const std::string &reportingFrequency) const
 
std::vector< TimeSeriestimeSeries (const std::string &envPeriod, const std::string &reportingFrequency, const std::string &timeSeriesName)
 
std::vector< std::string > availableKeyValues (const std::string &envPeriod, const std::string &reportingFrequency, const std::string &timeSeriesName)
 
boost::optional< double > runPeriodValue (const std::string &envPeriod, const std::string &timeSeriesName, const std::string &keyValue)
 
boost::optional< TimeSeriestimeSeries (const std::string &envPeriod, const std::string &reportingFrequency, const std::string &timeSeriesName, const std::string &keyValue)
 
std::vector
< SqlFileTimeSeriesQuery
expandQuery (const SqlFileTimeSeriesQuery &query)
 Expands query to create a vector of all matching queries. More...
 
std::vector< TimeSeriestimeSeries (const SqlFileTimeSeriesQuery &query)
 Executes query. More...
 
Illuminance Map Interface
std::vector< std::string > illuminanceMapNames () const
 get names of all available illuminance maps More...
 
std::vector< std::string > illuminanceMapNames (const std::string &envPeriod) const
 
std::vector< std::string > illuminanceMapZoneNames (const std::string &name) const
 get zone names of for specified illuminance map More...
 
std::vector< std::string > illuminanceMapZoneNames (const int &mapIndex) const
 
boost::optional< std::string > illuminanceMapRefPt (const std::string &name, const int &ptNum) const
 reference point for map - form RefPtn=(x:y:illuminance) More...
 
boost::optional< std::string > illuminanceMapRefPt (const int &mapIndex, const int &ptNum) const
 
boost::optional< double > illuminanceMapMinValue (const std::string &name) const
 minimum value of map More...
 
boost::optional< double > illuminanceMapMinValue (const int &mapIndex) const
 
boost::optional< double > illuminanceMapMaxValue (const std::string &name) const
 maximum value of map More...
 
boost::optional< double > illuminanceMapMaxValue (const int &mapIndex) const
 
void illuminanceMapMaxValue (const std::string &name, double &minValue, double &maxValue) const
 minimum and maximum of map More...
 
void illuminanceMapMaxValue (const int &mapIndex, double &minValue, double &maxValue) const
 
boost::optional< int > illuminanceMapIndex (const std::string &name) const
 
Vector illuminanceMapX (const std::string &name, const DateTime &dateTime) const
 x position (m) of the illuminance map More...
 
Vector illuminanceMapY (const std::string &name, const DateTime &dateTime) const
 y position (m) of the illuminance map More...
 
Vector illuminanceMapX (const int &hourlyReportIndex) const
 x position (m) of the illuminance map More...
 
Vector illuminanceMapY (const int &hourlyReportIndex) const
 y position (m) of the illuminance map More...
 
boost::optional< int > illuminanceMapHourlyReportIndex (const int &mapIndex, const DateTime &dateTime) const
 hourly report index for mapIndex at date and time More...
 
boost::optional< DateTimeilluminanceMapDate (const int &hourlyReportIndex) const
 date time at hourly report index More...
 
std::vector< int > illuminanceMapHourlyReportIndices (const std::string &name) const
 hourly report indices of the illuminance map More...
 
std::vector< std::pair< int,
DateTime > > 
illuminanceMapHourlyReportIndicesDates (const int &mapIndex) const
 hourly report indices of the illuminance map More...
 
std::vector< std::pair< int,
DateTime > > 
illuminanceMapHourlyReportIndicesDates (const std::string &name) const
 hourly report indices of the illuminance map More...
 
std::vector< int > illuminanceMapHourlyReportIndices (const int &mapIndex) const
 hourly report indices of the illuminance map More...
 
Matrix illuminanceMap (const std::string &name, const DateTime &dateTime) const
 value (lux) of the illuminance map at date and time value(i,j) is the illuminance at x(i), y(j) More...
 
Matrix illuminanceMap (const int &hourlyReportIndex) const
 value (lux) of the illuminance map at hourlyReportIndex value(i,j) is the illuminance at x(i), y(j) More...
 
void illuminanceMap (const int &hourlyReportIndex, std::vector< double > &x, std::vector< double > &y, std::vector< double > &illuminance) const
 value (lux) of the illuminance map at hourlyReportIndex value(i,j) is the illuminance at x(i), y(j) fills in x,y, illuminance More...
 
std::vector< SummaryDatagetSummaryData () const
 Returns the summary data for each installlocation and fuel type found in report variables. More...
 
int insertZone (const std::string &t_name, double t_relNorth, double t_originX, double t_originY, double t_originZ, double t_centroidX, double t_centroidY, double t_centroidZ, int t_ofType, double t_multiplier, double t_listMultiplier, double t_minimumX, double t_maximumX, double t_minimumY, double t_maximumY, double t_minimumZ, double t_maximumZ, double t_ceilingHeight, double t_volume, int t_insideConvectionAlgo, int t_outsideConvectionAlgo, double t_floorArea, double t_extGrossWallArea, double t_extNetWallArea, double t_extWindowArea, bool t_isPartOfTotalArea)
 
void insertIlluminanceMap (const std::string &t_zoneName, const std::string &name, const std::string &t_environmentName, const std::vector< DateTime > &t_times, const std::vector< double > &t_xs, const std::vector< double > &t_ys, double t_z, const std::vector< Matrix > &t_maps)
 
Generic Query Interface
boost::optional< double > execAndReturnFirstDouble (const std::string &statement) const
 execute a statement and return the first (if any) value as a double More...
 
boost::optional< int > execAndReturnFirstInt (const std::string &statement) const
 execute a statement and return the first (if any) value as a int More...
 
boost::optional< std::string > execAndReturnFirstString (const std::string &statement) const
 execute a statement and return the first (if any) value as a string More...
 
boost::optional< std::vector
< double > > 
execAndReturnVectorOfDouble (const std::string &statement) const
 execute a statement and return the results (if any) in a vector of double More...
 
boost::optional< std::vector
< int > > 
execAndReturnVectorOfInt (const std::string &statement) const
 execute a statement and return the results (if any) in a vector of int More...
 
boost::optional< std::vector
< std::string > > 
execAndReturnVectorOfString (const std::string &statement) const
 execute a statement and return the results (if any) in a vector of string More...
 
int execute (const std::string &statement)
 execute a statement and return the error code, used for create/drop tables More...
 
void insertTimeSeriesData (const std::string &t_variableType, const std::string &t_indexGroup, const std::string &t_timestepType, const std::string &t_keyValue, const std::string &t_variableName, const openstudio::ReportingFrequency &t_reportingFrequency, const boost::optional< std::string > &t_scheduleName, const std::string &t_variableUnits, const openstudio::TimeSeries &t_timeSeries)
 
Operators
bool operator== (const SqlFile &other) const
 
bool operator< (const SqlFile &other) const
 

Friends

class ::resultsviewer::TableView
 returns datadictionary of available timeseries More...
 

Related Functions

(Note that these are not member functions.)

Table monthlyEndUsesTable (const SqlFile &sqlFile, const EndUseFuelType &fuelType, const Unit &unit=createSIEnergy())
 Returns the monthly end uses table for sqlFile and fuelType. More...
 

Detailed Description

SqlFile class is a transaction script around the sql output of EnergyPlus.

Constructor & Destructor Documentation

openstudio::SqlFile::SqlFile ( )

default constructor

openstudio::SqlFile::SqlFile ( const openstudio::path path)
explicit

constructor from path

openstudio::SqlFile::SqlFile ( const openstudio::path t_path,
const openstudio::EpwFile t_epwFile,
const openstudio::DateTime t_simulationTime,
const openstudio::Calendar t_calendar 
)

initializes a new sql file for output Does not create the indexes, that must be done manually

virtual openstudio::SqlFile::~SqlFile ( )
virtual

Member Function Documentation

boost::optional<double> openstudio::SqlFile::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::SqlFile::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::SqlFile::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::SqlFile::annualTotalUtilityCost ( ) const

Returns the annual total cost for all fuel types in dollars.

Requires EnergyPlus simulation output to calculate. Attribute name: annualTotalUtilityCost

std::vector<std::string> openstudio::SqlFile::availableEnvPeriods ( ) const
std::vector<std::string> openstudio::SqlFile::availableKeyValues ( const std::string &  envPeriod,
const std::string &  reportingFrequency,
const std::string &  timeSeriesName 
)
std::vector<std::string> openstudio::SqlFile::availableReportingFrequencies ( const std::string &  envPeriod)
std::vector<std::string> openstudio::SqlFile::availableTimeSeries ( )
std::vector<std::string> openstudio::SqlFile::availableVariableNames ( const std::string &  envPeriod,
const std::string &  reportingFrequency 
) const
bool openstudio::SqlFile::close ( )

close the file

bool openstudio::SqlFile::connectionOpen ( ) const

returns whether or not connection is open

void openstudio::SqlFile::createIndexes ( )
boost::optional<std::pair<DateTime, DateTime> > openstudio::SqlFile::daylightSavingsPeriod ( ) const
boost::optional<double> openstudio::SqlFile::districtCoolingCooling ( ) const

Returns the district cooling energy used for cooling in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: districtCoolingCooling

boost::optional<double> openstudio::SqlFile::districtCoolingExteriorEquipment ( ) const

Returns the district cooling energy used for exterior equipment in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: districtCoolingExteriorEquipment

boost::optional<double> openstudio::SqlFile::districtCoolingExteriorLighting ( ) const

Returns the district cooling energy used for exterior lighting in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: districtCoolingExteriorLighting

boost::optional<double> openstudio::SqlFile::districtCoolingFans ( ) const

Returns the district cooling energy used for fans in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: districtCoolingFans

boost::optional<double> openstudio::SqlFile::districtCoolingGenerators ( ) const

Returns the district cooling energy used for generators in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: districtCoolingRefrigeration

boost::optional<double> openstudio::SqlFile::districtCoolingHeating ( ) const

Returns the district cooling energy used for heating in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: districtCoolingHeating

boost::optional<double> openstudio::SqlFile::districtCoolingHeatRecovery ( ) const

Returns the district cooling energy used for heat recovery in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: districtCoolingHeatRecovery

boost::optional<double> openstudio::SqlFile::districtCoolingHeatRejection ( ) const

Returns the district cooling energy used for heat rejection in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: districtCoolingHeatRejection

boost::optional<double> openstudio::SqlFile::districtCoolingHumidification ( ) const

Returns the district cooling energy used for humidification in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: districtCoolingHumidification

boost::optional<double> openstudio::SqlFile::districtCoolingInteriorEquipment ( ) const

Returns the district cooling energy used for interior equipment in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: districtCoolingInteriorEquipment

boost::optional<double> openstudio::SqlFile::districtCoolingInteriorLighting ( ) const

Returns the district cooling energy used for interior lighting in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: districtCoolingInteriorLighting

boost::optional<double> openstudio::SqlFile::districtCoolingPumps ( ) const

Returns the district cooling energy used for pumps in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: districtCoolingPumps

boost::optional<double> openstudio::SqlFile::districtCoolingRefrigeration ( ) const

Returns the district cooling energy used for refrigeration in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: districtCoolingRefrigeration

boost::optional<double> openstudio::SqlFile::districtCoolingTotalEndUses ( ) const

Returns the district cooling energy used for all end uses in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: districtCoolingRefrigeration

boost::optional<double> openstudio::SqlFile::districtCoolingWaterSystems ( ) const

Returns the district cooling energy used for water systems in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: districtCoolingWaterSystems

boost::optional<double> openstudio::SqlFile::districtHeatingCooling ( ) const

Returns the district heating energy used for cooling in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: districtHeatingCooling

boost::optional<double> openstudio::SqlFile::districtHeatingExteriorEquipment ( ) const

Returns the district heating energy used for exterior equipment in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: districtHeatingExteriorEquipment

boost::optional<double> openstudio::SqlFile::districtHeatingExteriorLighting ( ) const

Returns the district heating energy used for exterior lighting in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: districtHeatingExteriorLighting

boost::optional<double> openstudio::SqlFile::districtHeatingFans ( ) const

Returns the district heating energy used for fans in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: districtHeatingFans

boost::optional<double> openstudio::SqlFile::districtHeatingGenerators ( ) const

Returns the district heating energy used for generators in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: districtHeatingGenerators

boost::optional<double> openstudio::SqlFile::districtHeatingHeating ( ) const

Returns the district heating energy used for heating in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: districtHeatingHeating

boost::optional<double> openstudio::SqlFile::districtHeatingHeatRecovery ( ) const

Returns the district heating energy used for heat recovery in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: districtHeatingHeatRecovery

boost::optional<double> openstudio::SqlFile::districtHeatingHeatRejection ( ) const

Returns the district heating energy used for heat rejection in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: districtHeatingHeatRejection

boost::optional<double> openstudio::SqlFile::districtHeatingHumidification ( ) const

Returns the district heating energy used for humidification in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: districtHeatingHumidification

boost::optional<double> openstudio::SqlFile::districtHeatingInteriorEquipment ( ) const

Returns the district heating energy used for interior equipment in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: districtHeatingInteriorEquipment

boost::optional<double> openstudio::SqlFile::districtHeatingInteriorLighting ( ) const

Returns the district heating energy used for interior lighting in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: districtHeatingInteriorLighting

boost::optional<double> openstudio::SqlFile::districtHeatingPumps ( ) const

Returns the district heating energy used for pumps in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: districtHeatingPumps

boost::optional<double> openstudio::SqlFile::districtHeatingRefrigeration ( ) const

Returns the district heating energy used for refrigeration in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: districtHeatingRefrigeration

boost::optional<double> openstudio::SqlFile::districtHeatingTotalEndUses ( ) const

Returns the district heating energy used for all end uses in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: districtHeatingTotalEndUses

boost::optional<double> openstudio::SqlFile::districtHeatingWaterSystems ( ) const

Returns the district heating energy used for water systems in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: districtHeatingWaterSystems

boost::optional<double> openstudio::SqlFile::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. Attribute name: economicsEnergyCost

boost::optional<double> openstudio::SqlFile::electricityCooling ( ) const

Returns the electric energy used for cooling in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: electricityCooling

boost::optional<double> openstudio::SqlFile::electricityExteriorEquipment ( ) const

Returns the electric energy used for exterior equipment in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: electricityExteriorEquipment

boost::optional<double> openstudio::SqlFile::electricityExteriorLighting ( ) const

Returns the electric energy used for exterior lighting in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: electricityExteriorLighting

boost::optional<double> openstudio::SqlFile::electricityFans ( ) const

Returns the electric energy used for fans in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: electricityFans

boost::optional<double> openstudio::SqlFile::electricityGenerators ( ) const

Returns the electric energy used for generators in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: electricityGenerators

boost::optional<double> openstudio::SqlFile::electricityHeating ( ) const

Returns the electric energy used for heating in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: electricityHeating

boost::optional<double> openstudio::SqlFile::electricityHeatRecovery ( ) const

Returns the electric energy used for heat recovery in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: electricityHeatRecovery

boost::optional<double> openstudio::SqlFile::electricityHeatRejection ( ) const

Returns the electric energy used for heat rejection in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: electricityHeatRejection

boost::optional<double> openstudio::SqlFile::electricityHumidification ( ) const

Returns the electric energy used for humidification in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: electricityHumidification

boost::optional<double> openstudio::SqlFile::electricityInteriorEquipment ( ) const

Returns the electric energy used for interior equipment in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: electricityInteriorEquipment

boost::optional<double> openstudio::SqlFile::electricityInteriorLighting ( ) const

Returns the electric energy used for interior lighting in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: electricityInteriorLighting

boost::optional<double> openstudio::SqlFile::electricityPumps ( ) const

Returns the electric energy used for pumps in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: electricityPumps

boost::optional<double> openstudio::SqlFile::electricityRefrigeration ( ) const

Returns the electric energy used for refrigeration in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: electricityRefrigeration

boost::optional<double> openstudio::SqlFile::electricityTotalEndUses ( ) const

Returns the electric energy used for all uses in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: electricityTotalEndUses

boost::optional<double> openstudio::SqlFile::electricityWaterSystems ( ) const

Returns the electric energy used for water systems in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: electricityWaterSystems

boost::optional<EndUses> openstudio::SqlFile::endUses ( ) const

Returns an EndUses object containing all end uses for the simulation.

boost::optional<double> openstudio::SqlFile::energyConsumptionByMonth ( const openstudio::EndUseFuelType &  t_fuelType,
const openstudio::EndUseCategoryType &  t_categoryType,
const openstudio::MonthOfYear &  t_monthOfYear 
) const

Returns the energy consumption for the given fuel type, category and month.

Requires BUILDING ENERGY PERFORMANCE tabular report. Value is energy use in J.

std::string openstudio::SqlFile::energyPlusSqliteFile ( ) const

Energy Plus eplusout.sql file name.

std::string openstudio::SqlFile::energyPlusVersion ( ) const

Energy plus version number.

boost::optional<openstudio::EnvironmentType> openstudio::SqlFile::environmentType ( const std::string &  envPeriod) const
boost::optional<double> openstudio::SqlFile::execAndReturnFirstDouble ( const std::string &  statement) const

execute a statement and return the first (if any) value as a double

boost::optional<int> openstudio::SqlFile::execAndReturnFirstInt ( const std::string &  statement) const

execute a statement and return the first (if any) value as a int

boost::optional<std::string> openstudio::SqlFile::execAndReturnFirstString ( const std::string &  statement) const

execute a statement and return the first (if any) value as a string

boost::optional<std::vector<double> > openstudio::SqlFile::execAndReturnVectorOfDouble ( const std::string &  statement) const

execute a statement and return the results (if any) in a vector of double

boost::optional<std::vector<int> > openstudio::SqlFile::execAndReturnVectorOfInt ( const std::string &  statement) const

execute a statement and return the results (if any) in a vector of int

boost::optional<std::vector<std::string> > openstudio::SqlFile::execAndReturnVectorOfString ( const std::string &  statement) const

execute a statement and return the results (if any) in a vector of string

int openstudio::SqlFile::execute ( const std::string &  statement)

execute a statement and return the error code, used for create/drop tables

std::vector<SqlFileTimeSeriesQuery> openstudio::SqlFile::expandQuery ( const SqlFileTimeSeriesQuery query)

Expands query to create a vector of all matching queries.

The returned queries will have one environment period, one reporting frequency, and one time series name specified. The returned queries will also be "vetted".

OptionalDouble openstudio::SqlFile::getElecOrGasCost ( bool  bGetGas = true) const
OptionalDouble openstudio::SqlFile::getElecOrGasUse ( bool  getGas = true) const
std::vector<SummaryData> openstudio::SqlFile::getSummaryData ( ) const

Returns the summary data for each installlocation and fuel type found in report variables.

boost::optional<double> openstudio::SqlFile::hoursCoolingSetpointNotMet ( ) const

Returns the total number of hours the cooling setpoint is not met.

Requires EnergyPlus simulation output to calculate.

boost::optional<double> openstudio::SqlFile::hoursHeatingSetpointNotMet ( ) const

Returns the total number of hours the heating setpoint is not met.

Requires EnergyPlus simulation output to calculate.

boost::optional<double> openstudio::SqlFile::hoursSimulated ( ) const

hours simulated

Matrix openstudio::SqlFile::illuminanceMap ( const std::string &  name,
const DateTime dateTime 
) const

value (lux) of the illuminance map at date and time value(i,j) is the illuminance at x(i), y(j)

Matrix openstudio::SqlFile::illuminanceMap ( const int &  hourlyReportIndex) const

value (lux) of the illuminance map at hourlyReportIndex value(i,j) is the illuminance at x(i), y(j)

void openstudio::SqlFile::illuminanceMap ( const int &  hourlyReportIndex,
std::vector< double > &  x,
std::vector< double > &  y,
std::vector< double > &  illuminance 
) const

value (lux) of the illuminance map at hourlyReportIndex value(i,j) is the illuminance at x(i), y(j) fills in x,y, illuminance

boost::optional<DateTime> openstudio::SqlFile::illuminanceMapDate ( const int &  hourlyReportIndex) const

date time at hourly report index

boost::optional<int> openstudio::SqlFile::illuminanceMapHourlyReportIndex ( const int &  mapIndex,
const DateTime dateTime 
) const

hourly report index for mapIndex at date and time

std::vector<int> openstudio::SqlFile::illuminanceMapHourlyReportIndices ( const std::string &  name) const

hourly report indices of the illuminance map

std::vector<int> openstudio::SqlFile::illuminanceMapHourlyReportIndices ( const int &  mapIndex) const

hourly report indices of the illuminance map

std::vector< std::pair<int, DateTime> > openstudio::SqlFile::illuminanceMapHourlyReportIndicesDates ( const int &  mapIndex) const

hourly report indices of the illuminance map

std::vector< std::pair<int, DateTime> > openstudio::SqlFile::illuminanceMapHourlyReportIndicesDates ( const std::string &  name) const

hourly report indices of the illuminance map

boost::optional<int> openstudio::SqlFile::illuminanceMapIndex ( const std::string &  name) const
boost::optional<double> openstudio::SqlFile::illuminanceMapMaxValue ( const std::string &  name) const

maximum value of map

boost::optional<double> openstudio::SqlFile::illuminanceMapMaxValue ( const int &  mapIndex) const
void openstudio::SqlFile::illuminanceMapMaxValue ( const std::string &  name,
double &  minValue,
double &  maxValue 
) const

minimum and maximum of map

void openstudio::SqlFile::illuminanceMapMaxValue ( const int &  mapIndex,
double &  minValue,
double &  maxValue 
) const
boost::optional<double> openstudio::SqlFile::illuminanceMapMinValue ( const std::string &  name) const

minimum value of map

boost::optional<double> openstudio::SqlFile::illuminanceMapMinValue ( const int &  mapIndex) const
std::vector<std::string> openstudio::SqlFile::illuminanceMapNames ( ) const

get names of all available illuminance maps

std::vector<std::string> openstudio::SqlFile::illuminanceMapNames ( const std::string &  envPeriod) const
boost::optional<std::string> openstudio::SqlFile::illuminanceMapRefPt ( const std::string &  name,
const int &  ptNum 
) const

reference point for map - form RefPtn=(x:y:illuminance)

boost::optional<std::string> openstudio::SqlFile::illuminanceMapRefPt ( const int &  mapIndex,
const int &  ptNum 
) const
Vector openstudio::SqlFile::illuminanceMapX ( const std::string &  name,
const DateTime dateTime 
) const

x position (m) of the illuminance map

Vector openstudio::SqlFile::illuminanceMapX ( const int &  hourlyReportIndex) const

x position (m) of the illuminance map

Vector openstudio::SqlFile::illuminanceMapY ( const std::string &  name,
const DateTime dateTime 
) const

y position (m) of the illuminance map

Vector openstudio::SqlFile::illuminanceMapY ( const int &  hourlyReportIndex) const

y position (m) of the illuminance map

std::vector<std::string> openstudio::SqlFile::illuminanceMapZoneNames ( const std::string &  name) const

get zone names of for specified illuminance map

std::vector<std::string> openstudio::SqlFile::illuminanceMapZoneNames ( const int &  mapIndex) const
void openstudio::SqlFile::insertIlluminanceMap ( const std::string &  t_zoneName,
const std::string &  name,
const std::string &  t_environmentName,
const std::vector< DateTime > &  t_times,
const std::vector< double > &  t_xs,
const std::vector< double > &  t_ys,
double  t_z,
const std::vector< Matrix > &  t_maps 
)
void openstudio::SqlFile::insertTimeSeriesData ( const std::string &  t_variableType,
const std::string &  t_indexGroup,
const std::string &  t_timestepType,
const std::string &  t_keyValue,
const std::string &  t_variableName,
const openstudio::ReportingFrequency &  t_reportingFrequency,
const boost::optional< std::string > &  t_scheduleName,
const std::string &  t_variableUnits,
const openstudio::TimeSeries t_timeSeries 
)
int openstudio::SqlFile::insertZone ( const std::string &  t_name,
double  t_relNorth,
double  t_originX,
double  t_originY,
double  t_originZ,
double  t_centroidX,
double  t_centroidY,
double  t_centroidZ,
int  t_ofType,
double  t_multiplier,
double  t_listMultiplier,
double  t_minimumX,
double  t_maximumX,
double  t_minimumY,
double  t_maximumY,
double  t_minimumZ,
double  t_maximumZ,
double  t_ceilingHeight,
double  t_volume,
int  t_insideConvectionAlgo,
int  t_outsideConvectionAlgo,
double  t_floorArea,
double  t_extGrossWallArea,
double  t_extNetWallArea,
double  t_extWindowArea,
bool  t_isPartOfTotalArea 
)
boost::optional<double> openstudio::SqlFile::naturalGasCooling ( ) const

Returns the natural gas energy used for cooling in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: naturalGasCooling

boost::optional<double> openstudio::SqlFile::naturalGasExteriorEquipment ( ) const

Returns the natural gas energy used for exterior equipment in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: naturalGasInteriorEquipment

boost::optional<double> openstudio::SqlFile::naturalGasExteriorLighting ( ) const

Returns the natural gas energy used for exterior lighting in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: naturalGasExteriorLighting

boost::optional<double> openstudio::SqlFile::naturalGasFans ( ) const

Returns the natural gas energy used for fans in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: naturalGasFans

boost::optional<double> openstudio::SqlFile::naturalGasGenerators ( ) const

Returns the natural gas energy used for generators in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: naturalGasGenerators

boost::optional<double> openstudio::SqlFile::naturalGasHeating ( ) const

Returns the natural gas energy used for heating in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: naturalGasHeating

boost::optional<double> openstudio::SqlFile::naturalGasHeatRecovery ( ) const

Returns the natural gas energy used for heat recovery in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: naturalGasHeatRecovery

boost::optional<double> openstudio::SqlFile::naturalGasHeatRejection ( ) const

Returns the natural gas energy used for heat rejection in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: naturalGasHeatRejection

boost::optional<double> openstudio::SqlFile::naturalGasHumidification ( ) const

Returns the natural gas energy used for humidification in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: naturalGasHumidification

boost::optional<double> openstudio::SqlFile::naturalGasInteriorEquipment ( ) const

Returns the natural gas energy used for interior equipment in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: naturalGasInteriorEquipment

boost::optional<double> openstudio::SqlFile::naturalGasInteriorLighting ( ) const

Returns the natural gas energy used for interior lighting in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: naturalGasInteriorLighting

boost::optional<double> openstudio::SqlFile::naturalGasPumps ( ) const

Returns the natural gas energy used for pumps in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: naturalGasPumps

boost::optional<double> openstudio::SqlFile::naturalGasRefrigeration ( ) const

Returns the natural gas energy used for refrigeration in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: naturalGasRefrigeration

boost::optional<double> openstudio::SqlFile::naturalGasTotalEndUses ( ) const

Returns the natural gas energy used for all end uses in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: naturalGasGenerators

boost::optional<double> openstudio::SqlFile::naturalGasWaterSystems ( ) const

Returns the natural gas energy used for water systems in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: naturalGasWaterSystems

boost::optional<double> openstudio::SqlFile::netSiteEnergy ( ) const

net site energy in GJ

boost::optional<double> openstudio::SqlFile::netSourceEnergy ( ) const

net source energy in GJ

bool openstudio::SqlFile::operator< ( const SqlFile other) const
bool openstudio::SqlFile::operator== ( const SqlFile other) const
boost::optional<double> openstudio::SqlFile::otherFuelCooling ( ) const

Returns the energy used for cooling from other fuel in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: otherFuelCooling

boost::optional<double> openstudio::SqlFile::otherFuelExteriorEquipment ( ) const

Returns the energy used for exterior equipment from other fuel in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: otherFuelExteriorEquipment

boost::optional<double> openstudio::SqlFile::otherFuelExteriorLighting ( ) const

Returns the energy used for exterior lighting from other fuel in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: otherFuelExteriorLighting

boost::optional<double> openstudio::SqlFile::otherFuelFans ( ) const

Returns the energy used for fans from other fuel in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: otherFuelFans

boost::optional<double> openstudio::SqlFile::otherFuelGenerators ( ) const

Returns the energy used for generators from other fuel in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: otherFuelGenerators

boost::optional<double> openstudio::SqlFile::otherFuelHeating ( ) const

Returns the energy used for heating from other fuel in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: otherFuelHeating

boost::optional<double> openstudio::SqlFile::otherFuelHeatRecovery ( ) const

Returns the energy used for heat recovery from other fuel in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: otherFuelHeatRecovery

boost::optional<double> openstudio::SqlFile::otherFuelHeatRejection ( ) const

Returns the energy used for heat rejection from other fuel in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: otherFuelHeatRejection

boost::optional<double> openstudio::SqlFile::otherFuelHumidification ( ) const

Returns the energy used for humidification from other fuel in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: otherFuelHumidification

boost::optional<double> openstudio::SqlFile::otherFuelInteriorEquipment ( ) const

Returns the energy used for interior equipment from other fuel in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: otherFuelInteriorEquipment

boost::optional<double> openstudio::SqlFile::otherFuelInteriorLighting ( ) const

Returns the energy used for interior lighting from other fuel in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: otherFuelInteriorLighting

boost::optional<double> openstudio::SqlFile::otherFuelPumps ( ) const

Returns the energy used for pumps from other fuel in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: otherFuelPumps

boost::optional<double> openstudio::SqlFile::otherFuelRefrigeration ( ) const

Returns the energy used for refrigeration from other fuel in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: otherFuelRefrigeration

boost::optional<double> openstudio::SqlFile::otherFuelTotalEndUses ( ) const

Returns the energy used for all end uses from other fuel in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: otherFuelTotalEndUses

boost::optional<double> openstudio::SqlFile::otherFuelWaterSystems ( ) const

Returns the energy used for water systems from other fuel in gigajoules.

Requires EnergyPlus simulation output to calculate. Attribute name: otherFuelWaterSystems

openstudio::path openstudio::SqlFile::path ( ) const

get the path

boost::optional<double> openstudio::SqlFile::peakEnergyDemandByMonth ( const openstudio::EndUseFuelType &  t_fuelType,
const openstudio::EndUseCategoryType &  t_categoryType,
const openstudio::MonthOfYear &  t_monthOfYear 
) const

Returns the energy demand for the given fuel type, category and month.

Requires BUILDING ENERGY PERFORMANCE tabular report. Value is energy use in W.

void openstudio::SqlFile::removeIndexes ( )
bool openstudio::SqlFile::reopen ( )

re-open the file

boost::optional<openstudio::ReportingFrequency> openstudio::SqlFile::reportingFrequencyFromDB ( const std::string &  dbReportingFrequency)
boost::optional<double> openstudio::SqlFile::runPeriodValue ( const std::string &  envPeriod,
const std::string &  timeSeriesName,
const std::string &  keyValue 
)
bool openstudio::SqlFile::supportedVersion ( ) const
Returns
true if the sqlfile is of a version that's in our supported range
std::vector<TimeSeries> openstudio::SqlFile::timeSeries ( const std::string &  envPeriod,
const std::string &  reportingFrequency,
const std::string &  timeSeriesName 
)
boost::optional<TimeSeries> openstudio::SqlFile::timeSeries ( const std::string &  envPeriod,
const std::string &  reportingFrequency,
const std::string &  timeSeriesName,
const std::string &  keyValue 
)
std::vector<TimeSeries> openstudio::SqlFile::timeSeries ( const SqlFileTimeSeriesQuery query)

Executes query.

ReportingFrequency must be specified. Use expandQuery first to break query down by ReportingFrequency and determine how many TimeSeries will be returned.

boost::optional<double> openstudio::SqlFile::totalSiteEnergy ( ) const

total site energy in GJ

boost::optional<double> openstudio::SqlFile::totalSourceEnergy ( ) const

total source energy in GJ

boost::optional<double> openstudio::SqlFile::waterCooling ( ) const

Returns the water used for cooling in cubic meters.

Requires EnergyPlus simulation output to calculate. Attribute name: waterCooling

boost::optional<double> openstudio::SqlFile::waterExteriorEquipment ( ) const

Returns the water used for exterior equipment in cubic meters.

Requires EnergyPlus simulation output to calculate. Attribute name: waterExteriorEquipment

boost::optional<double> openstudio::SqlFile::waterExteriorLighting ( ) const

Returns the water used for exterior lighting in cubic meters.

Requires EnergyPlus simulation output to calculate. Attribute name: waterExteriorLighting

boost::optional<double> openstudio::SqlFile::waterFans ( ) const

Returns the water used for fans in cubic meters.

Requires EnergyPlus simulation output to calculate. Attribute name: waterFans

boost::optional<double> openstudio::SqlFile::waterGenerators ( ) const

Returns the water used for generators in cubic meters.

Requires EnergyPlus simulation output to calculate. Attribute name: waterGenerators

boost::optional<double> openstudio::SqlFile::waterHeating ( ) const

Returns the water used for heating in cubic meters.

Requires EnergyPlus simulation output to calculate. Attribute name: waterHeating

boost::optional<double> openstudio::SqlFile::waterHeatRecovery ( ) const

Returns the water used for heat recovery in cubic meters.

Requires EnergyPlus simulation output to calculate. Attribute name: waterHeatRecovery

boost::optional<double> openstudio::SqlFile::waterHeatRejection ( ) const

Returns the water used for heat rejection in cubic meters.

Requires EnergyPlus simulation output to calculate. Attribute name: waterHeatRejection

boost::optional<double> openstudio::SqlFile::waterHumidification ( ) const

Returns the water used for humidification in cubic meters.

Requires EnergyPlus simulation output to calculate. Attribute name: waterHumidification

boost::optional<double> openstudio::SqlFile::waterInteriorEquipment ( ) const

Returns the water used for interior equipment in cubic meters.

Requires EnergyPlus simulation output to calculate. Attribute name: waterInteriorEquipment

boost::optional<double> openstudio::SqlFile::waterInteriorLighting ( ) const

Returns the water used for interior lighting in cubic meters.

Requires EnergyPlus simulation output to calculate. Attribute name: waterInteriorLighting

boost::optional<double> openstudio::SqlFile::waterPumps ( ) const

Returns the water used for pumps in cubic meters.

Requires EnergyPlus simulation output to calculate. Attribute name: waterPumps

boost::optional<double> openstudio::SqlFile::waterRefrigeration ( ) const

Returns the water used for refrigeration in cubic meters.

Requires EnergyPlus simulation output to calculate. Attribute name: waterRefrigeration

boost::optional<double> openstudio::SqlFile::waterTotalEndUses ( ) const

Returns the water used for all uses in cubic meters.

Requires EnergyPlus simulation output to calculate. Attribute name: waterTotalEndUses

boost::optional<double> openstudio::SqlFile::waterWaterSystems ( ) const

Returns the water used for water systems in cubic meters.

Requires EnergyPlus simulation output to calculate. Attribute name: waterWaterSystems

Friends And Related Function Documentation

friend class ::resultsviewer::TableView
friend

returns datadictionary of available timeseries

Table monthlyEndUsesTable ( const SqlFile sqlFile,
const EndUseFuelType fuelType,
const Unit unit = createSIEnergy() 
)
related

Returns the monthly end uses table for sqlFile and fuelType.

By default, the table values are returned in J. If a different energy unit is desired, specify unit. If unit is invalid, the default table will be returned.


The documentation for this class was generated from the following file: