ioda_has_variables_create

Create a new variable. More...

Collaboration diagram for ioda_has_variables_create:

Macros
#define	IODA_HAS_VARIABLES_CREATE_TEMPLATE(funcnamestr, junk)
	See ioda_has_variables_create . More...

Functions
	C_TEMPLATE_FUNCTION_DECLARATION (ioda_has_variables_create, IODA_HAS_VARIABLES_CREATE_TEMPLATE)

Detailed Description

Create a new variable.

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. Ex:, to create an integer variable, call ioda_has_variables_create_int.

Template Parameters

SUFFIX

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

Parameters

has_vars[in]	is the container of the variable.
name[in]	is the name of the new variable. This name must not already exist.
sz_name	is strlen(name). Fortran compatability.
n_dims	is the dimensionality of the new variable.
dims	is an array of dimension lengths of the new variable. The array must be of rank n_dims.
max_dims	is an array of maximum dimension lengths of the new variable. The array must be of rank n_dims.

See also

ioda_group_vars for a method to get a group's associated has_variables object.

Returns

the new variable on success.

NULL on failure.

Precondition

has_vars must be valid. The group associated with has_vars must still exist.

name must be a valid name. No other object (variable OR group) with this name should exist at this group level.

dims must be valid and have the rank of n_dims.

Postcondition

A variable of the specified name, type, and dimensions now exists.

Macro Definition Documentation

IODA_HAS_VARIABLES_CREATE_TEMPLATE

#define IODA_HAS_VARIABLES_CREATE_TEMPLATE	(		funcnamestr,
			junk
	)

Value:

  IODA_DL struct ioda_variable* funcnamestr(struct ioda_has_variables* has_vars, size_t sz_name,   \
                                            const char* name, size_t n_dims, const long* dims,     \
                                            const long* max_dims,                                  \
                                            const struct ioda_variable_creation_parameters*        \
                                              params);

See ioda_has_variables_create .

See also

ioda_has_variables_create

Definition at line 111 of file Has_Variables_c.h.

Function Documentation

C_TEMPLATE_FUNCTION_DECLARATION()

C_TEMPLATE_FUNCTION_DECLARATION	(	ioda_has_variables_create	,
		IODA_HAS_VARIABLES_CREATE_TEMPLATE
	)