OB.DAAC Logo
NASA Logo
Ocean Color Science Software

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

Go to the source code of this file.

Classes

struct  ODL_LIST_TYPE
 

Macros

#define IAS_ODL_NOT_ENOUGH_MEMORY_SUPPLIED   2
 
#define IAS_ODL_NOT_FOUND   3
 
#define IAS_ODL_INVALID_DATA_TYPE   4
 

Enumerations

enum  IAS_ODL_FIELD_FUNCTION { IAS_ODL_ADD, IAS_ODL_REPLACE }
 
enum  IAS_ODL_TYPE {
  IAS_ODL_Double, IAS_ODL_ArrayOfString, IAS_ODL_String, IAS_ODL_Int,
  IAS_ODL_Long, IAS_ODL_Float, IAS_ODL_Sci_Not
}
 

Functions

IAS_OBJ_DESC * ias_odl_create_tree ()
 
void ias_odl_write_tree (IAS_OBJ_DESC *ODLTree, char *p_ODLFile)
 
IAS_OBJ_DESC * ias_odl_add_group (IAS_OBJ_DESC *ODLTree, const char *p_ClassName)
 
int ias_odl_add_field (IAS_OBJ_DESC *ODLTree, const char *p_LabelName, IAS_ODL_TYPE ValueType, const int p_MemorySize, void *p_MemoryAddr, const int nelements)
 
int ias_odl_replace_field (IAS_OBJ_DESC *ODLTree, const char *p_LabelName, IAS_ODL_TYPE ValueType, const int p_MemorySize, void *p_MemoryAddr, const int nelements)
 
int ias_odl_add_field_list (IAS_OBJ_DESC *p_ODLTree, ODL_LIST_TYPE *p_ListParms, const int Count)
 
IAS_OBJ_DESC * ias_odl_read_tree (const char *p_ODLFile)
 
void ias_odl_free_tree (IAS_OBJ_DESC *p_lp)
 
int ias_odl_get_field (void *p_MemoryAddr, int MemorySize, IAS_ODL_TYPE ValueType, IAS_OBJ_DESC *p_ODLTree, const char *p_ClassName, const char *p_LabelName, int *p_Count)
 
int ias_odl_get_field_list (IAS_OBJ_DESC *p_ODLTree, ODL_LIST_TYPE *p_ListParms, const int Count)
 
IAS_OBJ_DESC * ias_odl_get_group (IAS_OBJ_DESC *ODLTree, const char *p_ClassName)
 
int ias_odl_get_group_names (IAS_OBJ_DESC *p_ODLTree, char ***p_ClassNames, int *p_Count)
 
IAS_OBJ_DESC * ias_odl_parse_file (char *label_fname, FILE *label_fptr)
 
IAS_OBJ_DESC * ias_odl_parse_label_string (char *odl_string)
 
IAS_OBJ_DESC * ias_odl_find_object_description (IAS_OBJ_DESC *start_object, const char *object_class, const char *keyword_name, char *keyword_value, unsigned long object_position)
 
IAS_ODL_KEYWORD * ias_odl_find_keyword (IAS_OBJ_DESC *start_object, const char *keyword_name, char *keyword_value, unsigned long keyword_position)
 

Macro Definition Documentation

◆ IAS_ODL_INVALID_DATA_TYPE

#define IAS_ODL_INVALID_DATA_TYPE   4

Definition at line 10 of file ias_odl.h.

◆ IAS_ODL_NOT_ENOUGH_MEMORY_SUPPLIED

#define IAS_ODL_NOT_ENOUGH_MEMORY_SUPPLIED   2

Definition at line 8 of file ias_odl.h.

◆ IAS_ODL_NOT_FOUND

#define IAS_ODL_NOT_FOUND   3

Definition at line 9 of file ias_odl.h.

Enumeration Type Documentation

◆ IAS_ODL_FIELD_FUNCTION

Enumerator
IAS_ODL_ADD 
IAS_ODL_REPLACE 

Definition at line 19 of file ias_odl.h.

◆ IAS_ODL_TYPE

Enumerator
IAS_ODL_Double 
IAS_ODL_ArrayOfString 
IAS_ODL_String 
IAS_ODL_Int 
IAS_ODL_Long 
IAS_ODL_Float 
IAS_ODL_Sci_Not 

Definition at line 27 of file ias_odl.h.

Function Documentation

◆ ias_odl_add_field()

int ias_odl_add_field ( IAS_OBJ_DESC *  ODLTree,
const char *  p_LabelName,
IAS_ODL_TYPE  ValueType,
const int  p_MemorySize,
void *  p_MemoryAddr,
const int  nelements 
)

◆ ias_odl_add_field_list()

int ias_odl_add_field_list ( IAS_OBJ_DESC *  p_ODLTree,
ODL_LIST_TYPE p_ListParms,
const int  Count 
)

◆ ias_odl_add_group()

IAS_OBJ_DESC* ias_odl_add_group ( IAS_OBJ_DESC *  ODLTree,
const char *  p_ClassName 
)

◆ ias_odl_create_tree()

IAS_OBJ_DESC* ias_odl_create_tree ( )

◆ ias_odl_find_keyword()

IAS_ODL_KEYWORD* ias_odl_find_keyword ( IAS_OBJ_DESC *  start_object,
const char *  keyword_name,
char *  keyword_value,
unsigned long  keyword_position 
)

◆ ias_odl_find_object_description()

IAS_OBJ_DESC* ias_odl_find_object_description ( IAS_OBJ_DESC *  start_object,
const char *  object_class,
const char *  keyword_name,
char *  keyword_value,
unsigned long  object_position 
)

◆ ias_odl_free_tree()

void ias_odl_free_tree ( IAS_OBJ_DESC *  p_lp)

Definition at line 12 of file ias_odl_free_tree.c.

◆ ias_odl_get_field()

int ias_odl_get_field ( void *  p_MemoryAddr,
int  MemorySize,
IAS_ODL_TYPE  ValueType,
IAS_OBJ_DESC *  p_ODLTree,
const char *  p_ClassName,
const char *  p_LabelName,
int *  p_Count 
)

Definition at line 36 of file ias_odl_get_field.c.

◆ ias_odl_get_field_list()

int ias_odl_get_field_list ( IAS_OBJ_DESC *  p_ODLTree,
ODL_LIST_TYPE p_ListParms,
const int  Count 
)

◆ ias_odl_get_group()

IAS_OBJ_DESC* ias_odl_get_group ( IAS_OBJ_DESC *  ODLTree,
const char *  p_ClassName 
)

◆ ias_odl_get_group_names()

int ias_odl_get_group_names ( IAS_OBJ_DESC *  p_ODLTree,
char ***  p_ClassNames,
int *  p_Count 
)

◆ ias_odl_parse_file()

IAS_OBJ_DESC* ias_odl_parse_file ( char *  label_fname,
FILE *  label_fptr 
)

◆ ias_odl_parse_label_string()

IAS_OBJ_DESC* ias_odl_parse_label_string ( char *  odl_string)

◆ ias_odl_read_tree()

IAS_OBJ_DESC* ias_odl_read_tree ( const char *  p_ODLFile)

Definition at line 25 of file ias_odl_read_tree.c.

◆ ias_odl_replace_field()

int ias_odl_replace_field ( IAS_OBJ_DESC *  ODLTree,
const char *  p_LabelName,
IAS_ODL_TYPE  ValueType,
const int  p_MemorySize,
void *  p_MemoryAddr,
const int  nelements 
)

◆ ias_odl_write_tree()

void ias_odl_write_tree ( IAS_OBJ_DESC *  ODLTree,
char *  p_ODLFile 
)