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.SimulationDatastoreobject). For example, a return value of0.55means you have read 55% of the data. Use theprogressmethod and theNumSamplesproperty to determine the current read position.

You read data from aSimulationDatastoreobject by using thereadmethod.

Input Arguments

expand all

Input datastore, specified as amatlab.io.datastore.SimulationDatastoreobject. To create aSimulationDatastoreobject, seematlab.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

中on History

Introduced in R2017a