TQL: Difference between revisions
| Line 38: | Line 38: | ||
|} | |} | ||
===Comparison Predicate | ===Comparison Predicate=== | ||
The <code>SELECT</code> and result parameter are followed by the <code>WHERE</code> statement. The <code>WHERE</code> statements includes a comparison predicate, which restricts the information taken into account by the query. The WHERE clause eliminates all information from the result set where the comparison predicate does not evaluate to True. | The <code>SELECT</code> and result parameter are followed by the <code>WHERE</code> statement. The <code>WHERE</code> statements includes a comparison predicate, which restricts the information taken into account by the query. The WHERE clause eliminates all information from the result set where the comparison predicate does not evaluate to True. | ||
| Line 46: | Line 46: | ||
* Value | * Value | ||
====Clauses==== | |||
The clause types and expected values currently supported are: | The clause types and expected values currently supported are: | ||
{| class="wikitable" | {| class="wikitable" | ||
Revision as of 14:47, 30 June 2015
|
Please note: This page is currently being updated! |
TQL
The Tygron Query Language is a special-purpose programming language designed for obtaining spacial area information from a specific game session on the Tygron Engine. The primary reason for its development was to make an easy to use bridge between the Tygron Engine and Microsoft Excel.
Queries
The operation used in TQL is the query, which is performed with the declarative SELECT statement. SELECT retrieves data from a running Tygron game session. The SELECT statements have no persistent effects on the game session itself.
Queries allow the user to describe desired data, leaving the Tygron Engine responsible for planning, optimizing, and performing the physical operations necessary to produce that result as it chooses.
A query includes a parameter to include in the final result, immediately following the SELECT keyword. Currently, one of the following result parameters can be chosen:
| Result Parameter | Description | Example |
|---|---|---|
FLOORSIZE
|
Floor size of buildings. | SELECT_FLOORSIZE_WHERE_CATEGORY_IS_OFFICES
|
LOTSIZE
|
Lot size of buildings. | SELECT_LOTSIZE_WHERE_CATEGORY_IS_OFFICES
|
UNITS
|
Amount of housing units. | SELECT_UNITS_WHERE_CATEGORY_IS_SOCIAL
|
DIKES
|
Surface space of constructed dikes or levees. | SELECT_DIKES_WHERE_ZONE_IS_1
|
Comparison Predicate
The SELECT and result parameter are followed by the WHERE statement. The WHERE statements includes a comparison predicate, which restricts the information taken into account by the query. The WHERE clause eliminates all information from the result set where the comparison predicate does not evaluate to True.
The comparison predicate consists of 0 or more clauses. Clauses consists of three parts;
- Clause Type
- Operator
- Value
Clauses
The clause types and expected values currently supported are:
| Clause Type | Description | Value Type | Example |
|---|---|---|---|
CATEGORY
|
A building belongs to the specific Function category | Function category | Function category
|
FUNCTION
|
A buildings belongs to a specific Function | Function ID | SELECT_FLOORSIZE_WHERE_FUNCTION_IS_621
|
DIKE
|
A building is constructed or planned on top of a particular type of Dike (or Levee) | Function category | Function category
|
MAP
|
A building is present in the specified map or view. Also see Simulation Type | Function category | Function category
|
STAKEHOLDER
|
A building belongs to a specific Stakeholder | Stakeholder ID | SELECT_DIKES_WHERE_STAKEHOLDER_IS_3
|
MAP
|
A buildings belongs to the specified Function category | Function category | Function category
|
MAP
|
A buildings belongs to the specified Function category | Function category | Function category
|
MAP
|
A buildings belongs to the specified Function category | Function category | Function category
|
Operators
TQL clausses currently support the following Operators:
| Operator | Description | Example |
|---|---|---|
IS
|
Equal to | CATEGORY_IS_OFFICES
|
Simulation Type
Depending on the Simulation Type, the map parameter is named as followed in the Query Tool:
| Simulation Type | CURRENT
|
MAQUETTE
|
|---|---|---|
| Planning | ORIGINAL
|
PLANNED
|
| Timeline | TODAY
|
MODEL
|