Commit 192d7c92 authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

Docu update

parent 404776c9
......@@ -232,6 +232,10 @@ The valid {\CDI} byte order types are {\tt CDI\_BIGENDIAN} and {\tt CDI\_LITTLEE
The function {\tt streamDefVlist} defines the variable list of a stream.
To safeguard against errors by modifying the wrong vlist object,
this function makes the passed vlist object immutable.
All further vlist changes have to use the vlist object returned by streamInqVlist().
\subsubsection*{Usage}
\begin{verbatim}
......
......@@ -332,7 +332,7 @@ Standard name of the variable. The caller must allocate space for the
\subsubsection*{Result}
{\tt vlistInqVarName} returns the standard name of the variable to the parameter stdname.
{\tt vlistInqVarStdname} returns the standard name of the variable to the parameter stdname.
......
......@@ -232,6 +232,10 @@ The valid {\CDI} byte order types are {\tt CDI\_BIGENDIAN} and {\tt CDI\_LITTLEE
The function {\tt streamDefVlist} defines the variable list of a stream.
To safeguard against errors by modifying the wrong vlist object,
this function makes the passed vlist object immutable.
All further vlist changes have to use the vlist object returned by streamInqVlist().
\subsubsection*{Usage}
\begin{verbatim}
......
......@@ -337,7 +337,7 @@ Standard name of the variable. The caller must allocate space for the
\subsubsection*{Result}
{\tt vlistInqVarName} returns the standard name of the variable to the parameter stdname.
{\tt vlistInqVarStdname} returns the standard name of the variable to the parameter stdname.
......
......@@ -37,7 +37,7 @@ void cdfDefVarDeflate(int ncid, int ncvarid, int deflate_level)
if ( lwarn )
{
lwarn = FALSE;
Warning("Deflate compression failed, netCDF4 not available!");
Warning("Deflate compression failed, NetCDF4 not available!");
}
#endif
}
......@@ -48,7 +48,7 @@ int cdfDefDatatype(int datatype, int filetype)
int xtype = NC_FLOAT;
if ( datatype == DATATYPE_CPX32 || datatype == DATATYPE_CPX64 )
Error("CDI/netCDF library does not support complex numbers!");
Error("CDI/NetCDF library does not support complex numbers!");
if ( filetype == FILETYPE_NC4 )
{
......@@ -497,7 +497,7 @@ int cdfDefVar(stream_t *streamptr, int varID)
if ( lwarn )
{
lwarn = FALSE;
Warning("Deflate compression is only available for netCDF4!");
Warning("Deflate compression is only available for NetCDF4!");
}
}
}
......@@ -515,7 +515,7 @@ int cdfDefVar(stream_t *streamptr, int varID)
if ( lwarn )
{
lwarn = FALSE;
Warning("netCDF4/SZIP compression not available!");
Warning("NetCDF4/SZIP compression not available!");
}
#endif
}
......@@ -526,7 +526,7 @@ int cdfDefVar(stream_t *streamptr, int varID)
if ( lwarn )
{
lwarn = FALSE;
Warning("SZIP compression is only available for netCDF4!");
Warning("SZIP compression is only available for NetCDF4!");
}
}
}
......
......@@ -39,7 +39,7 @@ extern "C" {
#define CDI_EUFTYPE -21 /* Unsupported file type */
#define CDI_ELIBNAVAIL -22 /* xxx library not available */
#define CDI_EUFSTRUCT -23 /* Unsupported file structure */
#define CDI_EUNC4 -24 /* Unsupported netCDF4 structure */
#define CDI_EUNC4 -24 /* Unsupported NetCDF4 structure */
#define CDI_ELIMIT -99 /* Internal limits exceeded */
/* File types */
......@@ -47,10 +47,10 @@ extern "C" {
#define FILETYPE_UNDEF -1 /* Unknown/not yet defined file type */
#define FILETYPE_GRB 1 /* File type GRIB */
#define FILETYPE_GRB2 2 /* File type GRIB version 2 */
#define FILETYPE_NC 3 /* File type netCDF */
#define FILETYPE_NC2 4 /* File type netCDF version 2 (64-bit) */
#define FILETYPE_NC4 5 /* File type netCDF version 4 */
#define FILETYPE_NC4C 6 /* File type netCDF version 4 (classic) */
#define FILETYPE_NC 3 /* File type NetCDF */
#define FILETYPE_NC2 4 /* File type NetCDF version 2 (64-bit) */
#define FILETYPE_NC4 5 /* File type NetCDF version 4 */
#define FILETYPE_NC4C 6 /* File type NetCDF version 4 (classic) */
#define FILETYPE_SRV 7 /* File type SERVICE */
#define FILETYPE_EXT 8 /* File type EXTRA */
#define FILETYPE_IEG 9 /* File type IEG */
......
......@@ -13,7 +13,7 @@ const char *cdiStringError(int cdiErrno)
static const char _EUFTYPE[] = "Unsupported file type";
static const char _ELIBNAVAIL[] = "Unsupported file type (library support not compiled in)";
static const char _EUFSTRUCT[] = "Unsupported file structure";
static const char _EUNC4[] = "Unsupported netCDF4 structure";
static const char _EUNC4[] = "Unsupported NetCDF4 structure";
static const char _ELIMIT[] = "Internal limits exceeded";
switch (cdiErrno) {
......
......@@ -49,10 +49,10 @@ static const char Filetypes[][9] = {
"UNKNOWN",
"GRIB",
"GRIB2",
"netCDF",
"netCDF2",
"netCDF4",
"netCDF4c",
"NetCDF",
"NetCDF2",
"NetCDF4",
"NetCDF4c",
"SERVICE",
"EXTRA",
"IEG",
......@@ -129,7 +129,7 @@ void cdiPrintVersion(void)
fprintf(stderr, "GRIB_API library version : %s\n", gribapiLibraryVersionString());
#endif
#if defined (HAVE_LIBNETCDF)
fprintf(stderr, " netCDF library version : %s\n", cdfLibraryVersion());
fprintf(stderr, " NetCDF library version : %s\n", cdfLibraryVersion());
#endif
#if defined (HAVE_LIBHDF5)
fprintf(stderr, " HDF5 library version : %s\n", hdfLibraryVersion());
......
......@@ -746,7 +746,7 @@ open stream. Otherwise, a negative number with the error status is returned.
@EndList
@Example
Here is an example using @func{streamOpenRead} to open an existing netCDF
Here is an example using @func{streamOpenRead} to open an existing NetCDF
file named @func{foo.nc} for reading:
@Source
......@@ -828,7 +828,7 @@ open stream. Otherwise, a negative number with the error status is returned.
@EndList
@Example
Here is an example using @func{streamOpenWrite} to create a new netCDF file named @func{foo.nc} for writing:
Here is an example using @func{streamOpenWrite} to create a new NetCDF file named @func{foo.nc} for writing:
@Source
#include "cdi.h"
......
......@@ -610,7 +610,7 @@ void cdfDefVarSzip(int ncid, int ncvarid)
if ( lwarn )
{
lwarn = FALSE;
Warning("netCDF4/Szip compression not compiled in!");
Warning("NetCDF4/Szip compression not compiled in!");
}
}
else
......@@ -1701,7 +1701,7 @@ void cdfDefRgrid(stream_t *streamptr, int gridID)
{
if ( lwarn )
{
Warning("Creating a netCDF file with data on a gaussian reduced grid.");
Warning("Creating a NetCDF file with data on a gaussian reduced grid.");
Warning("The further processing of the resulting file is unsupported!");
lwarn = FALSE;
}
......@@ -3590,7 +3590,7 @@ void cdfScanVarAttributes(int nvars, ncvar_t *ncvars, ncdim_t *ncdims,
if ( warn )
{
warn = FALSE;
Warning("netCDF attribute grid_type='%s' unsupported!", attstring);
Warning("NetCDF attribute grid_type='%s' unsupported!", attstring);
}
}
......@@ -3629,7 +3629,7 @@ void cdfScanVarAttributes(int nvars, ncvar_t *ncvars, ncdim_t *ncdims,
if ( warn )
{
warn = FALSE;
Warning("netCDF attribute level_type='%s' unsupported!", attstring);
Warning("NetCDF attribute level_type='%s' unsupported!", attstring);
}
}
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment