mirror of
https://github.com/Unidata/netcdf-c.git
synced 2024-12-03 08:01:25 +08:00
156 lines
4.5 KiB
C
156 lines
4.5 KiB
C
/*! \file
|
|
Functions for netCDF-4 features.
|
|
|
|
Copyright 2010 University Corporation for Atmospheric
|
|
Research/Unidata. See \ref copyright file for more info. */
|
|
|
|
#include "ncdispatch.h"
|
|
|
|
/** \defgroup groups Groups
|
|
|
|
NetCDF-4 added support for hierarchical groups within netCDF datasets.
|
|
|
|
Groups are identified with a ncid, which identifies both the open
|
|
file, and the group within that file. When a file is opened with
|
|
nc_open or nc_create, the ncid for the root group of that file is
|
|
provided. Using that as a starting point, users can add new groups, or
|
|
list and navigate existing groups or rename a group.
|
|
|
|
All netCDF calls take a ncid which determines where the call will take
|
|
its action. For example, the nc_def_var function takes a ncid as its
|
|
first parameter. It will create a variable in whichever group its ncid
|
|
refers to. Use the root ncid provided by nc_create or nc_open to
|
|
create a variable in the root group. Or use nc_def_grp to create a
|
|
group and use its ncid to define a variable in the new group.
|
|
|
|
Variable are only visible in the group in which they are defined. The
|
|
same applies to attributes. “Global” attributes are associated with
|
|
the group whose ncid is used.
|
|
|
|
Dimensions are visible in their groups, and all child groups.
|
|
|
|
Group operations are only permitted on netCDF-4 files - that is, files
|
|
created with the HDF5 flag in nc_create(). Groups are not compatible
|
|
with the netCDF classic data model, so files created with the
|
|
::NC_CLASSIC_MODEL file cannot contain groups (except the root group).
|
|
|
|
Encoding both the open file id and group id in a single integer
|
|
currently limits the number of groups per netCDF-4 file to no more
|
|
than 32767. Similarly, the number of simultaneously open netCDF-4
|
|
files in one program context is limited to 32767.
|
|
|
|
*/
|
|
/** \{ */
|
|
|
|
int nc_inq_ncid(int ncid, const char *name, int *grp_ncid)
|
|
{
|
|
NC* ncp;
|
|
int stat = NC_check_id(ncid,&ncp);
|
|
if(stat != NC_NOERR) return stat;
|
|
return ncp->dispatch->inq_ncid(ncid,name,grp_ncid);
|
|
}
|
|
|
|
int nc_inq_grps(int ncid, int *numgrps, int *ncids)
|
|
{
|
|
NC* ncp;
|
|
int stat = NC_check_id(ncid,&ncp);
|
|
if(stat != NC_NOERR) return stat;
|
|
return ncp->dispatch->inq_grps(ncid,numgrps,ncids);
|
|
}
|
|
|
|
int nc_inq_grpname(int ncid, char *name)
|
|
{
|
|
NC* ncp;
|
|
int stat = NC_check_id(ncid,&ncp);
|
|
if(stat != NC_NOERR) return stat;
|
|
return ncp->dispatch->inq_grpname(ncid,name);
|
|
}
|
|
|
|
int nc_inq_grpname_full(int ncid, size_t *lenp, char *full_name)
|
|
{
|
|
NC* ncp;
|
|
int stat = NC_check_id(ncid,&ncp);
|
|
if(stat != NC_NOERR) return stat;
|
|
return ncp->dispatch->inq_grpname_full(ncid,lenp,full_name);
|
|
}
|
|
|
|
int nc_inq_grpname_len(int ncid, size_t *lenp)
|
|
{
|
|
int stat = nc_inq_grpname_full(ncid,lenp,NULL);
|
|
return stat;
|
|
}
|
|
|
|
int nc_inq_grp_parent(int ncid, int *parent_ncid)
|
|
{
|
|
NC* ncp;
|
|
int stat = NC_check_id(ncid,&ncp);
|
|
if(stat != NC_NOERR) return stat;
|
|
return ncp->dispatch->inq_grp_parent(ncid,parent_ncid);
|
|
}
|
|
|
|
/*! This has same semantics as nc_inq_ncid
|
|
|
|
*/
|
|
int nc_inq_grp_ncid(int ncid, const char *grp_name, int *grp_ncid)
|
|
{
|
|
return nc_inq_ncid(ncid,grp_name,grp_ncid);
|
|
}
|
|
|
|
int nc_inq_grp_full_ncid(int ncid, const char *full_name, int *grp_ncid)
|
|
{
|
|
NC* ncp;
|
|
int stat = NC_check_id(ncid,&ncp);
|
|
if(stat != NC_NOERR) return stat;
|
|
return ncp->dispatch->inq_grp_full_ncid(ncid,full_name,grp_ncid);
|
|
}
|
|
|
|
int nc_inq_varids(int ncid, int *nvars, int *varids)
|
|
{
|
|
NC* ncp;
|
|
int stat = NC_check_id(ncid,&ncp);
|
|
if(stat != NC_NOERR) return stat;
|
|
return ncp->dispatch->inq_varids(ncid,nvars,varids);
|
|
}
|
|
|
|
int nc_inq_dimids(int ncid, int *ndims, int *dimids, int include_parents)
|
|
{
|
|
NC* ncp;
|
|
int stat = NC_check_id(ncid,&ncp);
|
|
if(stat != NC_NOERR) return stat;
|
|
return ncp->dispatch->inq_dimids(ncid,ndims,dimids,include_parents);
|
|
}
|
|
|
|
int nc_inq_typeids(int ncid, int *ntypes, int *typeids)
|
|
{
|
|
NC* ncp;
|
|
int stat = NC_check_id(ncid,&ncp);
|
|
if(stat != NC_NOERR) return stat;
|
|
return ncp->dispatch->inq_typeids(ncid,ntypes,typeids);
|
|
}
|
|
|
|
int nc_def_grp(int parent_ncid, const char *name, int *new_ncid)
|
|
{
|
|
NC* ncp;
|
|
int stat = NC_check_id(parent_ncid,&ncp);
|
|
if(stat != NC_NOERR) return stat;
|
|
return ncp->dispatch->def_grp(parent_ncid,name,new_ncid);
|
|
}
|
|
|
|
int nc_rename_grp(int grpid, const char *name)
|
|
{
|
|
NC* ncp;
|
|
int stat = NC_check_id(grpid,&ncp);
|
|
if(stat != NC_NOERR) return stat;
|
|
return ncp->dispatch->rename_grp(grpid,name);
|
|
}
|
|
|
|
int nc_show_metadata(int ncid)
|
|
{
|
|
NC* ncp;
|
|
int stat = NC_check_id(ncid,&ncp);
|
|
if(stat != NC_NOERR) return stat;
|
|
return ncp->dispatch->show_metadata(ncid);
|
|
}
|
|
|
|
/** \} */
|