openstudio::CalibrationUtilityBill Class Reference

#include <CalibrationResult.hpp>

Public Member Functions
bool	addBillingPeriod (const CalibrationBillingPeriod &billingPeriod)
	Add a CalibrationBillingPeriod to this CalibrationUtilityBill. More...
Attribute	attribute () const
	Returns the attribute. More...
std::vector < CalibrationBillingPeriod >	billingPeriods () const
	Returns all CalibrationBillingPeriod associated with this CalibrationUtilityBill. More...
	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. More...
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'. More...
static boost::optional < CalibrationUtilityBill >	fromAttribute (const Attribute &attribute)
	Creates a CalibrationUtilityBill wrapper around attribute if it is correctly formatted. More...

Detailed Description

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

Constructor & Destructor Documentation

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

bool openstudio::CalibrationUtilityBill::addBillingPeriod

(

const CalibrationBillingPeriod &

billingPeriod

)

Add a CalibrationBillingPeriod to this CalibrationUtilityBill.

Attribute openstudio::CalibrationUtilityBill::attribute

(

)

const

Returns the attribute.

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

static

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

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

(

)

const

Returns all CalibrationBillingPeriod associated with this CalibrationUtilityBill.

std::string openstudio::CalibrationUtilityBill::consumptionUnit

(

)

const

double openstudio::CalibrationUtilityBill::consumptionUnitConversionFactor

(

)

const

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

(

)

const

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

static

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

FuelType openstudio::CalibrationUtilityBill::fuelType

(

)

const

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

(

)

const

InstallLocationType openstudio::CalibrationUtilityBill::meterInstallLocation

(

)

const

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

(

)

const

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

(

)

const

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

(

)

const

std::string openstudio::CalibrationUtilityBill::name

(

)

const

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

(

)

const

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

(

)

const

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

(

)

const

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

(

)

const

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

(

)

const