mirror/netcdf-c
2
0
Fork 0
mirror of https://github.com/Unidata/netcdf-c.git synced 2025-02-17 16:50:18 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated doxygen and texinfo documentation for nc_var_copy function.

Browse Source
This commit is contained in:
Russ Rew 2012-12-13 18:00:03 +00:00
parent 5f2eb8afbf
commit 068b35cb4d
2 changed files with 30 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
libdispatch/dcopy.c
View File

@ -227,16 +227,24 @@ NC_find_equal_type(int ncid1, nc_type xtype1, int ncid2, nc_type *xtype2)
#endif /* USE_NETCDF4 */
/* This will copy a variable from one file to another, assuming
dimensions in output file are already defined and have same
dimension ids.
/* This will copy a variable and its attributes from one file to
another, assuming dimensions in the output file are already defined
and have same dimension IDs and length.
This function must work even if the files are different formats,
(i.e. one old netcdf, the other hdf5-netcdf.)
This function works even if the files are different formats,
(for example, one netcdf classic, the other netcdf-4).
But if you're copying into a netcdf-3 file, from a netcdf-4 file,
you must be copying a var of one of the six netcdf-3
types. Similarly for the attributes. */
If you're copying into a classic-model file, from a netcdf-4 file,
you must be copying a variable of one of the six classic-model
types, and similarly for the attributes.
For large netCDF-3 files, this can be a very inefficient way to
copy data from one file to another, because adding a new variable
to the target file may require more space in the header and thus
result in moving data for other variables in the target file. This
is not a problem for netCDF-4 files, which support efficient
addition of variables without moving data for other variables.
*/
int
nc_copy_var(int ncid_in, int varid_in, int ncid_out)
{

26
man4/netcdf-c.texi
View File

@ -10307,21 +10307,23 @@ if (status != NC_NOERR) handle_error(status);
@findex nc_copy_var
@cindex variable, copying
This function will copy a variable from one file to another.
This function will copy a variable and its attributes from one file to
another, assuming dimensions in the output file are already defined and
have same dimension IDs and length.
It works even if the files are different formats, (i.e. classic
vs. netCDF-4/HDF5.)
This function works even if the files are different formats,
(for example, one netcdf classic, the other netcdf-4).
If you're copying into a netCDF-3 file, from a netCDF-4 file, you must
be copying a var of one of the six netCDF-3 types. Similarly for the
attributes.
If you're copying into a classic-model file, from a netcdf-4 file,
you must be copying a variable of one of the six classic-model
types, and similarly for the attributes.
For large netCDF-3 files, this can be a very inefficient way to copy
data from one file to another, because adding a new variable to the
target file may require more space in the header and thus result in
moving data for other variables in the target file. This is not a problem
for netCDF-4 files, which support efficient addition of variables
without moving data for other variables.
For large netCDF-3 files, this can be a very inefficient way to
copy data from one file to another, because adding a new variable
to the target file may require more space in the header and thus
result in moving data for other variables in the target file. This
is not a problem for netCDF-4 files, which support efficient
addition of variables without moving data for other variables.
@heading Usage