sample
sample Structure: Description for sampling.
sample structuresource
source typeinitial delay integer: optionalfrequency integer: optionalwindow integer: optional, defaultlimit integer: optionalcriteria array of
sample criterion: optional, uniqueDescription
sample describes the constraints and criteria for sampling the environment and determining a result. sample provides a generic solution to a class of common situations that require near constant monitoring of external events.
Fields
source
Source of samples.
initial delay
Delay before sampling begins in seconds.
frequency
Frequency of sampling in seconds.
window
Sample window to evaluate.
The number of historic samples to use when determining if the criteria has been met. The window represents a collection of the latest samples gathered. As samples leave the window they are released and will not be used in any future evaluations.
No evaluation will occur until enough samples have been collected to fill the window.
limit
Seconds after sampling begins that it is stopped.
If the sampling has not reached a result and limit's duration has passed since sampling begun, stop the sampling. Limit provides a time constraint on the sampling process.
criteria
Criteria to evaluate gathered samples with.