WPSClient
WPSClient
Format
R6Class
object.
Value
Object of R6Class
with methods for interfacing an OGC
Web Processing Service.
Super classes
ows4R::OGCAbstractObject
-> ows4R::OWSClient
-> WPSClient
Methods
Inherited methods
ows4R::OGCAbstractObject$ERROR()
ows4R::OGCAbstractObject$INFO()
ows4R::OGCAbstractObject$WARN()
ows4R::OGCAbstractObject$encode()
ows4R::OGCAbstractObject$getClass()
ows4R::OGCAbstractObject$getClassName()
ows4R::OGCAbstractObject$getNamespaceDefinition()
ows4R::OGCAbstractObject$isFieldInheritedFrom()
ows4R::OGCAbstractObject$logger()
ows4R::OGCAbstractObject$print()
ows4R::OWSClient$getCASUrl()
ows4R::OWSClient$getConfig()
ows4R::OWSClient$getHeaders()
ows4R::OWSClient$getPwd()
ows4R::OWSClient$getToken()
ows4R::OWSClient$getUrl()
ows4R::OWSClient$getUser()
ows4R::OWSClient$getVersion()
Method new()
This method is used to instantiate a WPSClient with the url
of the
OGC service. Authentication is supported using basic auth (using user
/pwd
arguments),
bearer token (using token
argument), or custom (using headers
argument). By default, the logger
argument will be set to NULL
(no logger). This argument accepts two possible
values: INFO
: to print only ows4R logs, DEBUG
: to print more verbose logs
Method getProcesses()
Get the list of processes offered by the service capabilities. pretty
allows to control
the type output. If TRUE
, a data.frame
will be returned. When prettified output, it
is also possible to get a 'full' description of the process by setting full = TRUE
in which
case a the WPS client will request a process description (with more information about the process) for
each process listed in the capabilities.
Returns
a list
of WPSProcessDescription or a data.frame
Method describeProcess()
Get the description of a process, given its identifier
, returning an object of class WPSProcessDescription
Returns
an object of class WPSProcessDescription
Method execute()
Execute a process, given its identifier
Usage
WPSClient$execute(
identifier,
dataInputs = list(),
responseForm = NULL,
storeExecuteResponse = FALSE,
lineage = NULL,
status = NULL,
update = FALSE,
updateInterval = 1
)
Arguments
identifier
process identifier
dataInputs
a named list of data inputs, objects of class WPSLiteralData, WPSComplexData or WPSBoundingBoxData
responseForm
response form, object of class WPSResponseDocument
storeExecuteResponse
store execute response? object of class
logical
.FALSE
by defaultlineage
lineage, object of class
logical
status
status, object of class
logical
update
update, object of class
logical
. For asynchronous requestsupdateInterval
update interval, object of class
integer
. For asynchronous requests
Examples
# \dontrun{
#example based on a WPS endpoint responding at http://localhost:8080/geoserver/wps
wps <- WPSClient$new("http://localhost:8080/geoserver/wps", serviceVersion = "1.0.0")
#> Error in curl::curl_fetch_memory(url, handle = handle): Couldn't connect to server [localhost]: Failed to connect to localhost port 8080 after 0 ms: Couldn't connect to server
#get capabilities
caps <- wps$getCapabilities()
#> Error: object 'wps' not found
# }