SamplesAvailable (Data Acquisition Toolbox)

SamplesAvailable indicates the number of samples available per channel in the data acquisition engine.

For analog input objects, SamplesAvailable indicates the number of samples that can be removed from the engine for each channel group member with getdata. For analog output objects, SamplesAvailable indicates the number of samples that can be sent to each channel group member with putdata.

After a getdata or putdata function call is issued, SamplesAvailable is reduced by the number of samples extracted from the data acquisition engine.

Characteristics


Device Objects	AI, AO
Class	Common
Access	Read-only
Data Type	Double
Modify while Running	N/A

Values

The default value is zero.

Example

It is sometime useful to poll SamplesAvailable.

SamplesAvailable = get(AI, 'SamplesAvailable')
if (SamplesAvailable > 100)
getdata(AI, SamplesAvailable)
end