NuSDaS Interface Reference Manual

NUSDAS_INQ_DATA

Note that this function is provided only in pnusdas.

SYNOPSIS

/* C */
    int
nusdas_inq_data(type1, type2, type3, btime, memb, vtime1, plane1, elem,
  param, value, vsize)

    int
nusdas_inq_data2(type1, type2, type3, btime, memb, vtime1, vtime2,
  plane1, plane2, elem, param, value, vsize)

! Fortran
SUBROUTINE NUSDAS_INQ_DATA(type1, type2, type3, btime, memb, vtime1, &
  plane1, elem, param, value, vsize, iostat)

SUBROUTINE NUSDAS_INQ_DATA2(type1, type2, type3, btime, memb, &
  vtime1, vtime2, plane1, plane2, elem, param, value, vsize, iostat)

See Data Identifier in the Interface about arguments from type1 to elem.

symbolFortranC
param(should be constant/macro defined in header file)
value(may be various type)void *
vsizeINTEGERN_SI4 *
iostatINTEGER, INTENT(OUT)(not used)

DESCRIPTION

This subroutine inquires metadata about the DATA record. Use NUSDAS_INQ_CNTL or NUSDAS_GRID to inquire about CNTL record, and use NUSDAS_INQ_DEF about definition file.

ARGUMENTS

param

may be following values

N_GRID_SIZE

Grid size of the DATA record will be stored at value.

N_PC_PACKING

Four letters indicating Packing Type will be stored at value. Note that the symbol N_PACKING is absent in header file of the operational version.

N_MISSING_MODE

Four letters indicating missing value handling will be stored at value. Possible values are NONE, UDFV, or MASK. See missing miss_mode in the Definition File Format documentation. Note that the symbol N_PACKING is absent in header file of the operational version.

N_MISSING_VALUE

Missing value of the DATA record will be stored at value. This query is available only when previous query of N_MISSING_MODE returns UDFV.

value

array to which parameter will be stored.

vsize

number of elements (not byte size) of array value.

RETURN VALUE

>= 0Succeeded. Value is number of array elements retrieved.
-1Error: size of value array insufficient.
-2Error: value array not allocated (???)
-3Error: invalid argument.
-10 to -99(see error code table)

see also Error Code of NuSDaS library for return code from -10 to -99.