msiNcGetVarsByType ( msParam_t *  dataTypeParam,
msParam_t *  ncidParam,
msParam_t *  varidParam,
msParam_t *  ndimParam,
msParam_t *  startParam,
msParam_t *  countParam,
msParam_t *  strideParam,
msParam_t *  outParam,
ruleExecInfo_t *  rei 
)
Description:
General NETCDF variable subsetting microservice (equivalent to nc_get_vars_type API).
Module:
core
Since:
3.2
Author:
Mike Wan
Date:
2012
Example Usage:
See clients/icommands/test/rules3.0/netcdfTest1.r, netcdfTest2.r and netcdfTest3.r.
Parameters:
[in] dataTypeParam - A NcGetVarInp_MS_T, STR_MS_T or INT_MS_T. If it is a STR_MS_T or INT_MS_T, it contains dataType of the variable - valid values are defined in ncGetVarsByType.h - 1 (NC_BYTE), 2 (NC_CHAR), 3 (NC_SHORT), 4 (NC_INT), 5 (NC_FLOAT), 6 (NC_DOUBLE), 7 (NC_UBYTE), 8 (NC_USHORT), 9 (NC_UINT), 10 (NC_INT64), 11 (NC_UINT64) and 12 (NC_STRING).
[in] ncidParam - If dataTypeParam is a STR_MS_T or INT_MS_T, it is a STR_MS_T or INT_MS_T containing the ncid of the opened object.
[in] varidParam - If dataTypeParam is a STR_MS_T or INT_MS_T, it is a STR_MS_T or INT_MS_T containing the variable Id from msiNcInq or msiNcInqId.
[in] ndimParam - If dataTypeParam is a STR_MS_T or INT_MS_T, it is a STR_MS_T or INT_MS_T containing the number of dimensions (rank).
[in] startParam - If dataTypeParam is a STR_MS_T or INT_MS_T, it is a STR_MS_T or NcGetVarOut_MS_T containing info on vector of rodsLong_t with ndim length specifying the index of an element in the variable where the first of the data values will be read. For STR_MS_T input, the vector is represented by a string containing "start0%start1%start2%...%start[ndim-1]" where the start value in each dimension is separated by a '%'.
[in] countParam - same input format as startParam representing a ndim vector of 'count' values - the number of indices selected along each dimension.
[in] strideParam - same input format as startParam representing a ndim vector of 'stride' values - the interval between selected indices for each dimension.
[out] outParam - A NcGetVarOut_MS_T containing a ncGetVarOut_t struct. Elements of ncGetVarOut_t:

  • char dataType_PI[NAME_LEN] - Packing instruction of the dataType.
  • dataArray_t *dataArray - returned values of the variable. dataArray->type gives the var type; dataArray->len gives the var length; dataArray->buf contains the var values.
Returns:
integer
Return values:
status of the call. success if greater or equal 0. error if negative.
Side Effect:
none
Precondition:
none
Postcondition:
none
See also:
none
Bug:
no known bugs

Definition at line 475 of file reNetcdf.c.

Generated on Thu Oct 31 10:28:28 2013 for iRODS Documentation by  doxygen 1.6.3