From 80cc9274670b929be30cd2b96cd6edd66969bfeb Mon Sep 17 00:00:00 2001 From: eblondel Date: Fri, 9 Jul 2021 17:28:22 +0200 Subject: [PATCH] #10 rdoc --- R/WPSDescribeProcess.R | 2 +- R/WPSExecuteResponse.R | 11 ++++------- R/WPSFormat.R | 2 +- R/WPSLiteralData.R | 5 ++++- R/WPSOutput.R | 7 +++++-- R/WPSProcess.R | 1 - R/WPSProcessDescription.R | 2 +- R/ows4R.R | 2 +- man/WPSDescribeProcess.Rd | 2 +- man/WPSExecuteResponse.Rd | 3 +++ man/WPSFormat.Rd | 2 +- man/WPSLiteralData.Rd | 5 ++++- man/WPSOutput.Rd | 7 +++++-- man/WPSProcessDescription.Rd | 2 +- man/ows4R.Rd | 2 +- 15 files changed, 33 insertions(+), 22 deletions(-) diff --git a/R/WPSDescribeProcess.R b/R/WPSDescribeProcess.R index 37a25be..3ba3b02 100644 --- a/R/WPSDescribeProcess.R +++ b/R/WPSDescribeProcess.R @@ -9,7 +9,7 @@ #' @section Methods: #' \describe{ #' \item{\code{new(capabilities, op, url, version, identifier, logger, ...)}}{ -#' This method is used to instantiate a WPSDescribeProcess object +#' This method is used to instantiate a \code{WPSDescribeProcess} object #' } #' } #' diff --git a/R/WPSExecuteResponse.R b/R/WPSExecuteResponse.R index 13bc254..93ea5dd 100644 --- a/R/WPSExecuteResponse.R +++ b/R/WPSExecuteResponse.R @@ -20,6 +20,9 @@ #' \item{\code{getProcessOutputs()}}{ #' Get the process output(s) #' } +#' \item{\code{decode()}}{ +#' Decodes WPS Execute response from XML +#' } #' } #' #' @@ -29,8 +32,7 @@ WPSExecuteResponse <- R6Class("WPSExecuteResponse", inherit = OGCAbstractObject, private = list( xmlElement = "ExecuteResponse", - xmlNamespace = c(wps = "http://www.opengis.net/wps"), - xmlObj = NULL + xmlNamespace = c(wps = "http://www.opengis.net/wps") ), public = list( process = NULL, @@ -64,11 +66,6 @@ WPSExecuteResponse <- R6Class("WPSExecuteResponse", self$processOutputs <- lapply(outputsXML, function(x){WPSOutput$new(xmlObj = x)}) names(self$processOutputs) <- NULL } - }, - - # - xml = function(){ - return(private$xmlObj) } ) ) \ No newline at end of file diff --git a/R/WPSFormat.R b/R/WPSFormat.R index 9e7bd23..a09cf62 100644 --- a/R/WPSFormat.R +++ b/R/WPSFormat.R @@ -24,7 +24,7 @@ #' Set if default format or not #' } #' \item{\code{isDefault()}}{ -#' Is default format? +#' Is default format #' } #' } #' diff --git a/R/WPSLiteralData.R b/R/WPSLiteralData.R index c817dff..fe7e3a6 100644 --- a/R/WPSLiteralData.R +++ b/R/WPSLiteralData.R @@ -9,7 +9,10 @@ #' @section Methods: #' \describe{ #' \item{\code{new(xmlObj, value)}}{ -#' This method is used to instantiate a WPSLiteralData object +#' This method is used to instantiate a \code{WPSLiteralData} object +#' } +#' \item{\code{decode()}}{ +#' Decodes WPS input from XML #' } #' } #' diff --git a/R/WPSOutput.R b/R/WPSOutput.R index b3f0903..de5bb18 100644 --- a/R/WPSOutput.R +++ b/R/WPSOutput.R @@ -8,8 +8,11 @@ #' #' @section Methods: #' \describe{ -#' \item{\code{new(identifier, data)}}{ -#' This method is used to instantiate a WPSOutput object +#' \item{\code{new(xmlObj, identifier, title, data)}}{ +#' This method is used to instantiate a \code{WPSOutput} object +#' } +#' \item{\code{decode()}}{ +#' Decodes WPS output from XML #' } #' } #' diff --git a/R/WPSProcess.R b/R/WPSProcess.R index 256553d..0d57743 100644 --- a/R/WPSProcess.R +++ b/R/WPSProcess.R @@ -130,7 +130,6 @@ WPSProcess <- R6Class("WPSProcess", } client = private$capabilities$getClient() - print(client$getHeaders()) processExecute <- WPSExecute$new(capabilities = private$capabilities, op = op, private$url, private$version, private$identifier, dataInputs = dataInputs, responseForm = responseForm, language = language, user = client$getUser(), pwd = client$getPwd(), token = client$getToken(), headers = client$getHeaders(), diff --git a/R/WPSProcessDescription.R b/R/WPSProcessDescription.R index 6f099a7..3169232 100644 --- a/R/WPSProcessDescription.R +++ b/R/WPSProcessDescription.R @@ -8,7 +8,7 @@ #' #' @section Methods: #' \describe{ -#' \item{\code{new(xmlObj, capabilities, version, logger)}}{ +#' \item{\code{new(xmlObj, version, logger)}}{ #' This method is used to instantiate a \code{WPSProcessDescription} object #' } #' \item{\code{getIdentifier()}}{ diff --git a/R/ows4R.R b/R/ows4R.R index 688ba4e..857fd78 100644 --- a/R/ows4R.R +++ b/R/ows4R.R @@ -16,7 +16,7 @@ #' Type: \tab Package\cr #' Version #' : \tab 0.2\cr -#' Date: \tab 2021-07-090\cr +#' Date: \tab 2021-07-09\cr #' License: \tab MIT\cr #' LazyLoad: \tab yes\cr #' } diff --git a/man/WPSDescribeProcess.Rd b/man/WPSDescribeProcess.Rd index c50892f..a7417b4 100644 --- a/man/WPSDescribeProcess.Rd +++ b/man/WPSDescribeProcess.Rd @@ -20,7 +20,7 @@ Abstract class used by \pkg{ows4R} to trigger a WPS DescribeProcess request \describe{ \item{\code{new(capabilities, op, url, version, identifier, logger, ...)}}{ - This method is used to instantiate a WPSDescribeProcess object + This method is used to instantiate a \code{WPSDescribeProcess} object } } } diff --git a/man/WPSExecuteResponse.Rd b/man/WPSExecuteResponse.Rd index 442631a..1bc77a5 100644 --- a/man/WPSExecuteResponse.Rd +++ b/man/WPSExecuteResponse.Rd @@ -28,6 +28,9 @@ WPSExecuteResponse \item{\code{getProcessOutputs()}}{ Get the process output(s) } + \item{\code{decode()}}{ + Decodes WPS Execute response from XML + } } } diff --git a/man/WPSFormat.Rd b/man/WPSFormat.Rd index cd77c2f..f7658f3 100644 --- a/man/WPSFormat.Rd +++ b/man/WPSFormat.Rd @@ -35,7 +35,7 @@ Class used internally by \pkg{ows4R} Set if default format or not } \item{\code{isDefault()}}{ - Is default format? + Is default format } } } diff --git a/man/WPSLiteralData.Rd b/man/WPSLiteralData.Rd index 6929692..7ed39d2 100644 --- a/man/WPSLiteralData.Rd +++ b/man/WPSLiteralData.Rd @@ -17,7 +17,10 @@ WPSLiteralData \describe{ \item{\code{new(xmlObj, value)}}{ - This method is used to instantiate a WPSLiteralData object + This method is used to instantiate a \code{WPSLiteralData} object + } + \item{\code{decode()}}{ + Decodes WPS input from XML } } } diff --git a/man/WPSOutput.Rd b/man/WPSOutput.Rd index 126d692..10d9746 100644 --- a/man/WPSOutput.Rd +++ b/man/WPSOutput.Rd @@ -16,8 +16,11 @@ WPSOutput \section{Methods}{ \describe{ - \item{\code{new(identifier, data)}}{ - This method is used to instantiate a WPSOutput object + \item{\code{new(xmlObj, identifier, title, data)}}{ + This method is used to instantiate a \code{WPSOutput} object + } + \item{\code{decode()}}{ + Decodes WPS output from XML } } } diff --git a/man/WPSProcessDescription.Rd b/man/WPSProcessDescription.Rd index a4b473d..ed49843 100644 --- a/man/WPSProcessDescription.Rd +++ b/man/WPSProcessDescription.Rd @@ -19,7 +19,7 @@ Class used internally by \pkg{ows4R} \section{Methods}{ \describe{ - \item{\code{new(xmlObj, capabilities, version, logger)}}{ + \item{\code{new(xmlObj, version, logger)}}{ This method is used to instantiate a \code{WPSProcessDescription} object } \item{\code{getIdentifier()}}{ diff --git a/man/ows4R.Rd b/man/ows4R.Rd index 22f0eb2..5f7c5e0 100644 --- a/man/ows4R.Rd +++ b/man/ows4R.Rd @@ -17,7 +17,7 @@ additional OGC service standards such as Web Coverage Service (WCS), Web Coverag Type: \tab Package\cr Version : \tab 0.2\cr - Date: \tab 2021-07-090\cr + Date: \tab 2021-07-09\cr License: \tab MIT\cr LazyLoad: \tab yes\cr }