Provides the C-style interface for ioda::VariableCreationParameters. More...

Collaboration diagram for Variable Creation Parameters:

Files
file	Variable_Creation_Parameters_c.h
	C bindings for ioda::VariableCreationParameters, used in ioda::Has_Variables::create.

file	Variable_Creation_Parameters_c.cpp
	C bindings for ioda::VariableCreationParameters, used in ioda::Has_Variables::create.

Classes
struct	c_variable_creation_parameters
	Class-like encapsulation of C variable creation parameters functions. More...

Macros
#define	IODA_VCP_FILL_TEMPLATE2(funcnamestr, typ) void (funcnamestr)(struct ioda_variable_creation_parameters, typ);

#define	IODA_VCP_FILL_IMPL(funcnamestr, Type)

Functions
IODA_DL void	ioda_variable_creation_parameters_destruct (struct ioda_variable_creation_parameters *params)
	Deallocates variable creation parameters. More...

IODA_DL struct ioda_variable_creation_parameters *	ioda_variable_creation_parameters_create ()
	Allocates a new variable creation parameters instance. More...

IODA_DL struct ioda_variable_creation_parameters *	ioda_variable_creation_parameters_clone (const struct ioda_variable_creation_parameters *source)
	Make a copy of an existing variable creation parameters object. More...

	c_variable_creation_parameters::C_TEMPLATE_FUNCTION_DEFINITION_NOSTR (setFillValue, IODA_VCP_FILL_TEMPLATE2)

ioda_variable_creation_parameters *	ioda_variable_creation_parameters_clone (const ioda_variable_creation_parameters *p)

	C_TEMPLATE_FUNCTION_DEFINITION_NOSTR (ioda_variable_creation_parameters_setFillValue, IODA_VCP_FILL_IMPL)

Variables
void(*	c_variable_creation_parameters::destruct )(struct ioda_variable_creation_parameters *)

struct ioda_variable_creation_parameters (	c_variable_creation_parameters::create )()

struct ioda_variable_creation_parameters (	c_variable_creation_parameters::clone )(const struct ioda_variable_creation_parameters *)

void(*	c_variable_creation_parameters::chunking )(struct ioda_variable_creation_parameters , bool, size_t, const ptrdiff_t )

void(*	c_variable_creation_parameters::noCompress )(struct ioda_variable_creation_parameters *)

void(*	c_variable_creation_parameters::compressWithGZIP )(struct ioda_variable_creation_parameters *, int)

void(*	c_variable_creation_parameters::compressWithSZIP )(struct ioda_variable_creation_parameters *, unsigned, unsigned)

Set fill value
	C_TEMPLATE_FUNCTION_DEFINITION_NOSTR (ioda_variable_creation_parameters_setFillValue, IODA_VCP_FILL_TEMPLATE)

#define	IODA_VCP_FILL_TEMPLATE(funcnamestr, typ) IODA_DL void funcnamestr(struct ioda_variable_creation_parameters* params, typ data);
	Sets a template for the fill value functions. More...

Chunking
IODA_DL void	ioda_variable_creation_parameters_chunking (struct ioda_variable_creation_parameters params, bool doChunking, size_t Ndims, const ptrdiff_t chunks)
	Set chunking options. More...

Compression
IODA_DL void	ioda_variable_creation_parameters_noCompress (struct ioda_variable_creation_parameters *params)
	Disable compression. More...

IODA_DL void	ioda_variable_creation_parameters_compressWithGZIP (struct ioda_variable_creation_parameters *params, int level)
	Compress with GZIP. More...

IODA_DL void	ioda_variable_creation_parameters_compressWithSZIP (struct ioda_variable_creation_parameters *params, unsigned PixelsPerBlock, unsigned options)
	Compress with SZIP. More...

Detailed Description

Provides the C-style interface for ioda::VariableCreationParameters.

Macro Definition Documentation

◆ IODA_VCP_FILL_IMPL

#define IODA_VCP_FILL_IMPL	(	funcnamestr,
		Type
	)

Value:

  IODA_DL void funcnamestr(struct ioda_variable_creation_parameters* p, Type value) {              \
    C_TRY;                                                                                         \
    Expects(p != nullptr);                                                                         \
    p->params.setFillValue<Type>(value);                                                           \
    C_CATCH_AND_TERMINATE;                                                                         \
  }

Definition at line 85 of file Variable_Creation_Parameters_c.cpp.

◆ IODA_VCP_FILL_TEMPLATE

#define IODA_VCP_FILL_TEMPLATE	(	funcnamestr,
		typ
	)	IODA_DL void funcnamestr(struct ioda_variable_creation_parameters* params, typ data);

Sets a template for the fill value functions.

This is documentation for a series of functions in C that attempt to emulate C++ templates using macro magic. The template parameter SUFFIX is written into the function name.

Template Parameters

SUFFIX is the type (long, int64_t) that is appended to this function name in the C interface.

Parameters

[in]	params	is the parameters object.
	data	is the fill value, applied as a bit pattern (the type here does not strictly need to match the variable's type).

Definition at line 63 of file Variable_Creation_Parameters_c.h.

◆ IODA_VCP_FILL_TEMPLATE2

#define IODA_VCP_FILL_TEMPLATE2	(	funcnamestr,
		typ
	)	void (funcnamestr)(struct ioda_variable_creation_parameters, typ);

Definition at line 135 of file Variable_Creation_Parameters_c.h.

Function Documentation

◆ C_TEMPLATE_FUNCTION_DEFINITION_NOSTR() [1/3]

C_TEMPLATE_FUNCTION_DEFINITION_NOSTR	(	ioda_variable_creation_parameters_setFillValue	,
		IODA_VCP_FILL_IMPL
	)

◆ C_TEMPLATE_FUNCTION_DEFINITION_NOSTR() [2/3]

C_TEMPLATE_FUNCTION_DEFINITION_NOSTR	(	ioda_variable_creation_parameters_setFillValue	,
		IODA_VCP_FILL_TEMPLATE
	)

◆ C_TEMPLATE_FUNCTION_DEFINITION_NOSTR() [3/3]

c_variable_creation_parameters::C_TEMPLATE_FUNCTION_DEFINITION_NOSTR	(	setFillValue	,
		IODA_VCP_FILL_TEMPLATE2
	)

◆ ioda_variable_creation_parameters_chunking()

void ioda_variable_creation_parameters_chunking	(	struct ioda_variable_creation_parameters *	params,
		bool	doChunking,
		size_t	Ndims,
		const ptrdiff_t *	chunks
	)

Set chunking options.

Parameters

[in]	params	is the parameters object.
	doChunking	is a flag indicating whether chunking should be used.
	Ndims	is the dimensionality of chunks. Ignored if doChunking is false.
[in]	chunks	is a sequence of chunk lengths along each dimension. Ignored if doChunking is false.

Note: Chunking dimensionality must match the dimensionality of the variable to be created.; Chunk lengths must be nonzero, but this function accepts zero lengths because later on these values might be "filled in" using hints from dimension scales.

Precondition: params must be valid.; chunks must have size Ndims.

Definition at line 46 of file Variable_Creation_Parameters_c.cpp.

Here is the caller graph for this function:

◆ ioda_variable_creation_parameters_clone() [1/2]

ioda_variable_creation_parameters* ioda_variable_creation_parameters_clone ( const ioda_variable_creation_parameters * p )

Definition at line 36 of file Variable_Creation_Parameters_c.cpp.

◆ ioda_variable_creation_parameters_clone() [2/2]

IODA_DL struct ioda_variable_creation_parameters* ioda_variable_creation_parameters_clone ( const struct ioda_variable_creation_parameters * source )

Make a copy of an existing variable creation parameters object.

Parameters

[in] source is the object to be copied.

Returns: a clone of source if source is valid.; NULL if source is invalid.

Precondition: source should be valid.

Here is the caller graph for this function:

◆ ioda_variable_creation_parameters_compressWithGZIP()

void ioda_variable_creation_parameters_compressWithGZIP	(	struct ioda_variable_creation_parameters *	params,
		int	level
	)

Compress with GZIP.

Parameters

[in]	params	is the parameters object.
	level	is the compression level [0-9]. Nine is the highest level, but it is also the slowest. One is the lowest level. Zero denotes no compression, but the GZIP filter is still turned on. To disable, call ioda_variable_creation_parameters_noCompress instead.

Precondition: params must be valid.; level ranges from zero to nine, inclusive.

Definition at line 68 of file Variable_Creation_Parameters_c.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ioda_variable_creation_parameters_compressWithSZIP()

void ioda_variable_creation_parameters_compressWithSZIP	(	struct ioda_variable_creation_parameters *	params,
		unsigned	PixelsPerBlock,
		unsigned	options
	)