OB.DAAC Logo
NASA Logo
Ocean Color Science Software

ocssw V2022
epr_field.h File Reference
#include <stdio.h>
Include dependency graph for epr_field.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  EPR_SFieldInfo
 

Functions

EPR_SFieldInfo * epr_create_field_info (EPR_EDataTypeId data_type_id, char *description, char *field_name, epr_uint num_elems, epr_uint num_bytes, epr_uint more_count, char *unit)
 
EPR_SField * epr_create_field (EPR_SFieldInfo *field_info)
 
void epr_free_field_info (EPR_SFieldInfo *field_info)
 
void epr_free_field (EPR_SField *field)
 

Function Documentation

◆ epr_create_field()

EPR_SField* epr_create_field ( EPR_SFieldInfo *  field_info)

Creates a new field instance belongs to the given record_info.

Parameters
thepointer at the field information. must not be NULL
Returns
the new field instance or NULL if an error occured.

Definition at line 147 of file epr_field.c.

◆ epr_create_field_info()

EPR_SFieldInfo* epr_create_field_info ( EPR_EDataTypeId  data_type_id,
char *  description,
char *  field_name,
epr_uint  num_elems,
epr_uint  num_bytes,
epr_uint  more_count,
char *  unit 
)

Creates the field information of the given record and returns the poiter at it.

Parameters
data_type_idthe data type identifier
descriptionthe field description
field_namethe field name
num_elemsthe number of field elements
num_bytesthe number of bytes in each element
more_countthe number of the element repetition
unitthe unit descrimtion (name)
Returns
the the pointer at the field information, or NULL if the file it is not enough memory for some field_info element.

Definition at line 52 of file epr_field.c.

◆ epr_free_field()

void epr_free_field ( EPR_SField *  field)

Frees the memory allocated by the given 'field'.

After calling this function the give field pointer should not be used anymore.

Parameters
fieldthe field to be released

Definition at line 218 of file epr_field.c.

◆ epr_free_field_info()

void epr_free_field_info ( EPR_SFieldInfo *  field_info)

Frees the memory allocated by the given 'field_info'.

After calling this function the give field_info pointer should not be used anymore.

Parameters
field_infothe field_info to be released

Definition at line 111 of file epr_field.c.