Built-in Operations

The following Built-in operations can be used within 1Integrate.

ClosedGeometric Operations

ClosedNetwork Graph Connectivity Operations

Network Graph Connectivity Operations are used to construct network graphs (see Connecting Network Graphs).

Operation Description Parameter(s)
add_position

Adds an object, as a position, to a network graph.

Note: There will be no output results if the object is added to a network graph that already contains the object.

  • The name of the network graph (can be null).
  • The object to add.
connect_positions

Creates directed connections between two objects in a network graph.

Both objects must have been previously added to the network graph.

Note: This connection is one-way. To specify a connection in both directions, call this again, reversing the order.

Note: There will be no output results if the connecting positions are already connected.

  • The name of the network graph (can be null).
  • The object at the start of the connection.
  • The object at the end of the connection.
disconnect_positions

Removes a direct connection from a network graph.

Note: There will be no output results if non-connected positions are disconnected.

  • The name of the network graph (can be null).
  • The object at the start of the connection.
  • The object at the end of the connection.
remove_position

Removes an object from a network graph. Disconnects it from any other objects in the network.

Note: Does nothing if the network graph did not contain the object.

  • The name of the network graph (can be null).
  • The object to remove.

ClosedPartition operations

Partition operations are used to run sessions on multiple platforms (see Partitioning).

Operation Description Parameter(s)
amalgamate_partitions Amalgamates partition objects to create larger partitions suitable for parallel processing of larger datasets. Source partitions will be merged, where possible creating amalgamated partitions of approximately rectangular shape.

 

create_outer_partitions Creates outer partition lines that fit within the supplied area geometry. These lines define a square grid within the provided geometry. A line will never cross an existing partition. These lines ensure all data within the provided geometry lie within a partition, avoiding a single large partition around the edges.
  • Pipe ('|') separated list of class names from which the interior partitions were formed.

  • The name of the partition class. The outer partitions will be created in this class. Outer partition lines will not cross objects of this class. The partitions must be topologically structured.

  • Area geometry within which outer partition lines should be created. Typically, this is the session extent.

  • Maximum spacing distance between the straight line divisions. A smaller spacing may be used to retain a constant spacing between grid lines.

ClosedShifting Operations

Shift operations are used to perform Positional Data Shifting (see Positional Data Shifting).

Operation Description Parameter(s)
register_constraining_geometry

Used to register constraining geometries (see Positional Data Shifting).

Note: Ensure that the name used for the register_shift_vector built-in operation is used here.

Note: Any heighted 2D geometries will be projected down to 2 dimensions.

  • A name to identify a set of shift vectors.

  • A line or area geometry with the original values for the point co-ordinates. The line segments or the edges of an area will be constrained.

register_shift_geometry

Used to register shift geometries (see Positional Data Shifting).

Note: Ensure that the same name is passed to the shift_geometry built-in function.

Note: Any heighted 2D geometries will be projected down to 2 dimensions.

  • A name to identify a set of shift vectors.

  • A geometry with the original values for the point co-ordinates.

  • A geometry, similar to the original geometry, but with the new values for the point co-ordinates.

register_shift_vector

Used to register shift vectors (see Positional Data Shifting).

Note: Ensure that the same name is passed to the shift_geometry built-in function in order to shift geometries using this set. Registering shift vectors with different shift vector set names will create independent shift vector sets.

Note: Any heighted 2D geometries will be projected down to 2 dimensions.

  • A name to identify a set of shift vectors.

  • A two-vertex line or point geometry indicating the shift, where a point indicates no shifting

ClosedSorting Operations

Note: The tsort_* operations are used to implement iterating through objects in dependency order. Please contact 1Spatial Support for further guidance on their use.

Operation Parameter(s)
tsort_add_dependency
  • The predecessor object that must appear before the successor.

  • The successor object that must appear after the predecessor.

  • The name of the topological sort. If not provided, or null, the default topological sort will be used.

tsort_add_object
  • The object to add.

  • The name of the topological sort. If not provided, or null, the default topological sort will be used.

tsort_remove_dependency
  • The predecessor object that no longer must (but still may) appear before the successor.

  • The successor object that no longer must (but still may) appear after the predecessor.

  • The name of the topological sort. If not provided, or null, the default topological sort will be used.

tsort_remove_object
  • The object to remove

  • The name of the topological sort. If not provided, or null, the default topological sort will be used.

tsort_reset
  • The name of the topological sort. If not provided, or null, the default topological sort will be used.

ClosedTopology Operations

ClosedAttributes Operations