User Tools

Site Tools


doc:pipeline

Pipeline

Documentation | Other Specifications | Pipeline

Pipeline is a simplified command interpreter allowing execution of a sequence of operations like:

Base.Say "Start"
Layer.Open Result=$src Name=source Path="c:\Samples\Interpolation\temperatures.shp"
Layer.CreateGrid Result=$dst Name=grid CS=$src Extent=$src Width=1000 Height=1000
Interpolation.Kriging Source=$src Destination=$dst Field=TEMP
Layer.Close Layer=$src
Ramp Layer=$dst
GIS.FullExtent
Layer.CreateVector Result=$cntr Name=contours CS=$dst Extent=$dst ShapeType=Arc
Layer.AddField Layer=$cntr Name=NewField Type=Float Width=3
Contour Source=$dst Destination=$cntr Field="NEW FIELD" ContourBase=15 ContourInterval=1
GIS.ZoomToLayer Layer=$cntr
GIS.Update
Base.Say "Done"

See: TGIS_Pipeline class.

Syntax

Comments

  • Line starting with a semicolon ; is treated as a comment
    ; this is my comment

Operations

  • Each operation is represented by a single line.
  • Format of each operation is
    OperationName paramter1=value parameterN=value

Variables

  • Operations can use and set variables.
  • Variables are named like $layer1, $src, $extent, etc.
  • Using dollar sign $ prefix for variables is not obligatory, but we recommend following this convention.

Parameters

  • Each operation's parameter can be expressed as:
    • reference to a variable
      parameter=$variable
    • number
      parameter=3.14
    • string
      parameter="some text"
  • Name of the first parameter can be omitted:
    MyOperation param1=$value1 param2=123
    MyOperation $value1 param2=123

Execution

  • Operations are executed line-by-line.
  • The execution is correct if all lines are executed without errors.

Operations

Common

Map Viewer

Layer

Pixel / Grid

2019/10/02 14:27