Attributes

Provides the C-style interface for ioda::Attribute objects. More...

Collaboration diagram for Attributes:

Files
file	Attribute_c.h
	C bindings for ioda::Attribute
file	Attribute_c.cpp
	C bindings for ioda::Attribute

Macros
#define	IODA_ATTRIBUTE_ISA_IMPL(funcnamestr, Type)
#define	IODA_ATTRIBUTE_WRITE(funcnamestr, Type)
#define	IODA_ATTRIBUTE_READ(funcnamestr, Type)

Functions
IODA_DL void	ioda_attribute_destruct (struct ioda_attribute *att)
	Deallocates an attribute. More...
IODA_DL struct ioda_dimensions *	ioda_attribute_get_dimensions (const struct ioda_attribute *att)
	Gets an attribute's dimensions. More...
ioda_dimensions *	ioda_attribute_get_dimensions (const ioda_attribute *att)
	C_TEMPLATE_FUNCTION_DEFINITION (ioda_attribute_isa, IODA_ATTRIBUTE_ISA_IMPL)
	C_TEMPLATE_FUNCTION_DEFINITION_NOSTR (ioda_attribute_write, IODA_ATTRIBUTE_WRITE)
IODA_DL bool	ioda_attribute_write_str (ioda_attribute *att, size_t sz, const char *const *vals)
	C_TEMPLATE_FUNCTION_DEFINITION_NOSTR (ioda_attribute_read, IODA_ATTRIBUTE_READ)
IODA_DL ioda_string_ret_t *	ioda_attribute_read_str (const ioda_attribute *att)

Detailed Description

Provides the C-style interface for ioda::Attribute objects.

Macro Definition Documentation

IODA_ATTRIBUTE_ISA_IMPL

#define IODA_ATTRIBUTE_ISA_IMPL	(		funcnamestr,
			Type
	)

Value:

  IODA_DL int funcnamestr(const ioda_attribute* att) {                                             \
    C_TRY;                                                                                         \
    Expects(att != nullptr);                                                                       \
    bool res = att->att.isA<Type>();                                                               \
    C_CATCH_AND_RETURN((res) ? 1 : 0, -1);                                                         \
  }

Definition at line 39 of file Attribute_c.cpp.

IODA_ATTRIBUTE_READ

#define IODA_ATTRIBUTE_READ	(		funcnamestr,
			Type
	)

Value:

  IODA_DL bool funcnamestr(const ioda_attribute* att, size_t sz, Type* vals) {                     \
    C_TRY;                                                                                         \
    Expects(att != nullptr);                                                                       \
    Expects(vals != nullptr);                                                                      \
    att->att.read<Type>(gsl::span<Type>(vals, sz));                                                \
    C_CATCH_AND_RETURN(true, false);                                                               \
  }

Definition at line 74 of file Attribute_c.cpp.

IODA_ATTRIBUTE_WRITE

#define IODA_ATTRIBUTE_WRITE	(		funcnamestr,
			Type
	)

Value:

  IODA_DL bool funcnamestr(ioda_attribute* att, size_t sz, const Type* vals) {                     \
    C_TRY;                                                                                         \
    Expects(att != nullptr);                                                                       \
    Expects(vals != nullptr);                                                                      \
    att->att.write<Type>(gsl::span<const Type>(vals, sz));                                         \
    C_CATCH_AND_RETURN(true, false);                                                               \
  }

Definition at line 51 of file Attribute_c.cpp.

Function Documentation

C_TEMPLATE_FUNCTION_DEFINITION()

C_TEMPLATE_FUNCTION_DEFINITION	(	ioda_attribute_isa	,
		IODA_ATTRIBUTE_ISA_IMPL
	)

C_TEMPLATE_FUNCTION_DEFINITION_NOSTR() [1/2]

C_TEMPLATE_FUNCTION_DEFINITION_NOSTR	(	ioda_attribute_read	,
		IODA_ATTRIBUTE_READ
	)

C_TEMPLATE_FUNCTION_DEFINITION_NOSTR() [2/2]

C_TEMPLATE_FUNCTION_DEFINITION_NOSTR	(	ioda_attribute_write	,
		IODA_ATTRIBUTE_WRITE
	)

ioda_attribute_destruct()

void ioda_attribute_destruct

(

struct ioda_attribute *

att

)

Deallocates an attribute.

Parameters

att	is the attribute to be destructed.

Definition at line 21 of file Attribute_c.cpp.

Here is the caller graph for this function:

ioda_attribute_get_dimensions() [1/2]

ioda_dimensions* ioda_attribute_get_dimensions

(

const ioda_attribute *

att

)

Definition at line 28 of file Attribute_c.cpp.

Here is the call graph for this function:

ioda_attribute_get_dimensions() [2/2]

IODA_DL struct ioda_dimensions* ioda_attribute_get_dimensions

(

const struct ioda_attribute *

att

)

Gets an attribute's dimensions.

Parameters

att	is the attribute.

Returns

A dimension object that contains the attribute's dimensions. Must be freed when no longer used.

Here is the caller graph for this function:

ioda_attribute_read_str()

IODA_DL ioda_string_ret_t* ioda_attribute_read_str

(

const ioda_attribute *

att

)

Definition at line 85 of file Attribute_c.cpp.

Here is the call graph for this function:

ioda_attribute_write_str()

IODA_DL bool ioda_attribute_write_str	(	ioda_attribute *	att,
		size_t	sz,
		const char *const *	vals
	)

Definition at line 62 of file Attribute_c.cpp.

Here is the call graph for this function: