Variable_c.h File Reference
C bindings for ioda::Variable More...
#include <stdbool.h>#include "../defs.h"#include "./Has_Attributes_c.h"#include "./String_c.h"#include "./c_binding_macros.h"
Include dependency graph for Variable_c.h:
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Classes | |
| struct | c_variable |
| Class-like encapsulation of C variable functions. More... | |
Macros | |
| #define | IODA_VARIABLE_ISA_TEMPLATE(funcnamestr, junk) IODA_DL int funcnamestr(const struct ioda_variable* var); |
| See ioda_variable_isa . More... | |
| #define | IODA_VARIABLE_WRITE_FULL_TEMPLATE(funcnamestr, Type) IODA_DL bool funcnamestr(struct ioda_variable* var, size_t sz, const Type* vals); |
| See ioda_variable_write_full . More... | |
| #define | IODA_VARIABLE_READ_FULL_TEMPLATE(funcnamestr, Type) IODA_DL bool funcnamestr(const struct ioda_variable* var, size_t sz, Type* vals); |
| See ioda_variable_read_full . More... | |
| #define | IODA_VARIABLE_ISA_FUNC_TEMPLATE(shortnamestr, basenamestr) int (*shortnamestr)(const struct ioda_variable*); |
| #define | IODA_VARIABLE_WRITE_FULL_FUNC_TEMPLATE(shortnamestr, basenamestr, Type) bool (*shortnamestr)(struct ioda_variable*, size_t, const Type*); |
| #define | IODA_VARIABLE_READ_FULL_FUNC_TEMPLATE(shortnamestr, basenamestr, Type) bool (*shortnamestr)(const struct ioda_variable*, size_t, Type*); |
Functions | |
| IODA_DL void | ioda_variable_destruct (struct ioda_variable *var) |
| Deallocates an variable. More... | |
| IODA_DL struct ioda_has_attributes * | ioda_variable_atts (const struct ioda_variable *var) |
| Access a variable's attributes. More... | |
| IODA_DL struct ioda_dimensions * | ioda_variable_get_dimensions (const struct ioda_variable *) |
| Gets an variable's dimensions. More... | |
| IODA_DL bool | ioda_variable_resize (struct ioda_variable *var, size_t N, const long *newDims) |
| Resize a variable. More... | |
| IODA_DL bool | ioda_variable_attachDimensionScale (struct ioda_variable *var, unsigned int DimensionNumber, const struct ioda_variable *scale) |
| Attach a dimension scale to a variable. More... | |
| IODA_DL bool | ioda_variable_detachDimensionScale (struct ioda_variable *var, unsigned int DimensionNumber, const struct ioda_variable *scale) |
| Detach a dimension scale from a variable. More... | |
| IODA_DL bool | ioda_variable_setDimScale (struct ioda_variable *var, size_t n_dims, const struct ioda_variable *const *dims) |
| Convenience function to set a sequence of scales on a variable. More... | |
| IODA_DL int | ioda_variable_isDimensionScale (const struct ioda_variable *var) |
| Check if a variable acts as a dimension scale. More... | |
| IODA_DL bool | ioda_variable_setIsDimensionScale (struct ioda_variable *var, size_t sz_name, const char *dimensionScaleName) |
| Convert a variable into a dimension scale. More... | |
| IODA_DL size_t | ioda_variable_getDimensionScaleName (const struct ioda_variable *var, size_t len_out, char *out) |
| Get the name of the dimension scale. More... | |
| IODA_DL int | ioda_variable_isDimensionScaleAttached (const struct ioda_variable *var, unsigned int DimensionNumber, const struct ioda_variable *scale) |
| Is the variable "scale" attached as dimension "DimensionNumber" to variable "var"? More... | |
| C_TEMPLATE_FUNCTION_DECLARATION (ioda_variable_isa, IODA_VARIABLE_ISA_TEMPLATE) | |
| C_TEMPLATE_FUNCTION_DEFINITION_NOSTR (ioda_variable_write_full, IODA_VARIABLE_WRITE_FULL_TEMPLATE) | |
| IODA_DL bool | ioda_variable_write_full_str (struct ioda_variable *var, size_t sz, const char *const *vals) |
| Write a sequence of strings to a variable. More... | |
| C_TEMPLATE_FUNCTION_DEFINITION_NOSTR (ioda_variable_read_full, IODA_VARIABLE_READ_FULL_TEMPLATE) | |
| IODA_DL struct ioda_string_ret_t * | ioda_variable_read_full_str (const struct ioda_variable *var) |
| Read strings from a variable. More... | |
Detailed Description
Definition in file Variable_c.h.
Macro Definition Documentation
◆ IODA_VARIABLE_ISA_FUNC_TEMPLATE
| #define IODA_VARIABLE_ISA_FUNC_TEMPLATE | ( | shortnamestr, | |
| basenamestr | |||
| ) | int (*shortnamestr)(const struct ioda_variable*); |
Definition at line 279 of file Variable_c.h.
◆ IODA_VARIABLE_READ_FULL_FUNC_TEMPLATE
| #define IODA_VARIABLE_READ_FULL_FUNC_TEMPLATE | ( | shortnamestr, | |
| basenamestr, | |||
| Type | |||
| ) | bool (*shortnamestr)(const struct ioda_variable*, size_t, Type*); |
Definition at line 291 of file Variable_c.h.
◆ IODA_VARIABLE_WRITE_FULL_FUNC_TEMPLATE
| #define IODA_VARIABLE_WRITE_FULL_FUNC_TEMPLATE | ( | shortnamestr, | |
| basenamestr, | |||
| Type | |||
| ) | bool (*shortnamestr)(struct ioda_variable*, size_t, const Type*); |
Definition at line 284 of file Variable_c.h.
