Select active (TQL): Difference between revisions

Latest revision as of 09:40, 9 January 2024

Select	Unit	Description	Fixed clause amount	Polygon based
ACTIVE	boolean	Returns whether an Item is active in this session	1	false

Param	Type	Description	Limits search polygon
AREA	Item ID	Area with ID	true
INDICATOR	Item ID	Indicator with ID	false
NEIGHBORHOOD	Item ID	Neighborhood with ID	true
NET_TYPE	Net type	Only net items of this net type	false
OVERLAY	Item ID	Overlay with ID	false

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.

Returns whether the Net Setting ELECTRICITY_ACTIVE is considered active; I.e. the setting has a value of true.

@@ Line 1: / Line 1: @@
-{{Select TQL|suppresscategory=true|allowselflinks=true|
+{{Select TQL|suppresscategory=true|allowselflinks=true|<onlyinclude>
-{{Select TQL|type=row|select=Active|unit={{boolean}}|description=Active in Simulation|fixed=1|polygon=false|}}
+{{Select TQL|tabletype=row|attribute=ACTIVE|unit={{boolean}}|description=Returns whether an [[Item]] is active in this [[session]]|fixed=1|polygon=false|}}</onlyinclude>
 }}
-{{Clause parameters}}
+{{Param TQL|suppresscategory=true|allowselflinks=true|list=true|
+{{: Area (TQL Param)}}
+{{: Indicator (TQL Param)}}
 {{: Neighborhood (TQL Param)}}
+{{: Net type (TQL Param)}}
+{{: Overlay (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.''
 {{TQL nav}}