Main Content

progress

Class: matlab.io.datastore.SimulationDatastore
Package: matlab.io.datastore

Return percentage of data that you have read from a datastore

Syntax

p = progress(dst)

Description

p = progress(dst) returns the percentage, as a number between 0 and 1, of the data that you have read from a datastore (matlab.io.datastore.SimulationDatastore object). For example, a return value of 0.55 means you have read 55% of the data. Use the progress method and the NumSamples property to determine the current read position.

You read data from a SimulationDatastore object by using the read method.

Input Arguments

expand all

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

Output Arguments

expand all

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

Data Types: double

Introduced in R2017a