isDone

End-of-data status

Syntax

tf = isDone(obj)

Description

tf = isDone(obj) returns true when the data from a finite source has been exhausted, typically because all data has been read. The System object obj is often a file reader, and isDone looks for the end of the file. Otherwise, isDone returns false.

Examples

Read MAT File

This example shows how to read a MAT file using the dsp.MatFileReader (DSP System Toolbox) object.

Note

This example requires DSP System Toolbox™.

filename = [tempname '.mat'];               % Create variable name
originalData = rand(10,2);
save(filename,'originalData','-v7.3');      % Write to MAT file
 
mfr = dsp.MatFileReader(filename,'VariableName',...
   'originalData','SamplesPerFrame', 4);  
while ~isDone(mfr)            % Stream data into MATLAB
    isDone(mfr)               % Display zero if end-of-data not reached
    finalData = mfr()         % Display read frame
end

Input Arguments

obj — System object™ to query

System object

System object whose status you want to query.

Output Arguments

tf — True or false

0 | 1

True or false result, returned as:

• Logical 1 (done) — End-of-data has been reached.

• Logical 0 (not done) — End-of-data has not been reached.

Extended Capabilities

C/C++ Code Generation

Generate C and C++ code using MATLAB® Coder™.

For details, see System Objects in MATLAB Code Generation (MATLAB Coder).

Version History

Introduced in R2010a