 |
OpenStudioCore:model |
|
OpenStudioCore:model |
#include "UtilityBill.hpp"
Public Member Functions | |
| Date | startDate () const |
| Date | endDate () const |
| unsigned | numberOfDays () const |
| boost::optional< double > | consumption () const |
| boost::optional< double > | peakDemand () const |
| boost::optional< double > | totalCost () const |
| bool | setStartDate (const Date &startDate) |
| bool | setEndDate (const Date &endDate) |
| bool | setNumberOfDays (unsigned numberOfDays) |
| bool | setConsumption (double consumption) |
| void | resetConsumption () |
| bool | setPeakDemand (double peakDemand) |
| void | resetPeakDemand () |
| bool | setTotalCost (double totalCost) |
| void | resetTotalCost () |
| bool | withinRunPeriod () const |
| bool | withinPeriodicRunPeriod () const |
| bool | overlapsRunPeriod () const |
| Vector | modelConsumptionValues () const |
| boost::optional< double > | modelConsumption () const |
| boost::optional< double > | modelPeakDemand () const |
| boost::optional< double > | modelTotalCost () const |
Related Functions | |
| typedef std::vector < BillingPeriod > | BillingPeriodVector |
BillingPeriod is a ModelExtensibleGroup that represents a single billing period in the UtilityBill ModelObject.
| boost::optional<double> openstudio::model::BillingPeriod::consumption | ( | ) | const |
Returns the consumption in billing units.
| Date openstudio::model::BillingPeriod::endDate | ( | ) | const |
The date that the billing period ends.
| boost::optional<double> openstudio::model::BillingPeriod::modelConsumption | ( | ) | const |
Returns the sum of modelConsumptionValues if it is not empty.
| Vector openstudio::model::BillingPeriod::modelConsumptionValues | ( | ) | const |
Returns the consumption for each day in billing period from simulation in model units.
| boost::optional<double> openstudio::model::BillingPeriod::modelPeakDemand | ( | ) | const |
Returns the maximum peak over the billing period if available.
| boost::optional<double> openstudio::model::BillingPeriod::modelTotalCost | ( | ) | const |
Returns total energy cost over the billing period if available.
| unsigned openstudio::model::BillingPeriod::numberOfDays | ( | ) | const |
The duration of the billing period in days.
| bool openstudio::model::BillingPeriod::overlapsRunPeriod | ( | ) | const |
Returns true if this billing period is partially within the model's run period.
| boost::optional<double> openstudio::model::BillingPeriod::peakDemand | ( | ) | const |
Returns the peak demand in billing units.
| void openstudio::model::BillingPeriod::resetConsumption | ( | ) |
| void openstudio::model::BillingPeriod::resetPeakDemand | ( | ) |
| void openstudio::model::BillingPeriod::resetTotalCost | ( | ) |
| bool openstudio::model::BillingPeriod::setConsumption | ( | double | consumption | ) |
Sets the consumption in billing units.
| bool openstudio::model::BillingPeriod::setEndDate | ( | const Date & | endDate | ) |
Sets the end date.
If endDate is after startDate then startDate is retained. If endDate is before startDate then numberOfDays is retained.
| bool openstudio::model::BillingPeriod::setNumberOfDays | ( | unsigned | numberOfDays | ) |
Sets the number of days in billing period, startDate is always retained.
| bool openstudio::model::BillingPeriod::setPeakDemand | ( | double | peakDemand | ) |
Sets the peak demand in billing units.
| bool openstudio::model::BillingPeriod::setStartDate | ( | const Date & | startDate | ) |
Sets the start date.
If startDate is before endDate then endDate is retained. If startDate is after endDate then numberOfDays is retained.
| bool openstudio::model::BillingPeriod::setTotalCost | ( | double | totalCost | ) |
Sets the total cost of the bill in dollars.
| Date openstudio::model::BillingPeriod::startDate | ( | ) | const |
The date that the billing period starts.
| boost::optional<double> openstudio::model::BillingPeriod::totalCost | ( | ) | const |
Returns the total cost of the bill in dollars.
| bool openstudio::model::BillingPeriod::withinPeriodicRunPeriod | ( | ) | const |
Returns true if this billing period is within the model's run period assuming periodic boundary conditions.
| bool openstudio::model::BillingPeriod::withinRunPeriod | ( | ) | const |
Returns true if this billing period is strictly within the model's run period.
|
related |