Documentation Center

  • Trial Software
  • Product Updates

SamplesAvailable

Indicate number of samples available per channel in engine

Description

    Note:   You cannot use the legacy interface on 64–bit MATLAB®. See Session-Based Interface to acquire and generate data.

For analog input (AI) objects, SamplesAvailable indicates the number of samples that can be extracted from the engine for each channel group member with the getdata function. For analog output (AO) objects, SamplesAvailable indicates the number of samples that have been queued with the putdata function, and can be sent (output) to each channel group member.

After data has been extracted (AI) or output (AO), the SamplesAvailable value is reduced by the appropriate number of samples. For AI objects, SamplesAvailable is reset to zero after a start function is issued.

For AI objects, use the SamplesAcquired property to find out how many samples have been acquired since the start function was issued. For AO objects, use the SamplesOutput property to find out how many samples have been output since the start function was issued.

Characteristics

Usage

AI, AO, common to all channels

Access

Read-only

Data type

Double

Read-only when running

N/A

Values

The value is automatically updated based on the number of samples acquired (analog input) or sent (analog output). The default value is zero.

See Also

Functions

start

Properties

SamplesAcquired, SamplesOutput

Was this topic helpful?