Select active (TQL): Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (17 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Select TQL| | {{Select TQL|<onlyinclude> | ||
{{Select TQL| | {{Select TQL|tabletype=row|attribute=ACTIVE|unit={{boolean}}|description=Returns whether an [[Item]] is active in this [[Simulation]].|fixed=1|polygon=false|}}</onlyinclude> | ||
}} | }} | ||
==Allowed clause parameters== | |||
{{Param TQL| | |||
{{ | |||
{{: Area (TQL Param)}} | {{: Area (TQL Param)}} | ||
{{: Indicator (TQL Param)}} | {{: Indicator (TQL Param)}} | ||
{{: Neighborhood (TQL Param)}} | |||
{{: Net type (TQL Param)}} | |||
{{: Overlay (TQL Param)}} | {{: Overlay (TQL Param)}} | ||
{{: | {{: Scenario (TQL Param)}} | ||
}} | |||
==Examples== | |||
* <code>SELECT_ACTIVE_WHERE_AREA_IS_5</code> | |||
:: ''Returns whether the [[Area]] with Item ID 5 is considered active; I.e. the area has an ACTIVE [[Attribute]] that has a value that is larger than 0.'' | |||
* <code>SELECT_ACTIVE_WHERE_NET_TYPE_IS_ELECTRICITY</code> | |||
:: ''Returns whether the [[Net Setting]] ELECTRICITY_ACTIVE is considered active; I.e. the setting has a value of true.'' | |||
{{article end | |||
|api=* [[Api session query]] | |||
}} | }} | ||
{{TQL nav}} | {{TQL nav}} | ||
Latest revision as of 08:06, 15 July 2026
| Select | Unit | Description | Fixed clause amount | Polygon based |
|---|---|---|---|---|
| ACTIVE | boolean | Returns whether an Item is active in this Simulation. | 1 | false |
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 |
| INDICATOR |
Integer (Item ID), ID, X, Y, XC, YC, XA, YA, XK or YK |
Indicator with ID. | false |
| NEIGHBORHOOD |
Integer (Item ID), ID, X, Y, XC, YC, XA, YA, XK or YK |
Neighborhood with ID. | true |
| 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 |
| SCENARIO |
Integer (Item ID), ID, X, Y, XC, YC, XA, YA, XK or YK |
Scenario with ID. | false |
Examples
SELECT_ACTIVE_WHERE_AREA_IS_5
SELECT_ACTIVE_WHERE_NET_TYPE_IS_ELECTRICITY
- Returns whether the Net Setting ELECTRICITY_ACTIVE is considered active; I.e. the setting has a value of true.
API Endpoints