AP&C API Reference
Public Member Functions | Static Public Member Functions | Properties | List of all members
Apac.Ecop.Reporting.WeeklyHistoryReport Class Reference

A report object that organizes the measurement data based on a week's timeframe. More...

Public Member Functions

 WeeklyHistoryReport (DateTime date, string fileLocation, decimal costPerkWh)
 
void UpdateDailyAverages (WeightedMeasurementAvgs avgs)
 
void UpdateDailyReport (uint day, WeightedMeasurementAvgs avgs)
 

Static Public Member Functions

static string GetWeeklyReportPath (string location, int year, int week)
 The weekly details for each measurement. These are hourly average values. More...
 
static string GetWeeklyReportFile (int year, int week)
 

Properties

int Year [get, set]
 Gets or sets the year the report applies to. More...
 
int Week [get, set]
 Gets or sets the week of the year the report applies to. More...
 
string FilePath [get, set]
 Returns the report path for the More...
 
int LastDay [get, set]
 Gets or sets the last day that was appended to the report. More...
 
decimal CostPerkWh [get, set]
 
DateTime FirstDay [get, set]
 
string FirstDayISO [get]
 
string FirstDayDisplay [get]
 
Dictionary< uint, ManagedElementElements [get, set]
 
List< ReportDataPointWeeklyUsageSummary [get]
 The weekly summary of power usage numbers showing the daily average for each measurement. More...
 
List< ReportDataPointWeeklyCostSummary [get]
 The weekly summary of cost for power measurements. More...
 
Dictionary< uint, List< ReportDataPoint > > DailyAverages [get, set]
 Gets or sets the daily averages for the weekly report. These are 'weekly details'. More...
 
Dictionary< uint, DailyHistoryReportDailyDetails [get, set]
 Gets or sets the daily details. More...
 

Detailed Description

A report object that organizes the measurement data based on a week's timeframe.

Member Function Documentation

◆ GetWeeklyReportPath()

static string Apac.Ecop.Reporting.WeeklyHistoryReport.GetWeeklyReportPath ( string  location,
int  year,
int  week 
)
inlinestatic

The weekly details for each measurement. These are hourly average values.

◆ UpdateDailyAverages()

void Apac.Ecop.Reporting.WeeklyHistoryReport.UpdateDailyAverages ( WeightedMeasurementAvgs  avgs)
inline

Parameters
avgsavgs is a set of WeightedMeasurementAvg across multiple elements.

Property Documentation

◆ DailyAverages

Dictionary<uint, List<ReportDataPoint> > Apac.Ecop.Reporting.WeeklyHistoryReport.DailyAverages
getset

Gets or sets the daily averages for the weekly report. These are 'weekly details'.

The daily averages.

◆ DailyDetails

Dictionary<uint, DailyHistoryReport> Apac.Ecop.Reporting.WeeklyHistoryReport.DailyDetails
getset

Gets or sets the daily details.

The daily details.

◆ FilePath

string Apac.Ecop.Reporting.WeeklyHistoryReport.FilePath
getset

Returns the report path for the

◆ LastDay

int Apac.Ecop.Reporting.WeeklyHistoryReport.LastDay
getset

Gets or sets the last day that was appended to the report.

The last day.

◆ Week

int Apac.Ecop.Reporting.WeeklyHistoryReport.Week
getset

Gets or sets the week of the year the report applies to.

The week.

◆ WeeklyCostSummary

List<ReportDataPoint> Apac.Ecop.Reporting.WeeklyHistoryReport.WeeklyCostSummary
get

The weekly summary of cost for power measurements.

◆ WeeklyUsageSummary

List<ReportDataPoint> Apac.Ecop.Reporting.WeeklyHistoryReport.WeeklyUsageSummary
get

The weekly summary of power usage numbers showing the daily average for each measurement.

◆ Year

int Apac.Ecop.Reporting.WeeklyHistoryReport.Year
getset

Gets or sets the year the report applies to.

The year.


The documentation for this class was generated from the following file: