Has_Attributes

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

Collaboration diagram for Has_Attributes:

Modules
	ioda_has_attributes_create
	Create a new attribute.

Files
file	Has_Attributes_c.h
	C bindings for ioda::Has_Attributes
file	Has_Attributes_c.cpp
	C bindings for ioda::Has_Attributes

Classes
struct	c_has_attributes
	Class-like encapsulation of C has_attributes functions. More...

Macros
#define	IODA_HAS_ATTRIBUTES_CREATE_IMPL(funcnamestr, Type)

Functions
IODA_DL void	ioda_has_attributes_destruct (struct ioda_has_attributes *has_atts)
	Deallocates a ioda_has_attributes_object. More...
IODA_DL struct ioda_string_ret_t *	ioda_has_attributes_list (const struct ioda_has_attributes *)
	List the names of the attributes associated with an object. More...
IODA_DL int	ioda_has_attributes_exists (const struct ioda_has_attributes *has_atts, size_t sz_name, const char *name)
	Check if an attribute exists. More...
IODA_DL bool	ioda_has_attributes_remove (struct ioda_has_attributes *has_atts, size_t sz_name, const char *name)
	Remove an attribute. More...
IODA_DL struct ioda_attribute *	ioda_has_attributes_open (const struct ioda_has_attributes *has_atts, size_t sz_name, const char *name)
	Open (access) an attribute by name. More...
IODA_DL bool	ioda_has_attributes_rename (struct ioda_has_attributes *has_atts, size_t sz_oldname, const char *oldname, size_t sz_newname, const char *newname)
	Rename an attribute. More...
ioda_string_ret_t *	ioda_has_attributes_list (const ioda_has_attributes *atts)
int	ioda_has_attributes_exists (const ioda_has_attributes *atts, size_t sz, const char *name)
ioda_attribute *	ioda_has_attributes_open (const ioda_has_attributes *atts, size_t sz, const char *name)
	C_TEMPLATE_FUNCTION_DEFINITION (ioda_has_attributes_create, IODA_HAS_ATTRIBUTES_CREATE_IMPL)

Detailed Description

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

Macro Definition Documentation

IODA_HAS_ATTRIBUTES_CREATE_IMPL

#define IODA_HAS_ATTRIBUTES_CREATE_IMPL	(		funcnamestr,
			Type
	)

Value:

  IODA_DL ioda_attribute* funcnamestr(ioda_has_attributes* has_atts, size_t sz_name,               \
                                      const char* name, size_t n_dims, const long* dims) {         \
    ioda_attribute* res = nullptr;                                                                 \
    C_TRY;                                                                                         \
    Expects(has_atts != nullptr);                                                                  \
    Expects(name != nullptr);                                                                      \
    Expects(dims != nullptr);                                                                      \
    std::vector<ioda::Dimensions_t> vdims(n_dims);                                                 \
    for (size_t i = 0; i < n_dims; ++i) vdims[i] = (ioda::Dimensions_t)dims[i];                    \
    res = new ioda_attribute;                                                                      \
    Expects(res != nullptr);                                                                       \
    res->att = has_atts->atts.create<Type>(std::string(name, sz_name), vdims);                     \
    C_CATCH_RETURN_FREE(res, nullptr, res);                                                        \
  }

Definition at line 75 of file Has_Attributes_c.cpp.

Function Documentation

C_TEMPLATE_FUNCTION_DEFINITION()

C_TEMPLATE_FUNCTION_DEFINITION	(	ioda_has_attributes_create	,
		IODA_HAS_ATTRIBUTES_CREATE_IMPL
	)

ioda_has_attributes_destruct()

void ioda_has_attributes_destruct

(

struct ioda_has_attributes *

has_atts

)

Deallocates a ioda_has_attributes_object.

Parameters

has_atts

is the object.

Definition at line 20 of file Has_Attributes_c.cpp.

Here is the caller graph for this function:

ioda_has_attributes_exists() [1/2]

int ioda_has_attributes_exists	(	const ioda_has_attributes *	atts,
		size_t	sz,
		const char *	name
	)

Definition at line 37 of file Has_Attributes_c.cpp.

Here is the call graph for this function:

ioda_has_attributes_exists() [2/2]

IODA_DL int ioda_has_attributes_exists	(	const struct ioda_has_attributes *	has_atts,
		size_t	sz_name,
		const char *	name
	)

Check if an attribute exists.

Parameters

[in]	has_atts	is the base container of the attributes.
[in]	name	is the candidate attribute name.
	sz_name	is strlen(name). Needed for Fortran compatability.

Returns

1 if the attribute exists.

0 if the attribute does not exist.

-1 on failure, such as when a precondition is invalid.

Precondition

has_atts must be valid.

name must be valid.

Here is the caller graph for this function:

ioda_has_attributes_list() [1/2]

ioda_string_ret_t* ioda_has_attributes_list

(

const ioda_has_attributes *

atts

)

Definition at line 27 of file Has_Attributes_c.cpp.

Here is the call graph for this function:

ioda_has_attributes_list() [2/2]

IODA_DL struct ioda_string_ret_t* ioda_has_attributes_list

(

const struct ioda_has_attributes *

)

List the names of the attributes associated with an object.

Here is the caller graph for this function:

ioda_has_attributes_open() [1/2]

ioda_attribute* ioda_has_attributes_open	(	const ioda_has_attributes *	atts,
		size_t	sz,
		const char *	name
	)

Definition at line 53 of file Has_Attributes_c.cpp.

Here is the call graph for this function:

ioda_has_attributes_open() [2/2]

IODA_DL struct ioda_attribute* ioda_has_attributes_open	(	const struct ioda_has_attributes *	has_atts,
		size_t	sz_name,
		const char *	name
	)

Open (access) an attribute by name.

Parameters

[in]	has_atts	is the container of the attribute.
[in]	name	is the attribute name.
	sz_name	is strlen(name). Fortran compatability.

Returns

A handle to the attribute on success.

NULL on error.

Precondition

has_atts must be valid.

name must be a valid attribute name. The attribute must exist.

Here is the caller graph for this function:

ioda_has_attributes_remove()

bool ioda_has_attributes_remove	(	struct ioda_has_attributes *	has_atts,
		size_t	sz_name,
		const char *	name
	)

Remove an attribute.

Parameters

[in]	has_atts	is the container of the attribute.
[in]	name	is the attribute name.
	sz_name	is strlen(name). Fortran compatability.

Returns

true if the attribute is successfully removed.

false on error.

Precondition

has_atts must be valid.

name must be a valid attribute name. The attribute must exist.

The attribute must not be opened (have a valid handle) elsewhere.

Postcondition

The attribute no longer exists.

Definition at line 45 of file Has_Attributes_c.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

ioda_has_attributes_rename()

bool ioda_has_attributes_rename	(	struct ioda_has_attributes *	has_atts,
		size_t	sz_oldname,
		const char *	oldname,
		size_t	sz_newname,
		const char *	newname
	)

Rename an attribute.

Parameters

[in]	has_atts	is the container of the attribute.
	oldname	is the current name of the attribute.
	sz_oldname	is strlen(oldname). Fortran compatability.
	newname	is the desired name of the attribute.
	sz_newname	is strlen(newname). Fortran compatability.

Returns

True on success.

False on error.

Precondition

has_atts must be valid.

oldname must be a valid attribute name. The attribute must exist.

newname must be a valid attribute name. An attribute with this name must not already exist.

Definition at line 65 of file Has_Attributes_c.cpp.

Here is the call graph for this function:

Here is the caller graph for this function: