R/MicroclimRequest.R

In trenchproject/microclimRapi: Microclim.org R API Toolkit

#' Reference Class for MicroclimRequest for Microclim.org Interaction
#'
#' @description Reference class encapsulating Microclim Request
#' @details MicroclimRequest
#' @author Aji John
#' @keywords API Microclim
#' @importFrom jsonlite toJSON
#' @export
#' @examples
#'
#'\dontrun{
#' mr <- MicroclimRequest$new(
#'                            latS = "39.40012200014591",
#'                            latN="39.92132255884663",
#'                            lonW="-106.47674560546875",
#'                            lonE="-105.92193603515625",
#'                            variable="ALBEDO",
#'                            shadelevel=0,
#'                            hod=0,
#'                            interval=0,
#'                            aggregation=0,
#'                            stdate="19810101",
#'                            eddate="19810128",
#'                            file="csv")
#' }
#'
MicroclimRequest <- setRefClass("MicroclimRequest",
                            fields = list(
                              latS = "character",
                              latN="character",
                              lonW="character",
                              lonE="character",
                              variable="character",
                              shadelevel="numeric",
                              hod="numeric",
                              interval="numeric",
                              aggregation="numeric",
                              stdate="character",
                              eddate="character",
                              file="character"
                            ),
                            methods = list(
                              json = function() {
                                # converts the instance fields to JSON
                                mcRqst= jsonlite::toJSON(data.frame(latS=mr$latS,
                                                          latN=mr$latN,
                                                          lonW=mr$lonW,
                                                          lonE=mr$lonE,
                                                          variable=mr$variable,
                                                          shadelevel=mr$shadelevel,
                                                          hod=mr$hod,
                                                          interval=mr$interval,
                                                          aggregation=mr$aggregation,
                                                          stdate=mr$stdate,
                                                          eddate=mr$eddate,
                                                          file=mr$file))
                                return(mcRqst)

                              },
                            mreq_list=function(){

                              mrqlist= list(latS=latS,
                                                  latN=latN,
                                                  lonW=lonW,
                                                  lonE=lonE,
                                                  variable=variable,
                                                  shadelevel=shadelevel,
                                                  hod=hod,
                                                  interval=interval,
                                                  aggregation=aggregation,
                                                  stdate=stdate,
                                                  eddate=eddate,
                                                  file=file)
                              return(mrqlist)

                            }

                            )
)