MtkGridAttrList.c

Go to the documentation of this file.

/*===========================================================================
=                                                                           =
=                             MtkGridAttrList                               =
=                                                                           =
=============================================================================

                         Jet Propulsion Laboratory
                                   MISR
                               MISR Toolkit

            Copyright 2006, California Institute of Technology.
                           ALL RIGHTS RESERVED.
                 U.S. Government Sponsorship acknowledged.

============================================================================*/

#include "MisrFileQuery.h"
#include "MisrError.h"
#include <mfhdf.h>
#include <HdfEosDef.h>
#include <stdlib.h>
#include <string.h>

MTKt_status MtkGridAttrList(
  const char *filename,    
  const char *gridname,    
  int *num_attrs,          
  char **attrlist[]         )
{
  MTKt_status status;      /* Return status */

  status = MtkGridAttrListNC(filename, gridname, num_attrs, attrlist); // try netCDF
  if (status != MTK_NETCDF_OPEN_FAILED) return status;

  return MtkGridAttrListHDF(filename, gridname, num_attrs, attrlist); // try HDF
}

MTKt_status MtkGridAttrListNC(
  const char *filename,    
  const char *gridname,    
  int *num_attrs,          
  char **attrlist[]         )
{
  MTKt_status status_code; /* Return status of this function */
  MTKt_status status;      /* Return status */

  if (filename == NULL) return MTK_NULLPTR;

  /* Open file */
  int ncid = 0;
  {
    int nc_status = nc_open(filename, NC_NOWRITE, &ncid);
    if (nc_status != NC_NOERR) MTK_ERR_CODE_JUMP(MTK_NETCDF_OPEN_FAILED);
  }

  /* Read grid attribute */
  status = MtkGridAttrListNcid(ncid, gridname, num_attrs, attrlist);
  MTK_ERR_COND_JUMP(status);

  /* Close file */
  {
    int nc_status = nc_close(ncid);
    if (nc_status != NC_NOERR) MTK_ERR_CODE_JUMP(MTK_NETCDF_CLOSE_FAILED);
  }
  ncid = 0;

  return MTK_SUCCESS;

 ERROR_HANDLE:
  if (ncid != 0) nc_close(ncid);
  return status_code;
}

MTKt_status MtkGridAttrListHDF(
  const char *filename,    
  const char *gridname,    
  int *num_attrs,          
  char **attrlist[]         )
{
  MTKt_status status_code; /* Return status of this function */
  MTKt_status status;      /* Return status */
  int32 hdfstatus;         /* HDF-EOS return status */
  int32 fid = FAIL;    /* HDF-EOS File id */

  if (filename == NULL)
    MTK_ERR_CODE_JUMP(MTK_NULLPTR);

  /* Open HDF File */
  fid = GDopen((char*)filename, DFACC_READ);
  if (fid == FAIL)
    MTK_ERR_CODE_JUMP(MTK_HDFEOS_GDOPEN_FAILED);

  /* Get list of grid attributes. */
  status = MtkGridAttrListFid(fid, gridname, num_attrs, attrlist);
  MTK_ERR_COND_JUMP(status);

  /* Close HDF file */
  hdfstatus = GDclose(fid);
  if (hdfstatus == FAIL)
    MTK_ERR_CODE_JUMP(MTK_HDFEOS_GDCLOSE_FAILED);
  fid = FAIL;

  return MTK_SUCCESS;

ERROR_HANDLE:
  if (fid != FAIL)
    GDclose(fid);

  return status_code;
}

MTKt_status MtkGridAttrListFid(
  int32 fid,               
  const char *gridname,    
  int *num_attrs,          
  char **attrlist[]         )
{
  MTKt_status status_code; /* Return status of this function */
  int32 hdfstatus;         /* HDF-EOS return status */
  int32 gid = FAIL;    /* HDF-EOS Grid id */
  int32 nattrs = 0;        /* Number of attributes */
  int32 count;
  char **attrlist_tmp = NULL;
  char *list = NULL;
  char *temp = NULL;
  int i;

  if (gridname == NULL || 
      num_attrs == NULL || attrlist == NULL)
    MTK_ERR_CODE_JUMP(MTK_NULLPTR);

  /* Attach to Grid */
  gid = GDattach(fid, (char*)gridname);
  if (gid == FAIL)
    MTK_ERR_CODE_JUMP(MTK_HDFEOS_GDATTACH_FAILED);

  /* Get buffer size */  
  hdfstatus = GDinqattrs(gid,NULL,&count);
  if (hdfstatus == FAIL)
    MTK_ERR_CODE_JUMP(MTK_HDFEOS_GDINQATTRS_FAILED);

  list = (char*)malloc((count + 1) * sizeof(char));
  if (list == NULL)
    MTK_ERR_CODE_JUMP(MTK_MALLOC_FAILED);

  /* Get grid attributes */
  hdfstatus = nattrs = GDinqattrs(gid,list,&count);
  if (hdfstatus == FAIL)
    MTK_ERR_CODE_JUMP(MTK_HDFEOS_GDINQATTRS_FAILED);

  /* Detach from grid */
  hdfstatus = GDdetach(gid);
  if (hdfstatus == FAIL)
    MTK_ERR_CODE_JUMP(MTK_HDFEOS_GDDETACH_FAILED);

  attrlist_tmp = (char**)calloc(nattrs,sizeof(char*));
  if (attrlist_tmp == NULL)
    MTK_ERR_CODE_JUMP(MTK_CALLOC_FAILED);
    
  temp = strtok(list,",");
  i = 0;
  while (temp != NULL)
  {
    attrlist_tmp[i] = (char*)malloc((strlen(temp) + 1) * sizeof(char));
    if (attrlist_tmp[i] == NULL)
      MTK_ERR_CODE_JUMP(MTK_MALLOC_FAILED);
    strcpy(attrlist_tmp[i],temp);
    temp = strtok(NULL,",");
    ++i;
  }

  free(list);

  *attrlist = attrlist_tmp;
  *num_attrs = nattrs;

  return MTK_SUCCESS;

ERROR_HANDLE:
  if (attrlist_tmp != NULL)
    MtkStringListFree(nattrs, &attrlist_tmp);

  if (num_attrs != NULL)
    *num_attrs = -1;

  free(list);
  GDdetach(gid);

  return status_code;
}

MTKt_status MtkGridAttrListNcid(
  int ncid,               
  const char *gridname,    
  int *num_attrs,          
  char **attrlist[]         )
{
  MTKt_status status_code; /* Return status of this function */
  int32 nattrs = 0;        /* Number of attributes */
  char **attrlist_tmp = NULL;

  if (gridname == NULL || 
      num_attrs == NULL || attrlist == NULL)
    MTK_ERR_CODE_JUMP(MTK_NULLPTR);

  int group_id;
  {
    int nc_status = nc_inq_ncid(ncid, gridname, &group_id); 
    if (nc_status != NC_NOERR) MTK_ERR_CODE_JUMP(MTK_NETCDF_READ_FAILED);

    nc_status = nc_inq_varnatts(group_id, NC_GLOBAL, &nattrs); 
    if (nc_status != NC_NOERR) MTK_ERR_CODE_JUMP(MTK_NETCDF_READ_FAILED);
  }

  attrlist_tmp = (char**)calloc(nattrs,sizeof(char*));
  if (attrlist_tmp == NULL)
    MTK_ERR_CODE_JUMP(MTK_CALLOC_FAILED);

  for (int i = 0; i < nattrs; ++i) {
    char attr_name[NC_MAX_NAME+1];
    int nc_status = nc_inq_attname(group_id, NC_GLOBAL, i, attr_name);
    if (nc_status != NC_NOERR) MTK_ERR_CODE_JUMP(MTK_NETCDF_READ_FAILED);

    attrlist_tmp[i] = (char*)malloc((strlen(attr_name) + 1) * sizeof(char));
    if (attrlist_tmp[i] == NULL)
      MTK_ERR_CODE_JUMP(MTK_MALLOC_FAILED);
    strcpy(attrlist_tmp[i],attr_name);
  }
    
  *attrlist = attrlist_tmp;
  *num_attrs = nattrs;

  return MTK_SUCCESS;

ERROR_HANDLE:
  if (attrlist_tmp != NULL)
    MtkStringListFree(nattrs, &attrlist_tmp);

  if (num_attrs != NULL)
    *num_attrs = -1;

  return status_code;
}