Process {openeo}

Process object

Description

This object reflects a process offered by an openEO service in order to load and manipulate data collections. It will be created with the information of a received JSON object for a single process, after the arguments of the process have been translated into Argument() objects.

Value

Object of R6Class() with methods for storing meta data of back-end processes and user assigned data

Fields

parameters

• a named list of Argument objects

isUserDefined

logical - depending if the process is offered by the openEO service or if it was user defined

Methods

$new(id,parameters,description=character(), summary = character(), parameter_order=character(),returns)

$getId()

returns the id of a process which was defined on the back-end

$getParameters()

returns a named list of arguments

$getReturns()

returns the schema for the return type as list

$getFormals()

returns the function formals for this process - usually a named vector of the specified default values, but NA where no default value was specified

$setId(id)

sets the id of a process

$setSummary(summary)

sets the summary text

$setDescription(description)

sets the description text

$getParameter(name)

returns the Argument object with the provided name

$getProcessGraph()

returns the ProcessGraph to which this Process belongs

$setProcessGraph(process_graph)

sets the ProcessGraph to which this Process belongs

$validate()

validates the processes argument values

$serialize()

serializes the process - mainly used as primary serialization for a ProcessNode()

$getCharacteristics()

select all non functions of the private area, to be used when copying process information into a process node

Arguments

id

process id from the back-end

parameters

a list of Argument objects

description

the process description

summary

the summary of a process

returns

the returns part of the process definition or an already evaluated parameter

name

a parameter name

value

the value for a parameter or the description text