EPANET-RTX  1.1
real-time extension for the EPANET toolkit
Public Types | Public Member Functions | List of all members
RTX::ModelPerformance Class Reference

Public Types

enum  StatsType { ModelPerformanceStatsRMSE = 0, ModelPerformanceStatsMeanAbsoluteError = 1, ModelPerformanceStatsCorrelationCoefficient = 2 }
 
enum  AggregationType { ModelPerformanceAggregationSum = 0, ModelPerformanceAggregationMean = 1 }
 
enum  LocationType { ModelPerformanceLocationFlow = 0, ModelPerformanceLocationPressure = 1, ModelPerformanceLocationHead = 2, ModelPerformanceLocationTank = 3 }
 
typedef boost::shared_ptr
< ModelPerformance
sharedPointer
 

Public Member Functions

 ModelPerformance (Model::sharedPointer model, StatsType statsType=ModelPerformanceStatsRMSE, AggregationType aggregationType=ModelPerformanceAggregationMean, LocationType locationType=ModelPerformanceLocationTank)
 
Model::sharedPointer model ()
 
TimeSeries::sharedPointer performance ()
 
std::vector< std::pair
< Element::sharedPointer,
TimeSeries::sharedPointer > > 
components ()
 
StatsType statsType ()
 
void setStatsType (StatsType type)
 
AggregationType aggregationType ()
 
void setAggregationType (AggregationType type)
 
LocationType locationType ()
 
void setLocationType (LocationType type)
 
Clock::sharedPointer samplingWindow ()
 
void setSamplingWindow (Clock::sharedPointer clock)
 
Clock::sharedPointer errorClock ()
 
void setErrorClock (Clock::sharedPointer clock)
 
Clock::sharedPointer aggregationClock ()
 
void setAggregationClock (Clock::sharedPointer clock)
 
void buildPerformanceCalculatorWithElements (std::vector< Element::sharedPointer > elements)
 

Member Function Documentation

Clock::sharedPointer ModelPerformance::aggregationClock ( )

clock for aggregating all the error time series

void ModelPerformance::buildPerformanceCalculatorWithElements ( std::vector< Element::sharedPointer >  elements)

rebuild calculation time series workflow with arbitrary elements

std::vector< std::pair< Element::sharedPointer, TimeSeries::sharedPointer > > ModelPerformance::components ( )

constituent error time series. treat this as read-only

Clock::sharedPointer ModelPerformance::errorClock ( )

clock for each differencing or correlation time series (error)

TimeSeries::sharedPointer ModelPerformance::performance ( )

read-only timeseries that represents model performance with settings specified

Clock::sharedPointer ModelPerformance::samplingWindow ( )

clock to be used as sampling window by each error time series


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