Variables controlling the compression, name size, and integer size.

Typedefs
typedef enum ex_option_type	ex_option_type
typedef enum ex_compression_type	ex_compression_type

Enumerations
enum	ex_option_type {   EX_OPT_MAX_NAME_LENGTH , EX_OPT_COMPRESSION_TYPE , EX_OPT_COMPRESSION_LEVEL , EX_OPT_COMPRESSION_SHUFFLE ,   EX_OPT_QUANTIZE_NSD , EX_OPT_INTEGER_SIZE_API , EX_OPT_INTEGER_SIZE_DB }
enum	ex_compression_type {   EX_COMPRESS_ZLIB = 1 , EX_COMPRESS_GZIP = 1 , EX_COMPRESS_SZIP , EX_COMPRESS_ZSTD ,   EX_COMPRESS_BZ2 }

Detailed Description

Typedef Documentation

ex_compression_type

typedef enum ex_compression_type ex_compression_type

ex_option_type

typedef enum ex_option_type ex_option_type

Enumeration Type Documentation

ex_compression_type

enum ex_compression_type

Enumerator
EX_COMPRESS_ZLIB	Use ZLIB-based compression (if available)
EX_COMPRESS_GZIP	Same as ZLIB, but typical alias used
EX_COMPRESS_SZIP	Use SZIP-based compression (if available)
EX_COMPRESS_ZSTD	Use ZStandard compression (if available)
EX_COMPRESS_BZ2	Use BZ2 / Bzip2 compression (if available)

ex_option_type

enum ex_option_type

Modes for ex_set_option()

The compression-related options are only available on netcdf-4 files since the underlying hdf5 compression functionality is used for the implementation. The compression level indicates how much effort should be expended in the compression and the computational expense increases with higher levels; in many cases, a compression level of 1 is sufficient.

SZIP-based compression is typically faster than ZLIB, but may not be as widely available as ZLIB. SZIP is also only supported in NetCDF-4.?.? and later

Enumerator
EX_OPT_MAX_NAME_LENGTH	Maximum length of names that will be returned/passed via api call.
EX_OPT_COMPRESSION_TYPE	Default is gzip
EX_OPT_COMPRESSION_LEVEL	Range depends on compression type.
EX_OPT_COMPRESSION_SHUFFLE	1 if enabled, 0 if disabled
EX_OPT_QUANTIZE_NSD	if > 0, Number of significant digits to retain in lossy quantize compression
EX_OPT_INTEGER_SIZE_API	4 or 8 indicating byte size of integers used in api functions.
EX_OPT_INTEGER_SIZE_DB	Query only, returns 4 or 8 indicating byte size of integers stored on the database.