X-Git-Url: https://git.auder.net/?a=blobdiff_plain;f=pkg%2FR%2FData.R;h=d970f7b825ad6af4e5e57b16f84a1cb2024ce5b3;hb=25b75559e2d9bf84e2de35b851d93fefdae36e17;hp=d4609f20082f0939f3cdd5128381240a6c5de683;hpb=1e20780ee1505fac6c7ed68d340892c497524561;p=talweg.git

diff --git a/pkg/R/Data.R b/pkg/R/Data.R
index d4609f2..d970f7b 100644
--- a/pkg/R/Data.R
+++ b/pkg/R/Data.R
@@ -1,97 +1,131 @@
-#' @title Data
+#' Data
 #'
-#' @description Data encapsulation
+#' Data encapsulation
 #'
 #' @field data List of
 #' \itemize{
 #'   \item time: vector of times
 #'   \item serie: centered series
 #'   \item level: corresponding levels
+#'   \item exo: exogenous variables
 #'   \item exo_hat: predicted exogenous variables
-#'   \item exo_Dm1: List of measured exogenous variables at day minus 1
 #' }
 #'
-#' @exportClass Data
-#' @export Data
-Data = setRefClass(
-	Class = "Data",
-
-	fields = list(
-		data = "list"
+#' @docType class
+#' @importFrom R6 R6Class
+#'
+#' @export
+Data = R6::R6Class("Data",
+	private = list(
+		.data = list()
 	),
-
-	methods = list(
-		initialize = function(...)
-		{
-			"Initialize empty Data object"
-
-			callSuper(...)
-		},
+	public = list(
 		getSize = function()
-		{
-			"Number of series in the dataset"
-
-			length(data)
-		},
+			getSizeData(private)
+		,
 		getStdHorizon = function()
-		{
-			"'Standard' horizon, from t+1 to midnight"
+			getStdHorizonData(private)
+		,
+		append = function(new_time, new_centered_serie, new_level, new_exo, new_exo_hat)
+			appendData(private, new_time, new_centered_serie, new_level, new_exo, new_exo_hat)
+		,
+		getTime = function(index)
+			getTimeData(self, private, index)
+		,
+		getCenteredSerie = function(index)
+			getCenteredSerieData(self, private, index)
+		,
+		getLevel = function(index)
+			getLevelData(self, private, index)
+		,
+		getSerie = function(index)
+			getSerieData(self, private, index)
+		,
+		getExo = function(index)
+			getExoData(self, private, index)
+		,
+		getExoHat = function(index)
+			getExoHatData(self, private, index)
+	)
+)
 
-			L1 = length(data[[1]]$serie)
-			L2 = length(data[[2]]$serie)
-			if (L1 < L2)
-				L2 - L1
-			else
-				L1
-		},
-		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)"
+#' Number of series in the dataset
+#'
+#' @param private List of private members in current object
+getSizeData = function(private)
+	length(private$.data)
 
-			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"
+#' 'Standard' horizon, from t+1 to midnight
+#'
+#' @inheritParams getSizeData
+getStdHorizonData = function(private)
+	24 - as.POSIXlt( private$.data[[1]]$time[1] )$hour + 1
 
-			index = dateIndexToInteger(index, .self)
-			data[[index]]$time
-		},
-		getCenteredSerie = function(index)
-		{
-			"Serie values (centered) at specified index"
+#' Acquire a new vector of lists (time, centered_serie, level, exo, exo_hat)
+#'
+#' @inheritParams getSizeData
+#' @param new_time Time
+#' @param new_centered_serie Centered serie
+#' @param new_level Level
+#' @param new_exo Exogneous variables
+#' @param new_exo_hat Predicted exogenous variables
+appendData = function(private, new_time, new_centered_serie, new_level, new_exo, new_exo_hat)
+{
+	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
-		},
-		getLevel = function(index)
-		{
-			"Level of the serie at specified index"
+#' Time values at specified index
+#'
+#' @inheritParams getSizeData
+#' @param index Return value at this index
+getTimeData = function(o, private, index)
+{
+	index = dateIndexToInteger(index, o)
+	private$.data[[index]]$time
+}
 
-			index = dateIndexToInteger(index, .self)
-			data[[index]]$level
-		},
-		getSerie = function(index)
-		{
-			"Serie values (centered+level) at specified index"
+#' Centered serie values at specified index
+#'
+#' @inheritParams getTimeData
+getCenteredSerieData = function(o, private, index)
+{
+	index = dateIndexToInteger(index, o)
+	private$.data[[index]]$centered_serie
+}
 
-			index = dateIndexToInteger(index, .self)
-			data[[index]]$serie + data[[index]]$level
-		},
-		getExoHat = function(index)
-		{
-			"Exogeous predictions at specified index"
+#' Level of the serie at specified index
+#'
+#' @inheritParams getTimeData
+getLevelData = function(o, private, index)
+{
+	index = dateIndexToInteger(index, o)
+	private$.data[[index]]$level
+}
 
-			index = dateIndexToInteger(index, .self)
-			data[[index]]$exo_hat
-		},
-		getExo = function(index)
-		{
-			"Exogenous measures at specified index"
+#' Serie values (centered+level) at specified index
+#'
+#' @inheritParams getTimeData
+getSerieData = function(o, private, index)
+{
+	index = dateIndexToInteger(index, o)
+	private$.data[[index]]$centered_serie + data[[index]]$level
+}
 
-			index = dateIndexToInteger(index, .self)
-			data[[index]]$exo
-		}
-	)
-)
+#' Exogenous measures at specified index
+#'
+#' @inheritParams getTimeData
+getExoData = function(o, private, index)
+{
+	index = dateIndexToInteger(index, o)
+	private$.data[[index]]$exo
+}
+
+#' Exogeous predictions at specified index
+#'
+#' @inheritParams getTimeData
+getExoHatData = function(o, private, index)
+{
+	index = dateIndexToInteger(index, o)
+	private$.data[[index]]$exo_hat
+}