Home
Reference
Find details on the SPL language, toolkits, APIs, commands, and more.
Toolkits
A toolkit is a set of SPL artifacts, which are organized into a package. Toolkits make SPL or native functions and primitive or composite operators reusable across different applications.
Toolkits
Toolkit com.teracloud.streams.geospatial 5.0.0
Namespace com.teracloud.streams.geospatial
SPL File RegionMatchTypes.spl

Welcome
Learn about the core capabilities of Teracloud® Streams, its architecture, and key concepts.
Installing
Use this information to install, upgrade, and uninstall the Teracloud® Streams product.
Configuring
Create a basic or an enterprise domain which is a single point for configuring and managing common resources, security, and instances.
Administering
Administer the product by using the Teracloud® Streams graphical user interface, APIs, or the streamtool command-line interface.
Developing
Develop stream applications with the Streams Processing Language (SPL), Java, and Python.
Troubleshooting
Resolve problems with Teracloud® Streams using the troubleshooting tools provided with the product as well as the resources offered by Teracloud Support.
Reference
Find details on the SPL language, toolkits, APIs, commands, and more.
- APIs
  Application programming interfaces (APIs) provide functions that simplify applications development.
- Job configuration overlays
  You can specify or change configuration parameters when you use the submitjob or updateoperators operations. The settings control submission constraints, host constraints and locations, and operator status. Parameters are captured and updated in the configuration JSON file. When you change the values in the job configuration overlay file, the changes override any previously set values.
- Commands
  Teracloud® Streams provides a number of commands you use to perform tasks.
- Operator model
  An operator model is an XML document that describes the basic properties of a primitive operator.
- Streams Processing Language (SPL)
  Streams Processing Language (SPL) is a distributed data flow composition language that is used in Teracloud® Streams. SPL has primitive types, program structures, and definitions that are tailored for streaming data.
- Toolkits
  A toolkit is a set of SPL artifacts, which are organized into a package. Toolkits make SPL or native functions and primitive or composite operators reusable across different applications.
  - Specialized toolkit requirements and restrictions
    Several of the specialized toolkits require RPMs that are not required by the Teracloud® Streams product. There are also toolkit restrictions on some platforms.
  - Toolkits
- SPLDOC markup
  You can use SPLDOC markup in the descriptions associated with the SPL artifacts in a toolkit. The spl-make-doc command generates HTML documentation from the marked up artifacts.
Glossary
Use this glossary to find terms and definitions for Teracloud® Streams.

SPL File RegionMatchTypes.spl

Content

Types

RegionMatchTypes.RegionInfo: The RegionMatch operator matches device locations against geographical rgions stored in tte operator.

Composites

composite RegionMatchTypes

Types that are used together with the RegionMatch operator.

Static Types

RegionMatchTypes.RegionInfo = tuple<rstring id, rstring polygonAsWKT, boolean removeRegion, boolean notifyOnEntry, boolean notifyOnExit, boolean notifyOnHangout, int64 minimumDwellTime, int64 timeout>;

The RegionMatch operator matches device locations against geographical rgions stored in tte operator. Each region added to the operator needs to conform to the RegionInfo type. The type contains the following attributes.

id
The unique identifier of the region.
polygonAsWKT

The geometry of the region as WKT string. For example : POLYGON((13.413140166512107 52.53577235025506,13.468071807137107 52.53577235025506,13.468071807137107 52.51279486997035,13.413140166512107 52.51279486997035,13.413140166512107 52.53577235025506))
removeRegion

A flag indicating if the region shall be removed. If false the region will be added. If true it will be removed. On removal only the regionId field is needed.

notifyOnEntry

A flag indicating if an ENTRY event shall be generated when a device enters the region.


* * **notifyOnExit**

*   A flag indicating if an EXIT event shall be generated when a device leaves the region.

* * **notifyOnHangout**

*   A flag indicating if a HANGOUT event shall be generated when a device stays in the region for some time.

minimumDwellTime

The minimum time in seconds a device has to be observed in a certain region, before a 'Hangout' event is reported.
timeout

Device timeout in seconds. In case a device was last observed more than timeout seconds ago, the device is treated as stale and is removed before the new observation is processed. If this value is zero, no timeout handling is performed.