All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Public Member Functions | Static Public Member Functions | Related Functions | List of all members
openstudio::model::UtilityBill Class Reference

#include <UtilityBill.hpp>

+ Inheritance diagram for openstudio::model::UtilityBill:

Public Member Functions

std::vector< std::string > consumptionUnitValues ()
std::vector< std::string > peakDemandUnitValues ()
Constructors and Destructors
 UtilityBill (const FuelType &fuelType, const Model &model)
virtual ~UtilityBill ()
FuelType fuelType () const
InstallLocationType meterInstallLocation () const
bool isMeterInstallLocationDefaulted () const
boost::optional< std::string > meterSpecificInstallLocation () const
< EndUseCategoryType > 
meterEndUseCategory () const
boost::optional< std::string > meterSpecificEndUse () const
std::string consumptionUnit () const
boost::optional< std::string > consumptionUnitDescription () const
double consumptionUnitConversionFactor () const
bool isConsumptionUnitConversionFactorDefaulted () const
boost::optional< std::string > peakDemandUnit () const
boost::optional< std::string > peakDemandUnitDescription () const
boost::optional< double > peakDemandUnitConversionFactor () const
boost::optional< unsigned > timestepsInPeakDemandWindow () const
bool isTimestepsInPeakDemandWindowDefaulted () const
boost::optional< double > minutesInPeakDemandWindow () const
std::vector< BillingPeriodbillingPeriods () const
bool setMeterInstallLocation (const InstallLocationType &meterInstallLocation)
void resetMeterInstallLocation ()
bool setMeterSpecificInstallLocation (const std::string &meterSpecificInstallLocation)
void resetMeterSpecificInstallLocation ()
bool setMeterEndUseCategory (const EndUseCategoryType &meterEndUseCategory)
void resetMeterEndUseCategory ()
bool setMeterSpecificEndUse (const std::string &meterSpecificEndUse)
void resetMeterSpecificEndUse ()
bool setConsumptionUnit (const std::string &consumptionUnit)
bool setConsumptionUnitConversionFactor (double consumptionUnitConversionFactor)
void resetConsumptionUnitConversionFactor ()
bool setPeakDemandUnit (const std::string &peakDemandUnit)
bool setTimestepsInPeakDemandWindow (unsigned timestepsInPeakDemandWindow)
void resetTimestepsInPeakDemandWindow ()
void clearBillingPeriods ()
BillingPeriod addBillingPeriod ()
OutputMeter consumptionMeter () const
 Gets the meter associated with consumption for this UtilityBill, creates it if it does not exist. More...
boost::optional< OutputMeterpeakDemandMeter () const
 Gets the meter associated with peak demand for this UtilityBill, creates it if it does not exist. More...
unsigned numberBillingPeriodsInCalculations () const
 Number of billing periods used to compute CVRMSE or NMBE. More...
boost::optional< double > CVRMSE () const
 Coefficient of variation of the root mean square error, see ASHRAE 14-2002 More...
boost::optional< double > NMBE () const
 Normalized mean bias error, see ASHRAE 14-2002 More...
- 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< ParentObjectparent () const
 Return this object's parent in the hierarchy, if it has one. More...
std::vector< ResourceObjectresources () 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< OutputVariableoutputVariables () const
 Get all output variables associated with this object, must run simulation to generate data. More...
< openstudio::TimeSeries > 
getData (const OutputVariable &variable, const std::string &envPeriod) const
 Get data associated with this output variable and this object. More...
std::vector< LifeCycleCostlifeCycleCosts () 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< ScheduleTypeKeygetScheduleTypeKeys (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< ModelObjectconnectedObject (unsigned port) const
boost::optional< unsigned > connectedObjectPort (unsigned port) const

Static Public Member Functions

static std::vector< std::string > calibrationGuidelines ()
static IddObjectType iddObjectType ()
static boost::optional< double > maxCVRMSE (const std::string &calibrationGuideline)
static boost::optional< double > maxNMBE (const std::string &calibrationGuideline)

Related Functions

(Note that these are not member functions.)

typedef boost::optional
< UtilityBill
typedef std::vector< UtilityBillUtilityBillVector

Additional Inherited Members

- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl ImplType
- 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)

Detailed Description

UtilityBill is a ModelObject that wraps the OpenStudio IDD object 'OS:UtilityBill'.

This object allows the user to enter in actual fuel usage for model calibration.

Constructor & Destructor Documentation

openstudio::model::UtilityBill::UtilityBill ( const FuelType &  fuelType,
const Model model 
virtual openstudio::model::UtilityBill::~UtilityBill ( )

Member Function Documentation

BillingPeriod openstudio::model::UtilityBill::addBillingPeriod ( )
std::vector<BillingPeriod> openstudio::model::UtilityBill::billingPeriods ( ) const
static std::vector<std::string> openstudio::model::UtilityBill::calibrationGuidelines ( )
void openstudio::model::UtilityBill::clearBillingPeriods ( )
OutputMeter openstudio::model::UtilityBill::consumptionMeter ( ) const

Gets the meter associated with consumption for this UtilityBill, creates it if it does not exist.

std::string openstudio::model::UtilityBill::consumptionUnit ( ) const
double openstudio::model::UtilityBill::consumptionUnitConversionFactor ( ) const
boost::optional<std::string> openstudio::model::UtilityBill::consumptionUnitDescription ( ) const
std::vector<std::string> openstudio::model::UtilityBill::consumptionUnitValues ( )
boost::optional<double> openstudio::model::UtilityBill::CVRMSE ( ) const

Coefficient of variation of the root mean square error, see ASHRAE 14-2002

FuelType openstudio::model::UtilityBill::fuelType ( ) const
static IddObjectType openstudio::model::UtilityBill::iddObjectType ( )
bool openstudio::model::UtilityBill::isConsumptionUnitConversionFactorDefaulted ( ) const
bool openstudio::model::UtilityBill::isMeterInstallLocationDefaulted ( ) const
bool openstudio::model::UtilityBill::isTimestepsInPeakDemandWindowDefaulted ( ) const
static boost::optional<double> openstudio::model::UtilityBill::maxCVRMSE ( const std::string &  calibrationGuideline)
static boost::optional<double> openstudio::model::UtilityBill::maxNMBE ( const std::string &  calibrationGuideline)
boost::optional<EndUseCategoryType> openstudio::model::UtilityBill::meterEndUseCategory ( ) const
InstallLocationType openstudio::model::UtilityBill::meterInstallLocation ( ) const
boost::optional<std::string> openstudio::model::UtilityBill::meterSpecificEndUse ( ) const
boost::optional<std::string> openstudio::model::UtilityBill::meterSpecificInstallLocation ( ) const
boost::optional<double> openstudio::model::UtilityBill::minutesInPeakDemandWindow ( ) const
boost::optional<double> openstudio::model::UtilityBill::NMBE ( ) const

Normalized mean bias error, see ASHRAE 14-2002

unsigned openstudio::model::UtilityBill::numberBillingPeriodsInCalculations ( ) const

Number of billing periods used to compute CVRMSE or NMBE.

boost::optional<OutputMeter> openstudio::model::UtilityBill::peakDemandMeter ( ) const

Gets the meter associated with peak demand for this UtilityBill, creates it if it does not exist.

boost::optional<std::string> openstudio::model::UtilityBill::peakDemandUnit ( ) const
boost::optional<double> openstudio::model::UtilityBill::peakDemandUnitConversionFactor ( ) const
boost::optional<std::string> openstudio::model::UtilityBill::peakDemandUnitDescription ( ) const
std::vector<std::string> openstudio::model::UtilityBill::peakDemandUnitValues ( )
void openstudio::model::UtilityBill::resetConsumptionUnitConversionFactor ( )
void openstudio::model::UtilityBill::resetMeterEndUseCategory ( )
void openstudio::model::UtilityBill::resetMeterInstallLocation ( )
void openstudio::model::UtilityBill::resetMeterSpecificEndUse ( )
void openstudio::model::UtilityBill::resetMeterSpecificInstallLocation ( )
void openstudio::model::UtilityBill::resetTimestepsInPeakDemandWindow ( )
bool openstudio::model::UtilityBill::setConsumptionUnit ( const std::string &  consumptionUnit)
bool openstudio::model::UtilityBill::setConsumptionUnitConversionFactor ( double  consumptionUnitConversionFactor)
bool openstudio::model::UtilityBill::setMeterEndUseCategory ( const EndUseCategoryType &  meterEndUseCategory)
bool openstudio::model::UtilityBill::setMeterInstallLocation ( const InstallLocationType &  meterInstallLocation)
bool openstudio::model::UtilityBill::setMeterSpecificEndUse ( const std::string &  meterSpecificEndUse)
bool openstudio::model::UtilityBill::setMeterSpecificInstallLocation ( const std::string &  meterSpecificInstallLocation)
bool openstudio::model::UtilityBill::setPeakDemandUnit ( const std::string &  peakDemandUnit)
bool openstudio::model::UtilityBill::setTimestepsInPeakDemandWindow ( unsigned  timestepsInPeakDemandWindow)
boost::optional<unsigned> openstudio::model::UtilityBill::timestepsInPeakDemandWindow ( ) const

Friends And Related Function Documentation

typedef boost::optional<UtilityBill> OptionalUtilityBill
typedef std::vector<UtilityBill> UtilityBillVector