openstudio::CalibrationUtilityBill Class Reference

#include <CalibrationResult.hpp>

Public Member Functions
bool	addBillingPeriod (const CalibrationBillingPeriod &billingPeriod)
	Add a CalibrationBillingPeriod to this CalibrationUtilityBill.
Attribute	attribute () const
	Returns the attribute.
std::vector< CalibrationBillingPeriod >	billingPeriods () const
	Returns all CalibrationBillingPeriod associated with this CalibrationUtilityBill.
	CalibrationUtilityBill (const std::string &name, const FuelType &fuelType, const InstallLocationType &meterInstallLocation, boost::optional< std::string > meterSpecificInstallLocation, boost::optional< EndUseCategoryType > meterEndUseCategory, boost::optional< std::string > meterSpecificEndUse, const std::string &consumptionUnit, double consumptionUnitConversionFactor, boost::optional< std::string > peakDemandUnit, boost::optional< double > peakDemandUnitConversionFactor, boost::optional< unsigned > timestepsInPeakDemandWindow, boost::optional< double > minutesInPeakDemandWindow, boost::optional< unsigned > numberBillingPeriodsInCalculations, boost::optional< double > CVRMSE, boost::optional< double > NMBE)
	Create attribute wrapper with all required information.
std::string	consumptionUnit () const
double	consumptionUnitConversionFactor () const
boost::optional< double >	CVRMSE () const
FuelType	fuelType () const
boost::optional< EndUseCategoryType >	meterEndUseCategory () const
InstallLocationType	meterInstallLocation () const
boost::optional< std::string >	meterSpecificEndUse () const
boost::optional< std::string >	meterSpecificInstallLocation () const
boost::optional< double >	minutesInPeakDemandWindow () const
std::string	name () const
boost::optional< double >	NMBE () const
boost::optional< unsigned >	numberBillingPeriodsInCalculations () const
boost::optional< std::string >	peakDemandUnit () const
boost::optional< double >	peakDemandUnitConversionFactor () const
boost::optional< unsigned >	timestepsInPeakDemandWindow () const

Static Public Member Functions
static std::string	attributeName ()
	Returns the expected name for attributes of this type, 'CalibrationUtilityBill'.
static boost::optional< CalibrationUtilityBill >	fromAttribute (const Attribute &attribute)
	Creates a CalibrationUtilityBill wrapper around attribute if it is correctly formatted.

Detailed Description

CalibrationUtilityBill is wrapper around Attribute for storing information about model calibration.

Constructor & Destructor Documentation

CalibrationUtilityBill()

openstudio::CalibrationUtilityBill::CalibrationUtilityBill	(	const std::string &	name,
		const FuelType &	fuelType,
		const InstallLocationType &	meterInstallLocation,
		boost::optional< std::string >	meterSpecificInstallLocation,
		boost::optional< EndUseCategoryType >	meterEndUseCategory,
		boost::optional< std::string >	meterSpecificEndUse,
		const std::string &	consumptionUnit,
		double	consumptionUnitConversionFactor,
		boost::optional< std::string >	peakDemandUnit,
		boost::optional< double >	peakDemandUnitConversionFactor,
		boost::optional< unsigned >	timestepsInPeakDemandWindow,
		boost::optional< double >	minutesInPeakDemandWindow,
		boost::optional< unsigned >	numberBillingPeriodsInCalculations,
		boost::optional< double >	CVRMSE,
		boost::optional< double >	NMBE )

Create attribute wrapper with all required information.

Member Function Documentation

addBillingPeriod()

bool openstudio::CalibrationUtilityBill::addBillingPeriod

(

const CalibrationBillingPeriod &

billingPeriod

)

Add a CalibrationBillingPeriod to this CalibrationUtilityBill.

attribute()

Attribute openstudio::CalibrationUtilityBill::attribute

(

)

const

Returns the attribute.

attributeName()

static std::string openstudio::CalibrationUtilityBill::attributeName ( )

static

Returns the expected name for attributes of this type, 'CalibrationUtilityBill'.

billingPeriods()

std::vector< CalibrationBillingPeriod > openstudio::CalibrationUtilityBill::billingPeriods

(

)

const

Returns all CalibrationBillingPeriod associated with this CalibrationUtilityBill.

consumptionUnit()

std::string openstudio::CalibrationUtilityBill::consumptionUnit

(

)

const

consumptionUnitConversionFactor()

double openstudio::CalibrationUtilityBill::consumptionUnitConversionFactor

(

)

const

CVRMSE()

boost::optional< double > openstudio::CalibrationUtilityBill::CVRMSE

(

)

const

fromAttribute()

static boost::optional< CalibrationUtilityBill > openstudio::CalibrationUtilityBill::fromAttribute ( const Attribute & attribute )

static

Creates a CalibrationUtilityBill wrapper around attribute if it is correctly formatted.

fuelType()

FuelType openstudio::CalibrationUtilityBill::fuelType

(

)

const

meterEndUseCategory()

boost::optional< EndUseCategoryType > openstudio::CalibrationUtilityBill::meterEndUseCategory

(

)

const

meterInstallLocation()

InstallLocationType openstudio::CalibrationUtilityBill::meterInstallLocation

(

)

const

meterSpecificEndUse()

boost::optional< std::string > openstudio::CalibrationUtilityBill::meterSpecificEndUse

(

)

const

meterSpecificInstallLocation()

boost::optional< std::string > openstudio::CalibrationUtilityBill::meterSpecificInstallLocation

(

)

const

minutesInPeakDemandWindow()

boost::optional< double > openstudio::CalibrationUtilityBill::minutesInPeakDemandWindow

(

)

const

name()

std::string openstudio::CalibrationUtilityBill::name

(

)

const

NMBE()

boost::optional< double > openstudio::CalibrationUtilityBill::NMBE

(

)

const

numberBillingPeriodsInCalculations()

boost::optional< unsigned > openstudio::CalibrationUtilityBill::numberBillingPeriodsInCalculations

(

)

const

peakDemandUnit()

boost::optional< std::string > openstudio::CalibrationUtilityBill::peakDemandUnit

(

)

const

peakDemandUnitConversionFactor()

boost::optional< double > openstudio::CalibrationUtilityBill::peakDemandUnitConversionFactor

(

)

const

timestepsInPeakDemandWindow()

boost::optional< unsigned > openstudio::CalibrationUtilityBill::timestepsInPeakDemandWindow

(

)

const