openstudio::CalibrationBillingPeriod Class Reference

#include <CalibrationResult.hpp>

Public Member Functions
Attribute	attribute () const
	Returns the attribute.
	CalibrationBillingPeriod (const Date &startDate, unsigned numberOfDays, const std::string &consumptionUnit, boost::optional< std::string > peakDemandUnit, boost::optional< double > consumption, boost::optional< double > peakDemand, boost::optional< double > totalCost, boost::optional< double > modelConsumption, boost::optional< double > modelPeakDemand, boost::optional< double > modelTotalCost)
	Create attribute wrapper with all required information.
boost::optional< double >	consumption () const
	Returns the consumption in billing units.
std::string	consumptionUnit () const
Date	endDate () const
	The date that the billing period ends.
boost::optional< double >	modelConsumption () const
	Returns the sum of modelConsumptionValues if it is not empty.
boost::optional< double >	modelPeakDemand () const
	Returns the maximum peak over the billing period if available.
boost::optional< double >	modelTotalCost () const
	Returns total energy cost over the billing period if available.
unsigned	numberOfDays () const
	The duration of the billing period in days.
boost::optional< double >	peakDemand () const
	Returns the peak demand in billing units.
boost::optional< std::string >	peakDemandUnit () const
Date	startDate () const
	The date that the billing period starts.
boost::optional< double >	totalCost () const
	Returns the total cost of the bill in dollars.

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

Detailed Description

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

Constructor & Destructor Documentation

CalibrationBillingPeriod()

openstudio::CalibrationBillingPeriod::CalibrationBillingPeriod	(	const Date &	startDate,
		unsigned	numberOfDays,
		const std::string &	consumptionUnit,
		boost::optional< std::string >	peakDemandUnit,
		boost::optional< double >	consumption,
		boost::optional< double >	peakDemand,
		boost::optional< double >	totalCost,
		boost::optional< double >	modelConsumption,
		boost::optional< double >	modelPeakDemand,
		boost::optional< double >	modelTotalCost )

Create attribute wrapper with all required information.

Member Function Documentation

attribute()

Attribute openstudio::CalibrationBillingPeriod::attribute

(

)

const

Returns the attribute.

attributeName()

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

static

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

consumption()

boost::optional< double > openstudio::CalibrationBillingPeriod::consumption

(

)

const

Returns the consumption in billing units.

consumptionUnit()

std::string openstudio::CalibrationBillingPeriod::consumptionUnit

(

)

const

endDate()

Date openstudio::CalibrationBillingPeriod::endDate

(

)

const

The date that the billing period ends.

fromAttribute()

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

static

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

modelConsumption()

boost::optional< double > openstudio::CalibrationBillingPeriod::modelConsumption

(

)

const

Returns the sum of modelConsumptionValues if it is not empty.

modelPeakDemand()

boost::optional< double > openstudio::CalibrationBillingPeriod::modelPeakDemand

(

)

const

Returns the maximum peak over the billing period if available.

modelTotalCost()

boost::optional< double > openstudio::CalibrationBillingPeriod::modelTotalCost

(

)

const

Returns total energy cost over the billing period if available.

numberOfDays()

unsigned openstudio::CalibrationBillingPeriod::numberOfDays

(

)

const

The duration of the billing period in days.

peakDemand()

boost::optional< double > openstudio::CalibrationBillingPeriod::peakDemand

(

)

const

Returns the peak demand in billing units.

peakDemandUnit()

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

(

)

const

startDate()

Date openstudio::CalibrationBillingPeriod::startDate

(

)

const

The date that the billing period starts.

totalCost()

boost::optional< double > openstudio::CalibrationBillingPeriod::totalCost

(

)

const

Returns the total cost of the bill in dollars.