The NetCDF C++ Interface Guide
******************************
This document describes the netCDF C++ API. It applies to netCDF
version 4.1.1 release of the software, but the C++ interface still only
supports the "classic" data model from the netCDF-3 release. This
document was last updated in 6 August 2008.
The netCDF library provides an application- and machine-independent
interface to self-describing, array-oriented data. It supports an
abstract view of such data as a collection of named variables and their
attributes, and provides high-level access to data that is faithful to
the abstraction. This on-line document describes the C++ interface to
netCDF. This C++ interface is still based on the classic data model
supported by netCDF-3 software; it has not yet been updated to the
enhanced data model supported by netCDF-4.
The first part of this master menu lists the major nodes in this Info
document. The rest of the menu lists all the lower level nodes in the
document.
For a complete description of the netCDF format and utilities see
*note Top: (netcdf)Top.
Introduction
************
The main requirements for the design of the C++ interface are:
* to provide the functionality of the C interface;
* to provide type safety by eliminating all use of `void*' pointers;
and
* to provide an interface that is simpler to use than the C
interface.
Some of the features of the C++ interface are:
* No IDs needed for netCDF's variables, dimensions, or attributes.
* No explicit open or close calls needed for netCDF files; a
constructor opens and a destructor closes a file.
* No need to specify types for creating attributes; they will have
the type of the value provided.
* No use of `void*': values are type-checked.
* Less indirection is needed for dimensions and dimension sizes than
with the C interface. A variable's dimensions can be provided as
arguments when defining a variable.
* Code for data types is isolated to make the addition of new types
easier.
* No explicit `ncredef' or `ncendef' calls are needed for switching
between define and data modes. Whenever a mode switch is
required, it happens implicitly.
The header file `netcdfcpp.h' must be included in source code files
using this interface.
This release provides some of the functionality of netCDF version 4,
but not for the enhanced data model introduced with netCDF-4.
This manual assumes familiarity with the netCDF User's Guide, where
the concepts of netCDF dimensions, variables, and attributes are
discussed.
Class Hierarchy
===============
The class for netCDF file objects is `NcFile'.
The components of a netCDF file are dimensions, variables, and
attributes. There is a class for each of these kinds of objects;
`NcDim', `NcVar', and `NcAtt'. Variables and attributes share some
common characteristics that are factored out in the abstract base class
`NcTypedComponent'.
An auxiliary class, `NcValues', provides a type for arrays of values
that are read from or written to netCDF files. Another auxiliary class,
`NcError', provides facilities for handling errors.
`NcFile' netCDF file
`NcDim' dimension
`NcTypedComponent' abstract base class
`NcVar' variable
`NcAtt' attribute
`NcValues' abstract base class for array
`NcValues_ncbyte' array of bytes
`NcValues_char' array of characters
`NcValues_short' array of shorts
`NcValues_int' array of ints
`NcValues_long' array of longs
`NcValues_float' array of floats
`NcValues_double' array of doubles
`NcError' for error handling
Auxiliary Types and Constants
=============================
The netCDF classes use several auxiliary types for arguments and return
types from member functions: `NcToken', `NcType', `NcBool', and
`ncbyte'.
`NcToken'
Used for names for netCDF objects, in particular variable names,
dimension names, and attribute names. Currently this is just a
typedef for `const char*'.
`NcType'
Used for specifying netCDF external value types. Currently this
is an enumerated type with the following legitimate values:
`ncByte', `ncChar', `ncShort', `ncInt', `ncLong' (deprecated),
`ncFloat', and `ncDouble'.
`NcBool'
Used for the return type of some member functions. If the member
function fails, 0 is returned, otherwise some non-zero value.
Currently this is just a typedef for `unsigned int'. It will be
changed to `bool' when all C++ compilers support the new `bool'
type.
`ncbyte'
Used to declare values of type `ncByte', for 8-bit integer data.
(This is currently a typedef for `unsigned char', but it may be
changed to a typedef for `signed char', so don't depend on the
underlying representation.)
NetCDF Classes
**************
Class NcFile
============
`NcFile' is the class for netCDF files, providing methods for netCDF
file operations.
Some member functions return pointers to dimensions (`NcDim') or
variables (`NcVar'). These objects are owned by the `NcFile' they are
associated with, and will be deleted automatically by the `NcFile'
destructor (or by the `close' member function, if this is called
earlier than the destructor), so users should not delete these. Member
functions that return pointers to attributes (`NcAtt') pass ownership
to the calling function; users should delete attributes when they are
finished with them.
Member functions that return `NcBool' yield `TRUE' on success and
`FALSE' on failure. Member functions that return a pointer value
return a `NULL' pointer on failure.
This class interface hides the distinction in the C and Fortran
interfaces between "define mode" (when dimensions, variables, or
attributes are being defined or renamed), and "data mode" (when data
values are being accessed), by automatically switching between the modes
when necessary. Be aware that switching from accessing data to adding
or renaming dimensions, variables and attributes can be expensive, since
it may entail a copy of the data.
Public Member Functions
-----------------------
`NcFile( const char * path, FileMode = ReadOnly, size_t *chunksizeptr = NULL, size_t initialsize = 0, FileFormat = Classic)'
The constructor creates a new netCDF file or opens an existing
netCDF file. The path argument may be an OPenDAP DAP URL if DAP
support is enabled.
The `FileMode' argument can be any of `ReadOnly' (the default) to
open an existing file for reading, `Write' to open an existing
file for reading or writing, `Replace' to create a new empty file
even if the named file already exists, or `New' to create a new
file only if the named file does not already exist.
The optional `FileFormat' argument can be any of `Classic' (the
default), `Offset64Bits', `Netcdf4', or `Netcdf4Classic'.
The optional `chunksizeptr' and `initialsize' tuning parameters
are as described in the corresponding `nc__create()' function in
the C interface.
The constructor will not fail, but in the case of a bad path name,
improper permissions, or if the file already exists and you have
specified `FileMode' as `New', no netCDF file will be created or
opened. If the constructor fails to create or open a netCDF file,
a subsequent call to the `is_valid()' member function will return
`False'.
`~NcFile( void )'
Destructor. The file is closed and all resources associated with
it are released, including the associated `NcVar' and `NcDim'
objects. If you wish to close the file earlier, you may
explicitly call the `close' member function; a subsequent
destructor call will work properly.
`NcBool close( void )'
Close netCDF file earlier than it would be closed by the `NcFile'
destructor.
`NcBool is_valid( void ) const'
Returns `TRUE' if valid netCDF file, `FALSE' otherwise (e.g. if
constructor could not open file).
`int num_dims( void ) const'
Returns the number of dimensions in the netCDF file.
`int num_vars( void ) const'
Returns the number of variables in the netCDF file.
`int num_atts( void ) const'
Returns the number of global attributes in the netCDF file.
`NcDim* get_dim(NcToken name) const'
Get a dimension by name.
`NcVar* get_var(NcToken name) const'
Get a variable by name.
`NcAtt* get_att(NcToken name) const'
Get a global attribute by name.
`NcDim* get_dim(int n) const'
Get the Nth dimension (beginning with the 0th).
`NcVar* get_var(int n) const'
Get the Nth variable (beginning with the 0th).
`NcAtt* get_att(int n) const'
Get the Nth global attribute (beginning with the 0th).
`NcDim* rec_dim( void ) const'
Get the unlimited dimension, if any.
The following `add_' member functions put the file in "define mode",
so could be expensive. To avoid copying of data, invoke these before
writing data to variables.
`NcDim* add_dim(NcToken dimname)'
Add an unlimited dimension named `dimname' to the netCDF file.
`NcDim* add_dim(NcToken dimname, long dimsize)'
Add a dimension named `dimname' of size `dimsize'.
`NcVar* add_var(NcToken varname, NcType type, const NcDim*, ...)'
Add a variable named `varname' of the specified type (`ncByte',
`ncChar', `ncShort', `ncInt', `ncFloat', `ncDouble') to the open
netCDF file. The variable is defined with a shape that depends on
how many dimension arguments are provided. A scalar variable
would have 0 dimensions, a vector would have 1 dimension, and so
on. Supply as many dimensions as needed, up to 5. If more than 5
dimensions are required, use the n-dimensional version of this
member function instead.
`NcVar* add_var(NcToken varname, NcType type, int ndims, const NcDim** dims)'
Add a variable named `varname' of `ndims' dimensions and of the
specified type. This method must be used when dealing with
variables of more than 5 dimensions.
`NcBool add_att(NcToken name, ncbyte val)'
`NcBool add_att(NcToken name, char val)'
`NcBool add_att(NcToken name, short val)'
`NcBool add_att(NcToken name, int val)'
`NcBool add_att(NcToken name, float val)'
`NcBool add_att(NcToken name, double val)'
Add global scalar attributes of the specified name and with the
supplied value.
`NcBool add_att(NcToken name, const char* val)'
Add global string-valued attribute with the specified name and C
string value (terminated with a `\0' character).
`NcBool add_att(NcToken name, int n, const ncbyte* val)'
`NcBool add_att(NcToken name, int n, const char* val)'
`NcBool add_att(NcToken name, int n, const short* val)'
`NcBool add_att(NcToken name, int n, const int* val)'
`NcBool add_att(NcToken name, int n, const float* val)'
`NcBool add_att(NcToken name, int n, const double* val)'
Add global vector attributes with the specified name, length, and
values.
`NcBool set_fill(FillMode mode = Fill)'
Sets fill-mode to either `NcFile::Fill' or `NcFile::NoFill'.
Default is `Fill', in which case unwritten values are pre-written
with appropriate type-specific or variable-specific fill values.
`enum NcFile::FillMode get_fill( void ) const'
Returns fill mode of the file, either `NcFile::Fill' or
`NcFile::NoFill'.
`enum NcFile::FileFormat get_format( void ) const'
Returns format version of the file, either `NcFile::Classic',
`NcFile:Offset64Bits', `NcFile:Netcdf4', or
`NcFile::Netcdf4Classic'.
`NcBool sync( void )'
Synchronizes file to disk. This flushes buffers so that readers
of the file will see recent changes.
`NcBool abort( void )'
Either just closes file (if recently it has been in data mode as
the result of accessing data), or backs out of the most recent
sequence of changes to the file schema (dimensions, variables, and
attributes).
Class NcDim
===========
A netCDF dimension has a name and a size. Dimensions are only created
and destroyed by NcFile member functions, because they cannot exist
independently of an open netCDF file. Hence there are no public
constructors or destructors.
Public Member Functions
-----------------------
`NcToken name( void ) const'
Returns the name of the dimension if it exists, 0 otherwise.
`long size( void ) const'
Returns the dimension size.
`NcBool is_valid( void ) const'
Returns `TRUE' if file and dimension are both valid, `FALSE'
otherwise.
`NcBool is_unlimited( void ) const'
Returns `TRUE' if the dimension is the unlimited dimension,
`FALSE' if either not a valid netCDF file, or if the dimension is
not the unlimited dimension.
`NcBool rename( NcToken newname )'
Renames the dimension to `newname'.
`NcBool sync( void )'
If the dimension may have been renamed, make sure its name is
updated.
Class NcTypedComponent
======================
`NcTypedComponent' is an abstract base class for `NcVar' and `NcAtt'
that captures the similarities between netCDF variables and attributes.
We list here the member functions that variables and attributes inherit
from `NcTypedComponent', but these member functions are also documented
under the `NcVar' and `NcAtt' classes for convenience.
Public Member Functions
-----------------------
`NcToken name( void ) const'
Returns the name of the variable or attribute.
`NcType type( void ) const'
Returns the type of the variable or attribute. The type will be
one of `ncByte', `ncChar', `ncShort', `ncInt', `ncFloat', or
`ncDouble'.
`NcBool is_valid( void ) const'
Returns `TRUE' if the component is valid, `FALSE' otherwise.
`long num_vals( void ) const'
Returns the number of values for an attribute or variable. For an
attribute, this is just 1 for a scalar attribute, the number of
values for a vector-valued attribute, and the number of characters
for a string-valued attribute. For a variable, this is the
product of the dimension sizes for all the variable's dimensions.
`NcBool rename( NcToken newname )'
Renames the variable or attribute.
`NcValues* values( void ) const'
Returns a pointer to the block of all values for the variable or
attribute. The caller is responsible for deleting this block of
values when no longer needed, as well as the pointer returned by
the `values' method. Note that this is not a good way to read
selected values of a variable; use the `get' member function
instead, to get single values or selected cross-sections of values.
`ncbyte as_ncbyte( int n ) const'
`char as_char( int n ) const'
`short as_short( int n ) const'
`int as_int( int n ) const'
`nclong as_nclong( int n ) const // deprecated'
`long as_long( int n ) const'
`float as_float( int n ) const'
`double as_double( int n ) const'
`char* as_string( int n ) const'
Get the n-th value of the attribute or variable. These member
functions provide conversions from the value type of the variable
or attribute to the specified type. If the value is out-of-range,
the fill-value of the appropriate type is returned.
Class NcVar
===========
`NcVar' is derived from NcTypedComponent, and represents a netCDF
variable. A netCDF variable has a name, a type, a shape, zero or more
attributes, and a block of values associated with it. Because variables
are only associated with open netCDF files, there are no public
constructors for this class. Use member functions of `NcFile' to get
variables or add new variables.
Public Member Functions
-----------------------
`NcToken name( void ) const'
Returns the name of the variable.
`NcType type( void ) const'
Returns the type of the variable. The type will be one of
`ncByte', `ncChar', `ncShort', `ncInt', `ncFloat', or `ncDouble'.
`int num_dims( void ) const'
Returns number of dimensions for this variable.
`NcDim* get_dim( int n ) const'
Returns a pointer to the n-th dimension (starting at 0). Returns a
NULL-pointer if an invalid dimension is requested.
`long* edges( void ) const'
Returns the shape of the variable, in the form of a vector
containing the sizes of the dimensions of the variable. The
caller is responsible for deleting the returned edge vector when
no longer needed.
`int num_atts( void ) const'
Returns the number of attributes attached to the variable.
`NcAtt* get_att( NcToken attname ) const'
`NcAtt* get_att( int n ) const'
The first member function returns a variable attribute by name.
The second returns the n-th (starting at 0) attribute of the
variable. In either case, if no such attribute has been attached
to the variable, zero is returned. Attributes returned in this
way belong to the caller, and hence should eventually be deleted
by the caller to avoid memory leaks.
`NcBool is_valid( void ) const'
Returns `TRUE' if the variable is valid, `FALSE' otherwise.
`long num_vals( void ) const'
Returns the number of values for a variable. This is just 1 for a
scalar variable, or the product of the dimension sizes for all the
variable's dimensions.
`NcValues* values( void ) const'
Returns a pointer to the block of all values for the variable.
The caller is responsible for deleting this block of values when
no longer needed. Note that this is not a good way to read
selected values of a variable; use the `get' member function
instead, to get single values or selected cross-sections of values.
`NcBool put(const ncbyte* vals, long c0, long c1, long c2, long c3, long c4)'
`NcBool put(const char* vals, long c0, long c1, long c2, long c3, long c4)'
`NcBool put(const short* vals, long c0, long c1, long c2, long c3, long c4)'
`NcBool put(const int* vals, long c0, long c1, long c2, long c3, long c4)'
`NcBool put(const long* vals, long c0, long c1, long c2, long c3, long c4)'
`NcBool put(const float* vals, long c0, long c1, long c2, long c3, long c4)'
`NcBool put(const double* vals, long c0, long c1, long c2, long c3, long c4)'
Write scalar or 1 to 5-dimensional arrays by providing enough
arguments. Arguments are edge lengths, and their number must not
exceed variable's dimensionality. Start corner is `[0,0,..., 0]'
by default, but may be reset using the `set_cur()' member function
for this variable. `FALSE' is returned if type of values does not
match type for variable. For more than 5 dimensions, use the
overloaded n-dimensional form of the `put' member function.
`NcBool put(const ncbyte* vals, const long* counts)'
`NcBool put(const char* vals, const long* counts)'
`NcBool put(const short* vals, const long* counts)'
`NcBool put(const int* vals, const long* counts)'
`NcBool put(const long* vals, const long* counts)'
`NcBool put(const float* vals, const long* counts)'
`NcBool put(const double* vals, const long* counts)'
Write n-dimensional arrays, starting at `[0, 0, ..., 0]' by
default, may be reset with `set_cur()'. `FALSE' is returned if
type of values does not match type for variable.
`NcBool get(ncbyte* vals, long c0, long c1, long c2, long c3, long c4) const'
`NcBool get(char* vals, long c0, long c1, long c2, long c3, long c4) const'
`NcBool get(short* vals, long c0, long c1, long c2, long c3, long c4) const'
`NcBool get(int* vals, long c0, long c1, long c2, long c3, long c4) const'
`NcBool get(long* vals, long c0, long c1, long c2, long c3, long c4) const'
`NcBool get(float* vals, long c0, long c1, long c2, long c3, long c4) const'
`NcBool get(double* vals, long c0, long c1, long c2, long c3, long c4) const'
Get scalar or 1 to 5 dimensional arrays by providing enough
arguments. Arguments are edge lengths, and their number must not
exceed variable's dimensionality. Start corner is `[0,0,..., 0]'
by default, but may be reset using the `set_cur()' member
function. `FALSE' is returned if type of values does not match
type for variable.
`NcBool get(ncbyte* vals, const long* counts) const'
`NcBool get(char* vals, const long* counts) const'
`NcBool get(short* vals, const long* counts) const'
`NcBool get(int* vals, const long* counts) const'
`NcBool get(long* vals, const long* counts) const'
`NcBool get(float* vals, const long* counts) const'
`NcBool get(double* vals, const long* counts) const'
Get n-dimensional arrays, starting at `[0, 0, ..., 0]' by default,
may be reset with `set_cur()' member function. `FALSE' is
returned if type of values does not match type for variable.
`NcBool set_cur(long c0=-1, long c1=-1, long c2=-1, long c3=-1, long c4=-1)'
`NcBool set_cur(long* cur)'
Resets the starting corner to the values supplied. The first form
works for a variable of dimensionality from scalar to 5
dimensions. For more than five dimensions, use the second form,
in which the number of longs supplied must match the rank of the
variable. The method returns FALSE if any argument is greater
than the size of the corresponding dimension.
`NcBool add_att( NcToken, char )'
`NcBool add_att( NcToken, ncbyte )'
`NcBool add_att( NcToken, short )'
`NcBool add_att( NcToken, int )'
`NcBool add_att( NcToken, long )'
`NcBool add_att( NcToken, float )'
`NcBool add_att( NcToken, double )'
`NcBool add_att( NcToken, const char* )'
`NcBool add_att( NcToken, int, const char* )'
`NcBool add_att( NcToken, int, const ncbyte* )'
`NcBool add_att( NcToken, int, const short* )'
`NcBool add_att( NcToken, int, const int* )'
`NcBool add_att( NcToken, int, const long* )'
`NcBool add_att( NcToken, int, const float* )'
`NcBool add_att( NcToken, int, const double* )'
Add scalar or vector attribute of any type to a variable, given the
name, number of values, and the vector of values. These put file
in define mode, so could be expensive. To avoid the expense of
copying data, add attributes to variables before writing data.
`NcBool rename( NcToken newname )'
Renames the variable. If variable is renamed to a longer name,
this puts file in define mode, so could be expensive.
`ncbyte as_ncbyte( int n ) const'
`char as_char( int n ) const'
`short as_short( int n ) const'
`int as_int( int n ) const'
`nclong as_nclong( int n ) const // deprecated'
`long as_long( int n ) const'
`float as_float( int n ) const'
`double as_double( int n ) const'
`char* as_string( int n ) const'
Get the n-th value of the variable, ignoring its shape. These
member functions provide conversions from the value type of the
variable to the specified type. If the requested value is
out-of-range, the fill-value of the appropriate type is returned.
`int id( void ) const'
Return the variable number. This is not needed in the C++
interface, but might be needed in calling a C-function that
requires that a variable be identified by number instead of name.
`NcBool sync( void )'
If the variable may have been renamed, make sure its name is
updated.
`~NcVar( void )'
Destructor.
The following member functions are intended for record variables.
They will also work for non-record variables, if the first dimension is
interpreted as the record dimension.
`long rec_size( void )'
`long rec_size( NcDim* )'
Return the number of values per record or the number of values per
dimension slice for the specified dimension.
`NcValues* get_rec( void )'
`NcValues* get_rec( long n )'
Get the data for this variable for the current record or for the
Nth record.
`NcValues* get_rec( NcDim* )'
`NcValues* get_rec( NcDim*, long n )'
Get the data for this variable for the current dimension slice or
for the Nth dimension slice.
`NcBool put_rec( const ncbyte* vals )'
`NcBool put_rec( const char* vals )'
`NcBool put_rec( const short* vals )'
`NcBool put_rec( const int* vals )'
`NcBool put_rec( const long* vals )'
`NcBool put_rec( const float* vals )'
`NcBool put_rec( const double* vals )'
Put a record's worth of data for this variable in the current
record.
`NcBool put_rec( NcDim*, const ncbyte* vals )'
`NcBool put_rec( NcDim*, const char* vals )'
`NcBool put_rec( NcDim*, const short* vals )'
`NcBool put_rec( NcDim*, const int* vals )'
`NcBool put_rec( NcDim*, const long* vals )'
`NcBool put_rec( NcDim*, const float* vals )'
`NcBool put_rec( NcDim*, const double* vals )'
Put a dimension slice worth of data for this variable in the
current dimension slice.
`NcBool put_rec( const ncbyte* vals, long rec )'
`NcBool put_rec( const char* vals, long rec )'
`NcBool put_rec( const short* vals, long rec )'
`NcBool put_rec( const int* vals, long rec )'
`NcBool put_rec( const long* vals, long rec )'
`NcBool put_rec( const float* vals, long rec )'
`NcBool put_rec( const double* vals, long rec )'
Put a record's worth of data for this variable in the specified
record.
`NcBool put_rec( NcDim*, const ncbyte* vals, long slice )'
`NcBool put_rec( NcDim*, const char* vals, long slice )'
`NcBool put_rec( NcDim*, const short* vals, long slice )'
`NcBool put_rec( NcDim*, const int* vals, long slice )'
`NcBool put_rec( NcDim*, const long* vals, long slice )'
`NcBool put_rec( NcDim*, const float* vals, long slice )'
`NcBool put_rec( NcDim*, const double* vals, long slice )'
Put a dimension slice worth of data for this variable in the
specified dimension slice.
`long get_index( const ncbyte* vals )'
`long get_index( const char* vals )'
`long get_index( const short* vals )'
`long get_index( const int* vals )'
`long get_index( const long* vals )'
`long get_index( const float* vals )'
`long get_index( const double* vals )'
Get first record index for this variable corresponding to the
specified key value(s).
`long get_index( NcDim*, const ncbyte* vals )'
`long get_index( NcDim*, const char* vals )'
`long get_index( NcDim*, const short* vals )'
`long get_index( NcDim*, const int* vals )'
`long get_index( NcDim*, const long* vals )'
`long get_index( NcDim*, const float* vals )'
`long get_index( NcDim*, const double* vals )'
Get first index of specified dimension for this variable
corresponding to the specified key value(s).
`void set_rec ( long rec )'
Set the current record for this variable.
`void set_rec ( NcDim*, long rec )'
Set the current dimension slice for the specified dimension for
this variable.
Class NcAtt
===========
`NcAtt' is derived from `NcTypedComponent', and represents a netCDF
attribute. A netCDF attribute has a name and a type, and may be either
a scalar attribute or a vector attribute. Scalar attributes have one
value and vector attributes have multiple values. In addition, each
attribute is attached to a specific netCDF variable or is global to an
entire netCDF file. Because attributes are only associated with open
netCDF files, there are no public constructors for this class. Use
member functions of `NcFile' and `NcVar' to get netCDF attributes or
add new attributes. Most of the useful member functions for `NcAtt' are
inherited from class `NcTypedComponent'.
Public Member Functions
-----------------------
`NcToken name( void ) const'
Returns the name of the attribute.
`NcType type( void ) const'
Returns the type of the attribute. The type will be one of
`ncByte', `ncChar', `ncShort', `ncInt', `ncFloat', or `ncDouble'.
`NcBool is_valid( void ) const'
Returns `TRUE' if the attribute is valid, `FALSE' otherwise.
`long num_vals( void ) const'
Returns the number of values for an attribute. This is just 1 for
a scalar attribute, the number of values for a vector-valued
attribute, and the number of characters for a string-valued
attribute.
`NcBool rename( NcToken newname )'
Renames the attribute.
`NcValues* values( void ) const'
Returns a pointer to the block of all values for the attribute.
The caller is responsible for deleting this block of values when
no longer needed.
`ncbyte as_ncbyte( int n ) const'
`char as_char( int n ) const'
`short as_short( int n ) const'
`int as_int( int n ) const'
`nclong as_nclong( int n ) const // deprecated'
`long as_long( int n ) const'
`float as_float( int n ) const'
`double as_double( int n ) const'
`char* as_string( int n ) const'
Get the n-th value of the attribute. These member functions
provide conversions from the value type of the attribute to the
specified type. If the value is out-of-range, the fill-value of
the appropriate type is returned.
`NcBool remove( void )'
Deletes the attribute from the file and detaches it from the
variable. Does not call the destructor. Subsequent calls to
`is_valid()' will return `FALSE'.
`~NcAtt( void )'
Destructor.
Auxiliary Classes
*****************
Auxiliary classes include the abstract base class `NcValues', its
type-specific derived subclasses, and the error-handling class
`NcError'.
Class NcValues
==============
Class `NcValues' is an abstract base class for a block of typed values.
The derived classes are `NcValues_ncbyte', `NcValues_char',
`NcValues_short', `NcValues_int', `NcValues_nclong' (deprecated), and
`NcValues_long', `NcValues_float', `NcValues_double'. These classes
are used as the return type of the `NcTypedComponent::values()' member
function, for typed-value arrays associated with variables and
attributes.
Public Member Functions
-----------------------
`NcValues( void )'
Default constructor.
`NcValues(NcType, long)'
Constructor for a value block of the specified type and length.
`~NcValues( void )'
Destructor.
`long num( void )'
Returns the number of values in the value block.
`ostream& print(ostream&) const'
Used to print the comma-delimited sequence of values of the value
block.
`void* base( void ) const'
Returns a bland pointer to the beginning of the value block.
`int bytes_for_one( void ) const'
Returns the number of bytes required for one value.
`ncbyte as_ncbyte( int n ) const'
`char as_char( int n ) const'
`short as_short( int n ) const'
`int as_int( int n ) const'
`nclong as_nclong( int n ) const // deprecated'
`long as_long( int n ) const'
`float as_float( int n ) const'
`double as_double( int n ) const'
`char* as_string( int n ) const'
Provide conversions for the nth value from the value type to a
desired basic type. If the value is out of range, the default
"fill-value" for the appropriate type is returned.
Class NcError
=============
This class provides control for netCDF error handling. Declaring an
`NcError' object temporarily changes the error-handling behavior for
all netCDF classes until the `NcError' object is destroyed (typically
by going out of scope), at which time the previous error-handling
behavior is restored.
Public Member Functions
-----------------------
`NcError( Behavior b = verbose_fatal )'
The constructor saves the previous error state for restoration
when the destructor is invoked, and sets a new specified state.
Valid error states are `NcError::silent_nonfatal',
`NcError::verbose_nonfatal', `NcError::silent_fatal', or
`NcError::verbose_fatal', to control whether error messages are
output from the underlying library and whether such messages are
fatal or nonfatal.
`~NcError( void )'
Destructor, restores previous error state.
`int get_err( void )'
Returns most recent error, as enumerated in `netcdf.h'.
Index
*****
abort:
See ``Public Member Functions''. (line 304)
add_att <1>:
See ``Public Member Functions''. (line 520)
add_att:
See ``Public Member Functions''. (line 264)
add_dim:
See ``Public Member Functions''. (line 243)
add_var:
See ``Public Member Functions''. (line 249)
as_char <1>:
See ``Public Member Functions''. (line 766)
as_char <2>:
See ``Public Member Functions''. (line 701)
as_char <3>:
See ``Public Member Functions''. (line 546)
as_char:
See ``Public Member Functions''. (line 386)
as_double <1>:
See ``Public Member Functions''. (line 772)
as_double <2>:
See ``Public Member Functions''. (line 707)
as_double <3>:
See ``Public Member Functions''. (line 552)
as_double:
See ``Public Member Functions''. (line 392)
as_float <1>:
See ``Public Member Functions''. (line 771)
as_float <2>:
See ``Public Member Functions''. (line 706)
as_float <3>:
See ``Public Member Functions''. (line 551)
as_float:
See ``Public Member Functions''. (line 391)
as_int <1>:
See ``Public Member Functions''. (line 768)
as_int <2>:
See ``Public Member Functions''. (line 703)
as_int <3>:
See ``Public Member Functions''. (line 548)
as_int:
See ``Public Member Functions''. (line 388)
as_long <1>:
See ``Public Member Functions''. (line 770)
as_long <2>:
See ``Public Member Functions''. (line 705)
as_long <3>:
See ``Public Member Functions''. (line 550)
as_long:
See ``Public Member Functions''. (line 390)
as_ncbyte <1>:
See ``Public Member Functions''. (line 765)
as_ncbyte <2>:
See ``Public Member Functions''. (line 700)
as_ncbyte <3>:
See ``Public Member Functions''. (line 545)
as_ncbyte:
See ``Public Member Functions''. (line 385)
as_nclong <1>:
See ``Public Member Functions''. (line 769)
as_nclong <2>:
See ``Public Member Functions''. (line 704)
as_nclong <3>:
See ``Public Member Functions''. (line 549)
as_nclong:
See ``Public Member Functions''. (line 389)
as_short <1>:
See ``Public Member Functions''. (line 767)
as_short <2>:
See ``Public Member Functions''. (line 702)
as_short <3>:
See ``Public Member Functions''. (line 547)
as_short:
See ``Public Member Functions''. (line 387)
as_string <1>:
See ``Public Member Functions''. (line 773)
as_string <2>:
See ``Public Member Functions''. (line 708)
as_string <3>:
See ``Public Member Functions''. (line 553)
as_string:
See ``Public Member Functions''. (line 393)
auxiliary types and constants:
See ``Auxiliary Types and Constants''. (line 108)
base:
See ``Public Member Functions''. (line 759)
bytes_for_one:
See ``Public Member Functions''. (line 762)
class hierarchy:
See ``Class Hierarchy''. (line 74)
close:
See ``Public Member Functions''. (line 201)
edges:
See ``Public Member Functions''. (line 426)
get:
See ``Public Member Functions''. (line 486)
get_att <1>:
See ``Public Member Functions''. (line 435)
get_att:
See ``Public Member Functions''. (line 224)
get_dim <1>:
See ``Public Member Functions''. (line 422)
get_dim:
See ``Public Member Functions''. (line 218)
get_err:
See ``Public Member Functions''. (line 802)
get_fill:
See ``Public Member Functions''. (line 291)
get_format:
See ``Public Member Functions''. (line 295)
get_index:
See ``Public Member Functions''. (line 631)
get_rec:
See ``Public Member Functions''. (line 581)
get_var:
See ``Public Member Functions''. (line 221)
id:
See ``Public Member Functions''. (line 559)
is_unlimited:
See ``Public Member Functions''. (line 331)
is_valid <1>:
See ``Public Member Functions''. (line 683)
is_valid <2>:
See ``Public Member Functions''. (line 445)
is_valid <3>:
See ``Public Member Functions''. (line 364)
is_valid <4>:
See ``Public Member Functions''. (line 327)
is_valid:
See ``Public Member Functions''. (line 205)
name <1>:
See ``Public Member Functions''. (line 676)
name <2>:
See ``Public Member Functions''. (line 412)
name <3>:
See ``Public Member Functions''. (line 356)
name:
See ``Public Member Functions''. (line 321)
NcAtt:
See ``Public Member Functions''. (line 659)
NcAtt::remove:
See ``Public Member Functions''. (line 714)
NcAtt::~NcAtt:
See ``Public Member Functions''. (line 719)
NcBool:
See ``Auxiliary Types and Constants''. (line 123)
ncbyte:
See ``Auxiliary Types and Constants''. (line 130)
NcDim:
See ``Public Member Functions''. (line 310)
NcDim::is_unlimited:
See ``Public Member Functions''. (line 331)
NcDim::is_valid:
See ``Public Member Functions''. (line 327)
NcDim::name:
See ``Public Member Functions''. (line 321)
NcDim::rename:
See ``Public Member Functions''. (line 336)
NcDim::size:
See ``Public Member Functions''. (line 324)
NcDim::sync:
See ``Public Member Functions''. (line 339)
NcError <1>:
See ``Public Member Functions''. (line 790)
NcError:
See ``Public Member Functions''. (line 778)
NcError::get_err:
See ``Public Member Functions''. (line 802)
NcError::~NcError:
See ``Public Member Functions''. (line 799)
NcFile <1>:
See ``Public Member Functions''. (line 169)
NcFile:
See ``NetCDF Classes''. (line 139)
NcFile::abort:
See ``Public Member Functions''. (line 304)
NcFile::add_att:
See ``Public Member Functions''. (line 264)
NcFile::add_dim:
See ``Public Member Functions''. (line 243)
NcFile::add_var:
See ``Public Member Functions''. (line 249)
NcFile::close:
See ``Public Member Functions''. (line 201)
NcFile::get_att:
See ``Public Member Functions''. (line 224)
NcFile::get_dim:
See ``Public Member Functions''. (line 218)
NcFile::get_fill:
See ``Public Member Functions''. (line 291)
NcFile::get_format:
See ``Public Member Functions''. (line 295)
NcFile::get_var:
See ``Public Member Functions''. (line 221)
NcFile::is_valid:
See ``Public Member Functions''. (line 205)
NcFile::NcFile:
See ``Public Member Functions''. (line 169)
NcFile::num_atts:
See ``Public Member Functions''. (line 215)
NcFile::num_dims:
See ``Public Member Functions''. (line 209)
NcFile::num_vars:
See ``Public Member Functions''. (line 212)
NcFile::rec_dim:
See ``Public Member Functions''. (line 236)
NcFile::set_fill:
See ``Public Member Functions''. (line 286)
NcFile::sync:
See ``Public Member Functions''. (line 300)
NcFile::~NcFile:
See ``Public Member Functions''. (line 194)
NcToken:
See ``Auxiliary Types and Constants''. (line 112)
NcType:
See ``Auxiliary Types and Constants''. (line 117)
NcTypedComponent:
See ``Public Member Functions''. (line 344)
NcTypedComponent::as_char <1>:
See ``Public Member Functions''. (line 701)
NcTypedComponent::as_char <2>:
See ``Public Member Functions''. (line 546)
NcTypedComponent::as_char:
See ``Public Member Functions''. (line 386)
NcTypedComponent::as_double <1>:
See ``Public Member Functions''. (line 707)
NcTypedComponent::as_double <2>:
See ``Public Member Functions''. (line 552)
NcTypedComponent::as_double:
See ``Public Member Functions''. (line 392)
NcTypedComponent::as_float <1>:
See ``Public Member Functions''. (line 706)
NcTypedComponent::as_float <2>:
See ``Public Member Functions''. (line 551)
NcTypedComponent::as_float:
See ``Public Member Functions''. (line 391)
NcTypedComponent::as_int <1>:
See ``Public Member Functions''. (line 703)
NcTypedComponent::as_int <2>:
See ``Public Member Functions''. (line 548)
NcTypedComponent::as_int:
See ``Public Member Functions''. (line 388)
NcTypedComponent::as_long <1>:
See ``Public Member Functions''. (line 705)
NcTypedComponent::as_long <2>:
See ``Public Member Functions''. (line 550)
NcTypedComponent::as_long:
See ``Public Member Functions''. (line 390)
NcTypedComponent::as_ncbyte <1>:
See ``Public Member Functions''. (line 700)
NcTypedComponent::as_ncbyte <2>:
See ``Public Member Functions''. (line 545)
NcTypedComponent::as_ncbyte:
See ``Public Member Functions''. (line 385)
NcTypedComponent::as_nclong <1>:
See ``Public Member Functions''. (line 704)
NcTypedComponent::as_nclong <2>:
See ``Public Member Functions''. (line 549)
NcTypedComponent::as_nclong:
See ``Public Member Functions''. (line 389)
NcTypedComponent::as_short <1>:
See ``Public Member Functions''. (line 702)
NcTypedComponent::as_short <2>:
See ``Public Member Functions''. (line 547)
NcTypedComponent::as_short:
See ``Public Member Functions''. (line 387)
NcTypedComponent::as_string <1>:
See ``Public Member Functions''. (line 708)
NcTypedComponent::as_string <2>:
See ``Public Member Functions''. (line 553)
NcTypedComponent::as_string:
See ``Public Member Functions''. (line 393)
NcTypedComponent::is_valid <1>:
See ``Public Member Functions''. (line 683)
NcTypedComponent::is_valid <2>:
See ``Public Member Functions''. (line 445)
NcTypedComponent::is_valid:
See ``Public Member Functions''. (line 364)
NcTypedComponent::name <1>:
See ``Public Member Functions''. (line 676)
NcTypedComponent::name <2>:
See ``Public Member Functions''. (line 412)
NcTypedComponent::name:
See ``Public Member Functions''. (line 356)
NcTypedComponent::num_vals <1>:
See ``Public Member Functions''. (line 686)
NcTypedComponent::num_vals <2>:
See ``Public Member Functions''. (line 448)
NcTypedComponent::num_vals:
See ``Public Member Functions''. (line 367)
NcTypedComponent::rename <1>:
See ``Public Member Functions''. (line 692)
NcTypedComponent::rename <2>:
See ``Public Member Functions''. (line 541)
NcTypedComponent::rename:
See ``Public Member Functions''. (line 374)
NcTypedComponent::type <1>:
See ``Public Member Functions''. (line 679)
NcTypedComponent::type <2>:
See ``Public Member Functions''. (line 415)
NcTypedComponent::type:
See ``Public Member Functions''. (line 359)
NcTypedComponent::values <1>:
See ``Public Member Functions''. (line 695)
NcTypedComponent::values <2>:
See ``Public Member Functions''. (line 453)
NcTypedComponent::values:
See ``Public Member Functions''. (line 377)
NcValues <1>:
See ``Public Member Functions''. (line 743)
NcValues:
See ``Auxiliary Classes''. (line 729)
NcValues::as_char:
See ``Public Member Functions''. (line 766)
NcValues::as_double:
See ``Public Member Functions''. (line 772)
NcValues::as_float:
See ``Public Member Functions''. (line 771)
NcValues::as_int:
See ``Public Member Functions''. (line 768)
NcValues::as_long:
See ``Public Member Functions''. (line 770)
NcValues::as_ncbyte:
See ``Public Member Functions''. (line 765)
NcValues::as_nclong:
See ``Public Member Functions''. (line 769)
NcValues::as_short:
See ``Public Member Functions''. (line 767)
NcValues::as_string:
See ``Public Member Functions''. (line 773)
NcValues::base:
See ``Public Member Functions''. (line 759)
NcValues::bytes_for_one:
See ``Public Member Functions''. (line 762)
NcValues::NcValues:
See ``Public Member Functions''. (line 743)
NcValues::num:
See ``Public Member Functions''. (line 752)
NcValues::print:
See ``Public Member Functions''. (line 755)
NcValues::~NcValues:
See ``Public Member Functions''. (line 749)
NcValues_char:
See ``Class NcValues''. (line 732)
NcValues_double:
See ``Class NcValues''. (line 732)
NcValues_float:
See ``Class NcValues''. (line 732)
NcValues_int:
See ``Class NcValues''. (line 732)
NcValues_long:
See ``Class NcValues''. (line 732)
NcValues_ncbyte:
See ``Class NcValues''. (line 732)
NcValues_nclong:
See ``Class NcValues''. (line 732)
NcValues_short:
See ``Class NcValues''. (line 732)
NcVar:
See ``Public Member Functions''. (line 399)
NcVar::add_att:
See ``Public Member Functions''. (line 520)
NcVar::edges:
See ``Public Member Functions''. (line 426)
NcVar::get:
See ``Public Member Functions''. (line 486)
NcVar::get_att:
See ``Public Member Functions''. (line 435)
NcVar::get_dim:
See ``Public Member Functions''. (line 422)
NcVar::get_index:
See ``Public Member Functions''. (line 631)
NcVar::get_rec:
See ``Public Member Functions''. (line 581)
NcVar::id:
See ``Public Member Functions''. (line 559)
NcVar::num_atts:
See ``Public Member Functions''. (line 432)
NcVar::num_dims:
See ``Public Member Functions''. (line 419)
NcVar::put:
See ``Public Member Functions''. (line 460)
NcVar::put_rec:
See ``Public Member Functions''. (line 591)
NcVar::rec_size:
See ``Public Member Functions''. (line 575)
NcVar::set_cur:
See ``Public Member Functions''. (line 511)
NcVar::set_rec:
See ``Public Member Functions''. (line 651)
NcVar::sync:
See ``Public Member Functions''. (line 564)
NcVar::~NcVar:
See ``Public Member Functions''. (line 568)
num:
See ``Public Member Functions''. (line 752)
num_atts <1>:
See ``Public Member Functions''. (line 432)
num_atts:
See ``Public Member Functions''. (line 215)
num_dims <1>:
See ``Public Member Functions''. (line 419)
num_dims:
See ``Public Member Functions''. (line 209)
num_vals <1>:
See ``Public Member Functions''. (line 686)
num_vals <2>:
See ``Public Member Functions''. (line 448)
num_vals:
See ``Public Member Functions''. (line 367)
num_vars:
See ``Public Member Functions''. (line 212)
print:
See ``Public Member Functions''. (line 755)
put:
See ``Public Member Functions''. (line 460)
put_rec:
See ``Public Member Functions''. (line 591)
rec_dim:
See ``Public Member Functions''. (line 236)
rec_size:
See ``Public Member Functions''. (line 575)
remove:
See ``Public Member Functions''. (line 714)
rename <1>:
See ``Public Member Functions''. (line 692)
rename <2>:
See ``Public Member Functions''. (line 541)
rename <3>:
See ``Public Member Functions''. (line 374)
rename:
See ``Public Member Functions''. (line 336)
requirements of C++ interface:
See ``Introduction''. (line 28)
set_cur:
See ``Public Member Functions''. (line 511)
set_fill:
See ``Public Member Functions''. (line 286)
set_rec:
See ``Public Member Functions''. (line 651)
size:
See ``Public Member Functions''. (line 324)
sync <1>:
See ``Public Member Functions''. (line 564)
sync <2>:
See ``Public Member Functions''. (line 339)
sync:
See ``Public Member Functions''. (line 300)
type <1>:
See ``Public Member Functions''. (line 679)
type <2>:
See ``Public Member Functions''. (line 415)
type:
See ``Public Member Functions''. (line 359)
values <1>:
See ``Public Member Functions''. (line 695)
values <2>:
See ``Public Member Functions''. (line 453)
values:
See ``Public Member Functions''. (line 377)
~NcAtt:
See ``Public Member Functions''. (line 719)
~NcError:
See ``Public Member Functions''. (line 799)
~NcFile:
See ``Public Member Functions''. (line 194)
~NcValues:
See ``Public Member Functions''. (line 749)
~NcVar:
See ``Public Member Functions''. (line 568)
