#include <CalibrationResult.hpp>
Public Member Functions | |
Attribute | attribute () const |
Returns the attribute. More... | |
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. More... | |
boost::optional< double > | consumption () const |
Returns the consumption in billing units. More... | |
std::string | consumptionUnit () const |
Date | endDate () const |
The date that the billing period ends. More... | |
boost::optional< double > | modelConsumption () const |
Returns the sum of modelConsumptionValues if it is not empty. More... | |
boost::optional< double > | modelPeakDemand () const |
Returns the maximum peak over the billing period if available. More... | |
boost::optional< double > | modelTotalCost () const |
Returns total energy cost over the billing period if available. More... | |
unsigned | numberOfDays () const |
The duration of the billing period in days. More... | |
boost::optional< double > | peakDemand () const |
Returns the peak demand in billing units. More... | |
boost::optional< std::string > | peakDemandUnit () const |
Date | startDate () const |
The date that the billing period starts. More... | |
boost::optional< double > | totalCost () const |
Returns the total cost of the bill in dollars. More... | |
Static Public Member Functions | |
static std::string | attributeName () |
Returns the expected name for attributes of this type, 'CalibrationBillingPeriod'. More... | |
static boost::optional < CalibrationBillingPeriod > | fromAttribute (const Attribute &attribute) |
Creates a CalibrationBillingPeriod wrapper around attribute if it is correctly formatted. More... | |
CalibrationBillingPeriod is wrapper around Attribute for storing information about model calibration.
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.
Attribute openstudio::CalibrationBillingPeriod::attribute | ( | ) | const |
Returns the attribute.
|
static |
Returns the expected name for attributes of this type, 'CalibrationBillingPeriod'.
boost::optional<double> openstudio::CalibrationBillingPeriod::consumption | ( | ) | const |
Returns the consumption in billing units.
std::string openstudio::CalibrationBillingPeriod::consumptionUnit | ( | ) | const |
Date openstudio::CalibrationBillingPeriod::endDate | ( | ) | const |
The date that the billing period ends.
|
static |
Creates a CalibrationBillingPeriod wrapper around attribute if it is correctly formatted.
boost::optional<double> openstudio::CalibrationBillingPeriod::modelConsumption | ( | ) | const |
Returns the sum of modelConsumptionValues if it is not empty.
boost::optional<double> openstudio::CalibrationBillingPeriod::modelPeakDemand | ( | ) | const |
Returns the maximum peak over the billing period if available.
boost::optional<double> openstudio::CalibrationBillingPeriod::modelTotalCost | ( | ) | const |
Returns total energy cost over the billing period if available.
unsigned openstudio::CalibrationBillingPeriod::numberOfDays | ( | ) | const |
The duration of the billing period in days.
boost::optional<double> openstudio::CalibrationBillingPeriod::peakDemand | ( | ) | const |
Returns the peak demand in billing units.
boost::optional<std::string> openstudio::CalibrationBillingPeriod::peakDemandUnit | ( | ) | const |
Date openstudio::CalibrationBillingPeriod::startDate | ( | ) | const |
The date that the billing period starts.
boost::optional<double> openstudio::CalibrationBillingPeriod::totalCost | ( | ) | const |
Returns the total cost of the bill in dollars.