progress

Class: matlab.io.Datastore
Namespace: matlab.io

Determine how much data has been read

Syntax

p = progress(ds)


Description

p = progress(ds) returns the percentage of the data that you have read from the matlab.io.Datastore object specified by ds. The p output is a number between 0 and 1. A return value of 0.55 means you have read 55% of the data.

Input Arguments

ds — Input datastore

matlab.io.Datastore object

Input datastore, specified as a matlab.io.Datastore object. To create a Datastore object, see matlab.io.Datastore.

Output Arguments

p — Percentage of data

scalar double

Percentage of data that you have read from the datastore, returned as a scalar double.

Data Types: double

Attributes

Abstract	true
Access	public
Hidden	false
Sealed	false
Static	false

To learn about attributes of methods, see Method Attributes.

Tips

• You must implement the progress method by deriving a subclass from the matlab.io.Datastore class. For more information, see Develop Custom Datastore.

Version History

Introduced in R2017b