R/OO_demand.R

In cvmartin/eflows: Data-driven energy transition

#' R6 class for the e_demand
#' 
#' @docType class
#' @export
#' @format An \code{\link{R6Class}} generator object
#' @keywords data
#' @field serveraddress Stores address of your lightning server.
#' @field sessionid Stores id of your current session on the server.
#' @field url Stores url of the last visualization created by this object.
#' @field autoopen Checks if the server is automatically opening the visualizations.
#' @field notebook Checks if the server is in the jupyter notebook mode.
#' @section Methods:
#' \describe{
#'   \item{Documentation}{For full documentation of each method go to https://github.com/lightning-viz/lightining-r/}
#'   \item{\code{new(serveraddress)}}{This method is used to create object of this class with \code{serveraddress} as address of the server object is connecting to.}
#'   \item{\code{sethost(serveraddress)}}{This method changes server that you are contacting with to \code{serveraddress}.}
#'   \item{\code{createsession(sessionname = "")}}{This method creates new session on the server with optionally given name in \code{sessionname}.}
#'   \item{\code{usesession(sessionid)}}{This method changes currently used session on the server to the one with id given in \code{sessionid} parameter.}
#' }
e_demand <- R6Class("e_demand",
                    public = list(
                      input = list(fixed = NULL,
                                   flex = NULL),
                      output = NULL,
                      initialize = function(fixed = c(),
                                            flex = list()) {
                        tolist <- listify(flex)
                        assert_that(all_flex_mtx(tolist))
                        names(tolist) <- lapply(tolist, function(x){x$name})
                        self$input$fixed <- fixed
                        self$input$flex <- tolist
                      }
                      
                    )
)


#' Class to generate a flexibilty matrix
#' 
#' @docType class
#' @export
#' @format An \code{\link{R6Class}} generator object
#' @keywords data
#' @section Methods:
#' \describe{
#'   \item{\code{example_method(parameter_1 = 3)}}{This method uses \code{parameter_1} to ...}
#' }
flex_mtx <- R6Class("flex_mtx",
                    public = list(
                      name = NULL,
                      data = NULL,
                      steps = NULL,
                      cap = NULL,
                      initialize = function(data = matrix(),
                                            steps = c(),
                                            name = NULL, 
                                            cap = NULL) {
                        assert_that(ncol(data) == length(steps))
                        assert_that(all(steps >= 1))
                        assert_that(length(unique(steps)) == length(steps))
                        assert_that(!is.unsorted(steps))
                        
                        self$name <- name
                        self$data <- data
                        self$steps <- steps
                        self$cap <- cap
                      }
                    )
)