Argument: Argument class

ArgumentR Documentation

Argument class

Description

This class inherits all fields and functions from Parameter() adds the functionality to manage a value. This includes getter/setter, validation and serialization. Since this is the parent class for the type specific argument classes, the inheriting classes implement their own version of the private functions ⁠$typeCheck()⁠ and ⁠$typeSerialization()⁠.

Value

Object of R6Class() representing an argument.

Methods

⁠$setValue(value)⁠

Assigns a value to this argument

⁠$getValue()⁠

Returns the value of this argument

⁠$serialize()⁠

returns a list representation of a openEO argument

⁠$validate()⁠

return TRUE if the parameter is validated positively by the type check

⁠$isEmpty()⁠

returns TRUE if the value is set

⁠$getProcess()⁠

returns the process this parameter belongs to

⁠$setProcess(p)⁠

sets the owning process for this parameter

Arguments

value

The value for this argument.

p

An object of class 'Process' or inheriting like 'ProcessNode'


Open-EO/openeo-r-client documentation built on Feb. 21, 2024, 12:20 p.m.