Differences

This shows you the differences between two versions of the page.

Link to this comparison view

samplestream:lcq_amountlagquery [2024/04/24 02:03] (current)
optrix created
Line 1: Line 1:
 +====AmountLagQuery====
  
 +This is a function of the [[class_LagCorrectedQuery|LagCorrectedQuery]] class.
 +
 +===Description===
 +
 +This sets up the //source of lag// for the query. In this case, the query will usually return a single point, which is usually some form of **counter** or **totaliser**.
 +
 +===Parameters===
 +
 +^Parameter^Type^Meaning^
 +|name|string|The name of the index in the final data-frame returned by [[lcq_Execute|Execute]]|
 +|query|string|An AQL query that returns a single analogue channel of data|
 +
 +===Returns===
 +
 +Nothing
 +
 +===Usage===
 +
 +The **name** normally describes what the point (returned from running the **query**) represents.
 +
 +If the point is a //odometer// (reading distance), the name could be 'meters' or 'distance'.
 +
 +If the point is a //flowmeter//, the name could me 'litres' or 'gallons'.