use R6 class; remove data first and last elements --> simplify

[talweg.git] / pkg / R / Data.R

diff --git a/pkg/R/Data.R b/pkg/R/Data.R
index 4e16805..27aa082 100644 (file)
--- a/pkg/R/Data.R
+++ b/pkg/R/Data.R
@@ -16,74 +16,104 @@
 #'
 #' @export
 Data = R6Class("Data",
+       private = list(
+               .data = "list"
+       ),
        public = list(
-               data = "list",
                initialize = function(...)
-               {
-                       "Initialize empty Data object"
-#TODO: continue from here
-                       callSuper(...)
-               },
+                       initialize(self, private, ...)
+               ,
                getSize = function()
-               {
-                       "Number of series in the dataset"
-
-                       length(data)
-               },
+                       getSize(private)
+               ,
                getStdHorizon = function()
-               {
-                       "'Standard' horizon, from t+1 to midnight"
+                       getStdHorizon(private)
+               ,
+               append = function(new_time, new_centered_serie, new_level, new_exo, new_exo_hat)
+                       append(private, new_time, new_centered_serie, new_level, new_exo, new_exo_hat)
+               ,
+               getTime = function(index)
+                       getTime(self, private, index)
+               ,
+               getCenteredSerie = function(index)
+                       getCenteredSerie(self, private, index)
+               ,
+               getLevel = function(index)
+                       getLevel(self, private, index)
+               ,
+               getSerie = function(index)
+                       getSerie(self, private, index)
+               ,
+               getExo = function(index)
+                       getExo(self, private, index)
+               ,
+               getExoHat = function(index)
+                       getExoHat(self, private, index)
+       )
+)
 
-                       24 - as.POSIXlt( data[[1]]$time[1] )$hour + 1
-               },
-               append = function(new_time, new_serie, new_level, new_exo_hat, new_exo)
-               {
-                       "Acquire a new vector of lists (time, serie, level, exo_hat, exo)"
+##TODO: @param... @inheritParams...
 
-                       data[[length(data)+1]] <<- list("time"=new_time,"serie"=new_serie,"level"=new_level,
-                               "exo_hat"=new_exo_hat,"exo"=new_exo)
-               },
-               getTime = function(index)
-               {
-                       "Time values at specified index"
+#' Initialize empty Data object
+initialize = function(o, private, ...)
+{
+       private$.data <<- if (hasArg("data")) list(...)$data else list()
+       invisible(o)
+}
 
-                       index = dateIndexToInteger(index, .self)
-                       data[[index]]$time
-               },
-               getCenteredSerie = function(index)
-               {
-                       "Serie values (centered) at specified index"
+#' Number of series in the dataset
+getSize = function(private)
+       length(private$.data)
 
-                       index = dateIndexToInteger(index, .self)
-                       data[[index]]$serie
-               },
-               getLevel = function(index)
-               {
-                       "Level of the serie at specified index"
+#' 'Standard' horizon, from t+1 to midnight
+getStdHorizon = function(private)
+       24 - as.POSIXlt( private$.data[[1]]$time[1] )$hour + 1
 
-                       index = dateIndexToInteger(index, .self)
-                       data[[index]]$level
-               },
-               getSerie = function(index)
-               {
-                       "Serie values (centered+level) at specified index"
+#' Acquire a new vector of lists (time, centered_serie, level, exo, exo_hat)
+append = function(private, new_time, new_centered_serie, new_level, new_exo_hat, new_exo)
+{
+       private$.data[[length(private$.data)+1]] <<- list("time"=new_time,
+               "centered_serie"=new_centered_serie,"level"=new_level,"exo"=new_exo,"exo_hat"=new_exo_hat)
+}
 
-                       index = dateIndexToInteger(index, .self)
-                       data[[index]]$serie + data[[index]]$level
-               },
-               getExoHat = function(index)
-               {
-                       "Exogeous predictions at specified index"
+#' Time values at specified index
+getTime = function(o, private, index)
+{
+       index = dateIndexToInteger(index, o)
+       private$.data[[index]]$time
+}
 
-                       index = dateIndexToInteger(index, .self)
-                       data[[index]]$exo_hat
-               },
-               getExo = function(index)
-               {
-                       "Exogenous measures at specified index"
+#' Centered serie values at specified index
+getCenteredSerie = function(o, private, index)
+{
+       index = dateIndexToInteger(index, o)
+       private$.data[[index]]$serie
+}
 
-                       index = dateIndexToInteger(index, .self)
-                       data[[index]]$exo
-               }
-       )
-)
+#' Level of the serie at specified index
+getCenteredSerie = function(o, private, index)
+{
+       index = dateIndexToInteger(index, o)
+       private$.data[[index]]$level
+}
+
+#' Serie values (centered+level) at specified index
+getCenteredSerie = function(o, private, index)
+{
+       index = dateIndexToInteger(index, o)
+       private$.data[[index]]$serie + data[[index]]$level
+}
+
+#' Exogenous measures at specified index
+getCenteredSerie = function(o, private, index)
+{
+       index = dateIndexToInteger(index, o)
+       private$.data[[index]]$exo
+}
+
+#' Exogeous predictions at specified index
+getCenteredSerie = function(o, private, index)
+{
+       index = dateIndexToInteger(index, o)
+       private$.data[[index]]$exo_hat
+}