Main Content

Simulink.sdi.getRequiredFreeSpace

Get configured minimum disk space requirement for logging

Since R2021a

collapse all in page

    Syntax

    minDiskSpace = Simulink.sdi.getRequiredFreeSpace

    Description

    minDiskSpace = Simulink.sdi.getRequiredFreeSpace returns the minimum free disk space requirement configured for logging, in units of GB.

    example

    Examples

    collapse all

    Open Live Script

    You can limit the size of logged data by specifying a maximum size for the data or a minimum amount of disk space to leave empty. This example uses several functions to get the current configuration of logging size limits.

    Use the Simulink.sdi.getRequiredFreeSpace function to get the configured minimum free disk space requirement. The returned value uses units of GB.

    minDiskSpace = Simulink.sdi.getRequiredFreeSpace;

    Use the Simulink.sdi.getMaxDiskUsage function to get the configured maximum size for data logged to disk. The returned value uses units of GB.

    maxSize = Simulink.sdi.getMaxDiskUsage;

    Use the Simulink.sdi.getDeleteRunsOnLowSpace function to get the configured behavior when approaching the logging limits. When deleteRuns is true, data from prior simulations is deleted first to free disk space for continued logging in the current simulation. If deleting runs does not free up enough space, recording logged data is disabled for the current simulation. When deleteRuns is false, recording logged data is disabled for the current simulation and data from prior simulations is retained.

    deleteRuns = Simulink.sdi.getDeleteRunsOnLowSpace;

    Output Arguments

    collapse all

    Minimum free disk space requirement for logging, returned as a scalar, in units of GB.

    Version History

    Introduced in R2021a

    See Also

    Functions

    Topics