Select units (TQL)

Representation of unit size in relation to select units.

Select	Unit	Description	Fixed clause amount	Polygon based
UNITS	decimal	Returns the number of residential units, based on the Building's size per unit	No	true

Allowed clause parameters

Param	Value	Description	Limits search polygon
AREA	Integer (Item ID), ID, X, Y, XC, YC, XA, YA, XK or YK	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_MIN	decimal	Only include Buildings that have an Attribute value larger than or equal to this value.	false
ATTRIBUTE_MULT	Attribute	Multiply the calculated value with the value of this Attribute for a Building	false
BUFFER	decimal	Buffer the limiting search Polygon with this value.	true
BUILDING	Integer (Item ID), ID, X, Y, XC, YC, XA, YA, XK or YK	Building with ID	false
BUILDING_WITH_ATTRIBUTE	Attribute	Building with non zero Attribute value	false
CATEGORY	Category, X, Y, XA, YA	Category with this value. Buildings of this Category.	false
CATEGORYMULT	Category Value	Multiply the calculated value with this Category Value of a Building	false
CRS	positive integer	CRS EPSG number of requested coordinate system	false
FUNCTION	Integer (Item ID), ID, X, Y, XC, YC, XA, YA, XK or YK	Function with ID	false
FUNCTIONMULT	Function Value	Multiply the calculated value with this Function Value of a Building	false
GRID	Integer (Item ID), ID, X, Y, XC, YC, XA, YA, XK or YK	Grid of Grid Overlay with ID	false
GRID_WITH_ATTRIBUTE	Attribute	Grid of Grid Overlay with non zero Attribute value	false
GRIDTYPE	Grid Type, X, Y, XA, YA	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
INDICATOR	Integer (Item ID), ID, X, Y, XC, YC, XA, YA, XK or YK	Indicator with ID	false
ITERATION	positive integer	Query only executes when the current Iteration matches this value	false
KEY	String	Select Attribute based on Overlay Key value	false
LAYERTYPE	Layer, X, Y, XA, YA	Only include Buildings and Terrains that are part of this Layer	true
LEVEE	Integer (Item ID), ID, X, Y, XC, YC, XA, YA, XK or YK	Levee with ID	false
MAP	Map Type, X, Y, XA, YA	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	Integer (Item ID), ID, X, Y, XC, YC, XA, YA, XK or YK	Neighborhood with ID	true
NEIGHBORHOOD_WITH_ATTRIBUTE	Attribute	Neighborhood with non zero Attribute value	true
NET_CLUSTER	Integer (Item ID), ID, X, Y, XC, YC, XA, YA, XK or YK	Net Cluster with ID	true
NET_FUNCTION	Integer (Item ID), ID, X, Y, XC, YC, XA, YA, XK or YK	Net Function with ID	false
NET_LINE	Integer (Item ID), ID, X, Y, XC, YC, XA, YA, XK or YK	Net Line with ID	false
NET_LOAD	Integer (Item ID), ID, X, Y, XC, YC, XA, YA, XK or YK	Net Load with ID	false
NET_TYPE	Net type, X, Y, XA, YA	Only Net Items of this Net Type	false
OVERLAY	Integer (Item ID), ID, X, Y, XC, YC, XA, YA, XK or YK	Overlay with ID	false
PANEL	Integer (Item ID), ID, X, Y, XC, YC, XA, YA, XK or YK	Panel with ID	false
RELATION	Relation	Changes the context of a selected Item to another related Item.	false
RESIDENCE	boolean	When true, consider only Buildings that are Residences	false
RESULTTYPE	Result type, X, Y, XA, YA	Grid of Grid Overlay with specified Result type	true
ROAD_SYSTEM	boolean	When true, consider only Buildings that are part of the road system	false
SCENARIO	Integer (Item ID), ID, X, Y, XC, YC, XA, YA, XK or YK	Scenario with ID	false
STAKEHOLDER	Integer (Item ID), ID, X, Y, XC, YC, XA, YA, XK or YK	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	Integer (Item ID), ID, X, Y, XC, YC, XA, YA, XK or YK	Terrain of Terrain Type with ID	true
TERRAIN_WITH_ATTRIBUTE	Attribute	Terrain is of Terrain Type with non zero Attribute value	true
TIMEFRAME	timeframe, X, Y, XA, YA	Specifies which Timeframe to select when processing a particular Grid	false
ZONE	Integer (Item ID), ID, X, Y, XC, YC, XA, YA, XK or YK	Zone with ID	true
ZONE_WITH_ATTRIBUTE	Attribute	Zone with non zero Attribute value	true

API Endpoints

• Api session query

---

TQL

Select

Active • Attribute • Color • Distance • Expenses • Floorsize • Global • Gridarea • Gridavg • Gridmin • Gridmax • Gridvolume • Gridstdev • Height • ID • Iteration • Iterations • Landpolygons • Landsize • Latitude • Length • Levees • Longitude

• Lotpolygons • Lotsize • Name • Net State • Revenue • Score • Sessionstate • State • Target • Token • Topfloor • Units

Update

Address • Area • Building • Global • Indicator • Neighborhood • Net Function • Net Line • Net Load • Panel • Terrain • Zone

Other

Select • Update • Clause