Update building attribute (TQL)
Revision as of 14:34, 17 February 2023 by Frank@tygron.nl (talk | contribs)
| Update | Description | Fixed clause amount | Polygon based |
|---|---|---|---|
| AREA | Update specified attribute with provided values for a specific Building or all buildings intersecting the query polygons | 1 | true |
Allowed clause parameters
| Param | Type | Description | Limits search polygon |
|---|---|---|---|
| AREA | Item ID | Area with ID | true |
| AREA_WITH_ATTRIBUTE | Attribute | Area with non zero Attribute value | true |
| ATTRIBUTE | Attribute | The attribute used for Buildings to obtain a value. | false |
| ATTRIBUTE_MAX | decimal | Only include Buildings that have an attribute value smaller than this value. | false |
| ATTRIBUTE_MAX | decimal | Only include Buildings that have an attribute value larger than or equal to this value. | false |
| BUFFER | decimal | Buffer the limiting search polygon with this value. | true |
| BUILDING | Item ID | Building with ID | false |
| CATEGORY | Category | Category with this value Buildings of this category |
false |
| FUNCTION | Item ID | Function with ID | false |
| 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 |
| 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 |
| NET_CLUSTER | Item ID | Net Cluster with ID | true |
| NET_LOAD | Item ID | Net Load with ID | false |
| RELATION | Relation | Allows to convert a specific selected item to an other item it is related to. | 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 |
| 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 |
| STATE | Timestate | Only include Buildings and Measures that are in this timestate | false |
| 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 |
| TIMEFRAME | timeframe | Specifies which timeframe to select when processing a particular Grid | false |
| ZONE | Item ID | Zone with ID | true |
| ZONE_WITH_ATTRIBUTE | Attribute | Zone with non zero Attribute value | true |
Examples
Traffic intensity on roads
The traffic intensity is a function value which affects calculations related to traffic. Some use-cases require these values to be updated dynamically. This can be done per neighborhood. (In this example, the neighborhood in question has the ID 1.)
UPDATE_BUILDING_TRAFFIC_FLOW_WHERE_CATEGORY_IS_ROAD_AND_NEIGHBORHOOD_IS_1
UPDATE_BUILDING: We're changing an attribute of a building.TRAFFIC_FLOW: The attribute we are changing is the TRAFFIC_FLOW, which is the technical name of a function value.CATEGORY_IS_ROAD: We only want to update this value on roads.NEIGHBORHOOD_IS_1: We are updating only in this specific neighborhood. Nothing outside the neighborhood is updated by this statement.