API Docs for: 1.0.2
Show:

GIScene.Process Class

Defined in: GIScene\Process.js:1
Module: GIScene

Base class for processes

Constructor

GIScene.Process

(
  • config
)

Defined in GIScene\Process.js:1

Parameters:

  • config Object

Methods

getOutput

(
  • outputIdentifier
)
Mixed

Defined in GIScene\Process.js:71

Method to get a specific output result after process execution

Parameters:

  • outputIdentifier Object

Returns:

Mixed:

an output value of the process

getOutputs

() Object

Defined in GIScene\Process.js:82

Method to get all process outputs after process execution

Returns:

Object:

An object containing all process outputs

getParamDescriptionById

(
  • identifier
)
Object

Defined in GIScene\Process.js:92

Get a param desription (input or ouput) by its identifier

Parameters:

  • identifier String

Returns:

Object:

parameterDescription

setInput

(
  • inputIdentifier
  • value
)

Defined in GIScene\Process.js:48

Method to set a specific input parameter

Parameters:

  • inputIdentifier String

    the inputIdentifier defined in the process description

  • value Mixed

    the value of the input to be set

setInputs

(
  • inputParams
)

Defined in GIScene\Process.js:59

Method to set several inputs at a time

Parameters:

  • inputParams Object

    An object with key:value pairs of input parameters, where key corresponds to the inputIdentifiers defined in the process description