Main Content

cdflib.setVarCacheSize

Specify number of multi-file cache buffers for variable

Syntax

cdflib.setVarCacheSize(cdfId,varNum,numBuffers)

Description

cdflib.setVarCacheSize(cdfId,varNum,numBuffers) specifies the number of cache buffers the CDF library uses for a variable in a Common Data Format (CDF) file.

This function is only used with multifile format CDF files. It does not apply to single-file format CDFs. For more information about caching, see the CDF User's Guide.

Input Arguments

cdfId

Identifier of a CDF file, returned by a call to cdflib.create or cdflib.open.

varNum

Numeric value identifying a variable in the file. Variable identifiers (variable numbers) are zero-based.

numBuffers

Numeric value identifying the number of cache buffers to use.

Examples

Create a multifile CDF, and then retrieve the number of buffers being used for a variable:

cdfId = cdflib.create("your_file.cdf");

% Set the format of the file to be multi-file
cdflib.setFormat(cdfId,"MULTI_FILE")

% Create a variable in the file
varNum = cdflib.createVar(cdfId,"Time","cdf_int1",1,[],true,[]);

% Note how the library creates a separate file for the variable
ls your_file.*
your_file.cdf  your_file.z0   
% Determine the number of cache buffers used with the variable
numBuf = cdflib.getVarCacheSize(cdfId,varNum)
numBuf =

     1
% Increase the number of cache buffers used
cdflib.setVarCacheSize(cdfId,varNum,5)

% Check the number of cache buffers used with the variable
numBuf = cdflib.getVarCacheSize(cdfId,varNum)
numBuf =

     5
%Clean up
cdflib.delete(cdfId)
clear cdfId

References

This function corresponds to the CDF library C API routine CDFsetzVarCacheSize.

To use this function, you must be familiar with the CDF C interface. You can access the CDF documentation at the CDF website.