libncds3  1.8
 All Data Structures Files Functions Variables Typedefs Enumerations Macros Groups
Functions
Inquire Function Wrappers

Functions

int ncds_inq_att (int grpid, int varid, const char *attname, nc_type *type, size_t *length)
 Get information about an attribute in a NetCDF variable or group.
int ncds_inq_attname (int grpid, int varid, int attid, char *attname)
 Get the name of an attribute in a NetCDF variable or group.
int ncds_inq_dim (int grpid, int dimid, char *dimname, size_t *length)
 Get information about a dimension in a NetCDF group.
int ncds_inq_dimid (int grpid, const char *dimname, int *dimid)
 Get the id of a dimension in a NetCDF group.
int ncds_inq_dimids (int grpid, int *ndims, int *dimids, int include_parents)
 Get the ids for all the dimensions in a NetCDF group.
int ncds_inq_dimlen (int grpid, int dimid, size_t *length)
 Get the length of a dimension in a NetCDF group.
int ncds_inq_dimname (int grpid, int dimid, char *dimname)
 Get the name of a dimension in a NetCDF group.
int ncds_inq_grpid (int grpid, const char *subgrpname, int *subgrpid)
 Get the id of a subgroup in a NetCDF group.
int ncds_inq_grpids (int grpid, int *nsubgrps, int *subgrpids)
 Get the ids for all the subgroups in a NetCDF group.
int ncds_inq_grpname (int grpid, char *grpname)
 Get the name of a NetCDF group.
int ncds_inq_natts (int grpid, int *natts)
 Get the number of attributes in a NetCDF group.
int ncds_inq_ndims (int grpid, int *ndims)
 Get the number of dimensions visible from a NetCDF group.
int ncds_inq_var (int grpid, int varid, char *varname, nc_type *type, int *ndims, int *dimids, int *natts)
 Get information about a variable in a NetCDF group.
int ncds_inq_vardimids (int grpid, int varid, int *dimids)
 Get the ids for all dimensions used by a variable in a NetCDF group.
int ncds_inq_varid (int grpid, const char *varname, int *varid)
 Get the id of a variable in a NetCDF group.
int ncds_inq_varids (int grpid, int *nvars, int *varids)
 Get the ids for all the variables in a NetCDF group.
int ncds_inq_varname (int grpid, int varid, char *varname)
 Get the name of a variable in a NetCDF group.
int ncds_inq_varndims (int grpid, int varid, int *ndims)
 Get the number of dimensions for a variable in a NetCDF group.
int ncds_inq_vartype (int grpid, int varid, nc_type *vartype)
 Get the type of a variable in a NetCDF group.
int ncds_inq_unlimdims (int grpid, int *nunlimdims, int *unlimdimids)
 Get the ids for all unlimited dimensions in a NetCDF group.

Detailed Description

Function Documentation

int ncds_inq_att ( int  grpid,
int  varid,
const char *  attname,
nc_type *  type,
size_t *  length 
)

Get information about an attribute in a NetCDF variable or group.

Error messages from this function are sent to the message handler (see msngr_init_log() and msngr_init_mail()).

Parameters:
grpid- group id
varid- variable id or NC_GLOBAL for global attributes
attname- attribute name
type- output: attrubute data type
length- output: length of the attribute value
Returns:
  • 1 if successful
  • 0 if the attribute was not found
  • -1 if an error occured

Definition at line 59 of file ncwrap_inquire.c.

int ncds_inq_attname ( int  grpid,
int  varid,
int  attid,
char *  attname 
)

Get the name of an attribute in a NetCDF variable or group.

Error messages from this function are sent to the message handler (see msngr_init_log() and msngr_init_mail()).

Parameters:
grpid- group id
varid- variable id or NC_GLOBAL for global attributes
attid- attribute id
attname- output: attribute name (this should be declared to have a length of at least NC_MAX_NAME + 1 characters)
Returns:
  • 1 if successful
  • 0 if an error occured

Definition at line 100 of file ncwrap_inquire.c.

int ncds_inq_dim ( int  grpid,
int  dimid,
char *  dimname,
size_t *  length 
)

Get information about a dimension in a NetCDF group.

Error messages from this function are sent to the message handler (see msngr_init_log() and msngr_init_mail()).

Parameters:
grpid- group id
dimid- dimension id
dimname- output: dimension name (this should be declared to have a length of at least NC_MAX_NAME + 1 characters)
length- output: dimension length
Returns:
  • 1 if successful
  • 0 if an error occured

Definition at line 135 of file ncwrap_inquire.c.

int ncds_inq_dimid ( int  grpid,
const char *  dimname,
int *  dimid 
)

Get the id of a dimension in a NetCDF group.

Error messages from this function are sent to the message handler (see msngr_init_log() and msngr_init_mail()).

Parameters:
grpid- group id
dimname- dimension name
dimid- output: dimension id
Returns:
  • 1 if successful
  • 0 if the dimension was not found
  • -1 if an error occured

Definition at line 168 of file ncwrap_inquire.c.

int ncds_inq_dimids ( int  grpid,
int *  ndims,
int *  dimids,
int  include_parents 
)

Get the ids for all the dimensions in a NetCDF group.

Error messages from this function are sent to the message handler (see msngr_init_log() and msngr_init_mail()).

Parameters:
grpid- group id
ndims- output: number of dimensions
dimids- output: dimension ids (this should be declared to have a length of at least NC_MAX_DIMS)
include_parents- if non-zero then all the dimensions in all parent groups will also be retrieved.
Returns:
  • 1 if successful
  • 0 if an error occured

Definition at line 208 of file ncwrap_inquire.c.

int ncds_inq_dimlen ( int  grpid,
int  dimid,
size_t *  length 
)

Get the length of a dimension in a NetCDF group.

Error messages from this function are sent to the message handler (see msngr_init_log() and msngr_init_mail()).

Parameters:
grpid- group id
dimid- dimension id
length- output: dimension length
Returns:
  • 1 if successful
  • 0 if an error occured

Definition at line 240 of file ncwrap_inquire.c.

int ncds_inq_dimname ( int  grpid,
int  dimid,
char *  dimname 
)

Get the name of a dimension in a NetCDF group.

Error messages from this function are sent to the message handler (see msngr_init_log() and msngr_init_mail()).

Parameters:
grpid- group id
dimid- dimension id
dimname- output: dimension name (this should be declared to have a length of at least NC_MAX_NAME + 1 characters)
Returns:
  • 1 if successful
  • 0 if an error occured

Definition at line 274 of file ncwrap_inquire.c.

int ncds_inq_grpid ( int  grpid,
const char *  subgrpname,
int *  subgrpid 
)

Get the id of a subgroup in a NetCDF group.

Error messages from this function are sent to the message handler (see msngr_init_log() and msngr_init_mail()).

Parameters:
grpid- group id
subgrpname- subgroup name
subgrpid- output: subgroup id
Returns:
  • 1 if successful
  • 0 if the subgroup was not found
  • -1 if an error occured

Definition at line 342 of file ncwrap_inquire.c.

int ncds_inq_grpids ( int  grpid,
int *  nsubgrps,
int *  subgrpids 
)

Get the ids for all the subgroups in a NetCDF group.

Error messages from this function are sent to the message handler (see msngr_init_log() and msngr_init_mail()).

Parameters:
grpid- group id
nsubgrps- output: number of subgroups
subgrpids- output: subgroup ids

Note: Specify NULL for subgrpids to get the number of subgroups. This can then be used to allocate memory for the subgroup ids array.

Returns:
  • 1 if successful
  • 0 if an error occured

Definition at line 309 of file ncwrap_inquire.c.

int ncds_inq_grpname ( int  grpid,
char *  grpname 
)

Get the name of a NetCDF group.

Error messages from this function are sent to the message handler (see msngr_init_log() and msngr_init_mail()).

Parameters:
grpid- group id
grpname- output: group name (this should be declared to have a length of at least NC_MAX_NAME + 1 characters)
Returns:
  • 1 if successful
  • 0 if an error occured

Definition at line 379 of file ncwrap_inquire.c.

int ncds_inq_natts ( int  grpid,
int *  natts 
)

Get the number of attributes in a NetCDF group.

Error messages from this function are sent to the message handler (see msngr_init_log() and msngr_init_mail()).

Parameters:
grpid- group id
natts- output: number of attributes
Returns:
  • 1 if successful
  • 0 if an error occured

Definition at line 410 of file ncwrap_inquire.c.

int ncds_inq_ndims ( int  grpid,
int *  ndims 
)

Get the number of dimensions visible from a NetCDF group.

Error messages from this function are sent to the message handler (see msngr_init_log() and msngr_init_mail()).

Parameters:
grpid- group id
ndims- output: number of dimensions
Returns:
  • 1 if successful
  • 0 if an error occured

Definition at line 441 of file ncwrap_inquire.c.

int ncds_inq_unlimdims ( int  grpid,
int *  nunlimdims,
int *  unlimdimids 
)

Get the ids for all unlimited dimensions in a NetCDF group.

Error messages from this function are sent to the message handler (see msngr_init_log() and msngr_init_mail()).

Parameters:
grpid- group id
nunlimdims- output: number of unlimited dimensions
unlimdimids- output: unlimited dimension ids (this should be declared to have a length of at least NC_MAX_DIMS)
Returns:
  • 1 if successful
  • 0 if an error occured

Definition at line 720 of file ncwrap_inquire.c.

int ncds_inq_var ( int  grpid,
int  varid,
char *  varname,
nc_type *  type,
int *  ndims,
int *  dimids,
int *  natts 
)

Get information about a variable in a NetCDF group.

Error messages from this function are sent to the message handler (see msngr_init_log() and msngr_init_mail()).

Parameters:
grpid- group id
varid- variable id
varname- output: variable name (this should be declared to have a length of at least NC_MAX_NAME + 1 characters)
type- output: variable data type
ndims- output: number of variable dimensions
dimids- output: variable dimension ids (this should be declared to have a length of at least NC_MAX_DIMS)
natts- output: number of variable attributes
Returns:
  • 1 if successful
  • 0 if an error occured

Definition at line 481 of file ncwrap_inquire.c.

int ncds_inq_vardimids ( int  grpid,
int  varid,
int *  dimids 
)

Get the ids for all dimensions used by a variable in a NetCDF group.

Error messages from this function are sent to the message handler (see msngr_init_log() and msngr_init_mail()).

Parameters:
grpid- group id
varid- variable id
dimids- output: variable dimension ids (this should be declared to have a length of at least NC_MAX_DIMS)
Returns:
  • 1 if successful
  • 0 if an error occured

Definition at line 517 of file ncwrap_inquire.c.

int ncds_inq_varid ( int  grpid,
const char *  varname,
int *  varid 
)

Get the id of a variable in a NetCDF group.

Error messages from this function are sent to the message handler (see msngr_init_log() and msngr_init_mail()).

Parameters:
grpid- group id
varname- variable name
varid- output: variable id
Returns:
  • 1 if successful
  • 0 if the variable was not found
  • -1 if an error occured

Definition at line 550 of file ncwrap_inquire.c.

int ncds_inq_varids ( int  grpid,
int *  nvars,
int *  varids 
)

Get the ids for all the variables in a NetCDF group.

Error messages from this function are sent to the message handler (see msngr_init_log() and msngr_init_mail()).

Parameters:
grpid- group id
nvars- output: number of variables
varids- output: variable ids (this should be declared to have a length of at least NC_MAX_VARS)
Returns:
  • 1 if successful
  • 0 if an error occured

Definition at line 588 of file ncwrap_inquire.c.

int ncds_inq_varname ( int  grpid,
int  varid,
char *  varname 
)

Get the name of a variable in a NetCDF group.

Error messages from this function are sent to the message handler (see msngr_init_log() and msngr_init_mail()).

Parameters:
grpid- group id
varid- variable id
varname- output: variable name (this should be declared to have a length of at least NC_MAX_NAME + 1 characters)
Returns:
  • 1 if successful
  • 0 if an error occured

Definition at line 622 of file ncwrap_inquire.c.

int ncds_inq_varndims ( int  grpid,
int  varid,
int *  ndims 
)

Get the number of dimensions for a variable in a NetCDF group.

Error messages from this function are sent to the message handler (see msngr_init_log() and msngr_init_mail()).

Parameters:
grpid- group id
varid- variable id
ndims- output: number of variable dimensions
Returns:
  • 1 if successful
  • 0 if an error occured

Definition at line 654 of file ncwrap_inquire.c.

int ncds_inq_vartype ( int  grpid,
int  varid,
nc_type *  vartype 
)

Get the type of a variable in a NetCDF group.

Error messages from this function are sent to the message handler (see msngr_init_log() and msngr_init_mail()).

Parameters:
grpid- group id
varid- variable id
vartype- output: variable type
Returns:
  • 1 if successful
  • 0 if an error occured

Definition at line 686 of file ncwrap_inquire.c.