Clause (TQL): Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
A TQL query statement consists of a command, either [[Select (TQL)|Select]] or Update, and a list of clauses. The clauses provide further specification of the query statement, or a refinement, spatially or property wise. | A TQL query statement consists of a command, either [[Select (TQL)|Select]] or [[Update (TQL)|Update]], and a list of clauses. The clauses provide further specification of the query statement, or a refinement, spatially or property wise. | ||
A clause consists of a clause parameter and a clause value, where currently the only supported operator between the parameter and value is ''IS''. | A clause consists of a clause parameter and a clause value, where currently the only supported operator between the parameter and value is ''IS''. | ||
Revision as of 13:13, 28 February 2023
A TQL query statement consists of a command, either Select or Update, and a list of clauses. The clauses provide further specification of the query statement, or a refinement, spatially or property wise.
A clause consists of a clause parameter and a clause value, where currently the only supported operator between the parameter and value is IS.
Spatial
These parameters can be used to limit the search polygon, that is used to query buildings.
| Param | Type | Description | Limits search polygon |
|---|---|---|---|
| AREA | Item ID | Area with ID | true |
| AREA_WITH_ATTRIBUTE | Attribute | Area with non zero Attribute value | true |
| BUFFER | decimal | Buffer the limiting search polygon with this value. | true |
| GRIDVALUE | decimal | Only include Grid Overlay cells that have a value equal to the one specified | true |
| LAYERTYPE | Layer | Only include Buildings and Terrains that are part of this layer | true |
| MAP | Map Type | Only items present in this Map Type | true |
| MAXGRIDVALUE | decimal | Only include Grid Overlay cells that have a value smaller than the one specified | true |
| MINGRIDVALUE | decimal | Only include Grid Overlay cells that have a value larger than or equal to the one specified | true |
| NEIGHBORHOOD | Item ID | Neighborhood with ID | true |
| NEIGHBORHOOD_WITH_ATTRIBUTE | Attribute | Neighborhood with non zero Attribute value | true |
| STAKEHOLDER | Item ID | Stakeholder with ID Only include Plots that are owned by the stakeholder with this ID Only include Items that are related to this stakeholder |
true |
| STAKEHOLDERTYPE | Stakeholder Type | Stakeholder Type with this value Only include Plots that are owned by this type of stakeholder |
true |
| TERRAIN | Item ID | Terrain of Terrain Type with ID | true |
| TERRAIN_WITH_ATTRIBUTE | Attribute | Terrain is of Terrain Type with non zero Attribute value | true |
| ZONE | Item ID | Zone with ID | true |
| ZONE_WITH_ATTRIBUTE | Attribute | Zone with non zero Attribute value | true |
Attribute
These parameters are related to attributes.
| Param | Type | Description | Limits search polygon |
|---|---|---|---|
| ATTRIBUTE | Attribute | The attribute used for Buildings to obtain a value. | false |
| ATTRIBUTE_MAX | decimal | Only include Buildings that have an attribute value larger than or equal to this value. | false |
| ATTRIBUTE_MAX | decimal | Only include Buildings that have an attribute value smaller than this value. | false |
| ATTRIBUTE_MULT | Attribute | Multiply the calculated value with the value of this attribute for a Building | false |
| INDEX | positive integer | Allows to specify which value in an attribute' s value array to select. | false |
Grid
These parameters are specifically related to grids.
| Param | Type | Description | Limits search polygon |
|---|---|---|---|
| GRID | Item ID | Grid of Grid Overlay with ID | false |
| GRID_WITH_ATTRIBUTE | Attribute | Grid of Grid Overlay with non zero Attribute value | false |
| GRIDTYPE | Overlay type | Grid of Grid Overlay with specified type | true |
| GRIDVALUE | decimal | Only include Grid Overlay cells that have a value equal to the one specified | true |
| MINGRIDVALUE | decimal | Only include Grid Overlay cells that have a value larger than or equal to the one specified | true |
| MAXGRIDVALUE | decimal | Only include Grid Overlay cells that have a value smaller than the one specified | true |
| OVERLAY | Item ID | Overlay with ID | false |
| TIMEFRAME | timeframe | Specifies which timeframe to select when processing a particular Grid | false |
Item
These parameter can be used to consider only a specific item of that kind.
| Param | Type | Description | Limits search polygon |
|---|---|---|---|
| ADDRESS | Item ID | Address with ID | false |
| AREA | Item ID | Area with ID | true |
| BUILDING | Item ID | Building with ID | false |
| FUNCTION | Item ID | Function with ID | false |
| GLOBAL | Item ID | Global with ID | false |
| GRID | Item ID | Grid of Grid Overlay with ID | false |
| INDICATOR | Item ID | Indicator with ID | false |
| LEVEE | Item ID | Levee with ID | false |
| MEASURE | Item ID | Measure with ID | false |
| NEIGHBORHOOD | Item ID | Neighborhood with ID | true |
| OVERLAY | Item ID | Overlay with ID | false |
| PANEL | Item ID | Panel with ID | false |
| RELATION | Relation | Allows to convert a specific selected item to an other item it is related to. | false |
| STAKEHOLDER | Item ID | Stakeholder with ID Only include Plots that are owned by the stakeholder with this ID Only include Items that are related to this stakeholder |
true |
| TERRAIN | Item ID | Terrain of Terrain Type with ID | true |
| ZONE | Item ID | Zone with ID | true |
Net
These parameter are specific to network related items. Some can also be used to limit the selected Buildings.
| Param | Type | Description | Limits search polygon |
|---|---|---|---|
| NET_LINE | Item ID | Net line with ID | false |
| NET_TYPE | Net type | Only net items of this net type | false |
| NET_FUNCTION | Item ID | Net Function with ID | false |
| NET_LOAD | Item ID | Net Load with ID | false |
| NET_CLUSTER | Item ID | Net Cluster with ID | true |
Property
These parameters are mostly related to building properties to filter on, but also include properties related to and shared with other items, such as Stakeholders.
| Param | Type | Description | Limits search polygon |
|---|---|---|---|
| CATEGORY | Category | Category with this value Buildings of this category |
false |
| CATEGORYMULT | Item ID | Multiply the calculated value with this Category Value of a Building | false |
| FUNCTIONMULT | Item ID | Multiply the calculated value with this Function Value of a Building | false |
| LAYERTYPE | Layer | Only include Buildings and Terrains that are part of this layer | true |
| MAP | Map Type | Only items present in this Map Type | true |
| NAME | String | Only a specific name | false |
| RESIDENCE | boolean | When true, consider only Buildings that are residences | false |
| ROAD_SYSTEM | boolean | When true, consider only Buildings that are part of the road system | false |
| STAKEHOLDERTYPE | Stakeholder Type | Stakeholder Type with this value Only include Plots that are owned by this type of stakeholder |
true |
| STATE | Timestate | Only include Buildings and Measures that are in this timestate | false |
| TERM |
Client Word Server Word |
Client/Server word with name. | false |