netcdf-C++
|
#include <ncVar.h>
Public Types | |
enum | ChecksumMode { nc_NOCHECKSUM = NC_NOCHECKSUM, nc_FLETCHER32 = NC_FLETCHER32 } |
enum | ChunkMode { nc_CHUNKED = NC_CHUNKED, nc_CONTIGUOUS = NC_CONTIGUOUS } |
enum | EndianMode { nc_ENDIAN_NATIVE = NC_ENDIAN_NATIVE, nc_ENDIAN_LITTLE = NC_ENDIAN_LITTLE, nc_ENDIAN_BIG = NC_ENDIAN_BIG } |
Public Member Functions | |
void | freeString (size_t len, char **data) const |
NcVarAtt | getAtt (const std::string &name) const |
int | getAttCount () const |
std::map< std::string, NcVarAtt > | getAtts () const |
ChecksumMode | getChecksum () const |
void | getChunkingParameters (ChunkMode &chunkMode, std::vector< size_t > &chunkSizes) const |
void | getCompressionParameters (bool &shuffleFilterEnabled, bool &deflateFilterEnabled, int &deflateLevel) const |
NcDim | getDim (int i) const |
int | getDimCount () const |
std::vector< NcDim > | getDims () const |
EndianMode | getEndianness () const |
template<class T > | |
void | getFillModeParameters (bool &fillMode, T &fillValue) const |
void | getFillModeParameters (bool &fillMode, void *fillValue=NULL) const |
void | getFilter (unsigned int *idp, size_t *nparamsp, unsigned int *params) const |
int | getId () const |
std::string | getName () const |
NcGroup | getParentGroup () const |
NcType | getType () const |
void | getTypeLen (nc_type type) const |
void | getVar (char **dataValues) const |
void | getVar (char *dataValues) const |
void | getVar (const std::vector< size_t > &index, char **datumValue) const |
void | getVar (const std::vector< size_t > &index, char *datumValue) const |
void | getVar (const std::vector< size_t > &index, double *datumValue) const |
void | getVar (const std::vector< size_t > &index, float *datumValue) const |
void | getVar (const std::vector< size_t > &index, int *datumValue) const |
void | getVar (const std::vector< size_t > &index, long *datumValue) const |
void | getVar (const std::vector< size_t > &index, long long *datumValue) const |
void | getVar (const std::vector< size_t > &index, short *datumValue) const |
void | getVar (const std::vector< size_t > &index, signed char *datumValue) const |
void | getVar (const std::vector< size_t > &index, unsigned char *datumValue) const |
void | getVar (const std::vector< size_t > &index, unsigned int *datumValue) const |
void | getVar (const std::vector< size_t > &index, unsigned long long *datumValue) const |
void | getVar (const std::vector< size_t > &index, unsigned short *datumValue) const |
void | getVar (const std::vector< size_t > &index, void *datumValue) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, char **dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, char *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, const std::vector< ptrdiff_t > &stride, char **dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, const std::vector< ptrdiff_t > &stride, char *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, const std::vector< ptrdiff_t > &stride, const std::vector< ptrdiff_t > &imap, char **dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, const std::vector< ptrdiff_t > &stride, const std::vector< ptrdiff_t > &imap, char *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, const std::vector< ptrdiff_t > &stride, const std::vector< ptrdiff_t > &imap, double *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, const std::vector< ptrdiff_t > &stride, const std::vector< ptrdiff_t > &imap, float *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, const std::vector< ptrdiff_t > &stride, const std::vector< ptrdiff_t > &imap, int *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, const std::vector< ptrdiff_t > &stride, const std::vector< ptrdiff_t > &imap, long *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, const std::vector< ptrdiff_t > &stride, const std::vector< ptrdiff_t > &imap, long long *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, const std::vector< ptrdiff_t > &stride, const std::vector< ptrdiff_t > &imap, short *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, const std::vector< ptrdiff_t > &stride, const std::vector< ptrdiff_t > &imap, signed char *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, const std::vector< ptrdiff_t > &stride, const std::vector< ptrdiff_t > &imap, unsigned char *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, const std::vector< ptrdiff_t > &stride, const std::vector< ptrdiff_t > &imap, unsigned int *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, const std::vector< ptrdiff_t > &stride, const std::vector< ptrdiff_t > &imap, unsigned long long *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, const std::vector< ptrdiff_t > &stride, const std::vector< ptrdiff_t > &imap, unsigned short *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, const std::vector< ptrdiff_t > &stride, const std::vector< ptrdiff_t > &imap, void *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, const std::vector< ptrdiff_t > &stride, double *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, const std::vector< ptrdiff_t > &stride, float *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, const std::vector< ptrdiff_t > &stride, int *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, const std::vector< ptrdiff_t > &stride, long *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, const std::vector< ptrdiff_t > &stride, long long *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, const std::vector< ptrdiff_t > &stride, short *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, const std::vector< ptrdiff_t > &stride, signed char *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, const std::vector< ptrdiff_t > &stride, unsigned char *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, const std::vector< ptrdiff_t > &stride, unsigned int *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, const std::vector< ptrdiff_t > &stride, unsigned long long *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, const std::vector< ptrdiff_t > &stride, unsigned short *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, const std::vector< ptrdiff_t > &stride, void *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, double *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, float *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, int *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, long *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, long long *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, short *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, signed char *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, unsigned char *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, unsigned int *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, unsigned long long *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, unsigned short *dataValues) const |
void | getVar (const std::vector< size_t > &start, const std::vector< size_t > &count, void *dataValues) const |
void | getVar (double *dataValues) const |
void | getVar (float *dataValues) const |
void | getVar (int *dataValues) const |
void | getVar (long *dataValues) const |
void | getVar (long long *dataValues) const |
void | getVar (short *dataValues) const |
void | getVar (signed char *dataValues) const |
void | getVar (unsigned char *dataValues) const |
void | getVar (unsigned int *dataValues) const |
void | getVar (unsigned long long *dataValues) const |
void | getVar (unsigned short *dataValues) const |
void | getVar (void *dataValues) const |
bool | isNull () const |
NcVar () | |
NcVar (const NcGroup &grp, const int &varId) | |
NcVar (const NcVar &ncVar) | |
bool | operator!= (const NcVar &rhs) const |
NcVar & | operator= (const NcVar &rhs) |
bool | operator== (const NcVar &rhs) const |
NcVarAtt | putAtt (const std::string &name, const NcType &type, double datumValue) const |
NcVarAtt | putAtt (const std::string &name, const NcType &type, float datumValue) const |
NcVarAtt | putAtt (const std::string &name, const NcType &type, int datumValue) const |
NcVarAtt | putAtt (const std::string &name, const NcType &type, long datumValue) const |
NcVarAtt | putAtt (const std::string &name, const NcType &type, long long datumValue) const |
NcVarAtt | putAtt (const std::string &name, const NcType &type, short datumValue) const |
NcVarAtt | putAtt (const std::string &name, const NcType &type, size_t len, const double *dataValues) const |
NcVarAtt | putAtt (const std::string &name, const NcType &type, size_t len, const float *dataValues) const |
NcVarAtt | putAtt (const std::string &name, const NcType &type, size_t len, const int *dataValues) const |
NcVarAtt | putAtt (const std::string &name, const NcType &type, size_t len, const long *dataValues) const |
NcVarAtt | putAtt (const std::string &name, const NcType &type, size_t len, const long long *dataValues) const |
NcVarAtt | putAtt (const std::string &name, const NcType &type, size_t len, const short *dataValues) const |
NcVarAtt | putAtt (const std::string &name, const NcType &type, size_t len, const signed char *dataValues) const |
NcVarAtt | putAtt (const std::string &name, const NcType &type, size_t len, const unsigned char *dataValues) const |
NcVarAtt | putAtt (const std::string &name, const NcType &type, size_t len, const unsigned int *dataValues) const |
NcVarAtt | putAtt (const std::string &name, const NcType &type, size_t len, const unsigned long long *dataValues) const |
NcVarAtt | putAtt (const std::string &name, const NcType &type, size_t len, const unsigned short *dataValues) const |
NcVarAtt | putAtt (const std::string &name, const NcType &type, size_t len, const void *dataValues) const |
NcVarAtt | putAtt (const std::string &name, const NcType &type, unsigned int datumValue) const |
NcVarAtt | putAtt (const std::string &name, const NcType &type, unsigned long long datumValue) const |
NcVarAtt | putAtt (const std::string &name, const NcType &type, unsigned short datumValue) const |
NcVarAtt | putAtt (const std::string &name, const std::string &dataValues) const |
NcVarAtt | putAtt (const std::string &name, size_t len, const char **dataValues) const |
void | putVar (const char **dataValues) const |
void | putVar (const char *dataValues) const |
void | putVar (const double *dataValues) const |
void | putVar (const float *dataValues) const |
void | putVar (const int *dataValues) const |
void | putVar (const long *dataValues) const |
void | putVar (const long long *dataValues) const |
void | putVar (const short *dataValues) const |
void | putVar (const signed char *dataValues) const |
void | putVar (const std::vector< size_t > &index, const char **datumValue) const |
void | putVar (const std::vector< size_t > &index, const double datumValue) const |
void | putVar (const std::vector< size_t > &index, const float datumValue) const |
void | putVar (const std::vector< size_t > &index, const int datumValue) const |
void | putVar (const std::vector< size_t > &index, const long datumValue) const |
void | putVar (const std::vector< size_t > &index, const long long datumValue) const |
void | putVar (const std::vector< size_t > &index, const short datumValue) const |
void | putVar (const std::vector< size_t > &index, const signed char *datumValue) const |
void | putVar (const std::vector< size_t > &index, const std::string &datumValue) const |
void | putVar (const std::vector< size_t > &index, const unsigned char *datumValue) const |
void | putVar (const std::vector< size_t > &index, const unsigned int datumValue) const |
void | putVar (const std::vector< size_t > &index, const unsigned long long datumValue) const |
void | putVar (const std::vector< size_t > &index, const unsigned short datumValue) const |
void | putVar (const std::vector< size_t > &index, const void *datumValue) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const char **dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const char *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const double *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const float *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const int *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const long *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const long long *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const short *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const signed char *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const std::vector< ptrdiff_t > &stridep, const char **dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const std::vector< ptrdiff_t > &stridep, const char *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const std::vector< ptrdiff_t > &stridep, const double *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const std::vector< ptrdiff_t > &stridep, const float *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const std::vector< ptrdiff_t > &stridep, const int *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const std::vector< ptrdiff_t > &stridep, const long *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const std::vector< ptrdiff_t > &stridep, const long long *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const std::vector< ptrdiff_t > &stridep, const short *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const std::vector< ptrdiff_t > &stridep, const signed char *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const std::vector< ptrdiff_t > &stridep, const std::vector< ptrdiff_t > &imapp, const char **dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const std::vector< ptrdiff_t > &stridep, const std::vector< ptrdiff_t > &imapp, const char *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const std::vector< ptrdiff_t > &stridep, const std::vector< ptrdiff_t > &imapp, const double *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const std::vector< ptrdiff_t > &stridep, const std::vector< ptrdiff_t > &imapp, const float *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const std::vector< ptrdiff_t > &stridep, const std::vector< ptrdiff_t > &imapp, const int *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const std::vector< ptrdiff_t > &stridep, const std::vector< ptrdiff_t > &imapp, const long *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const std::vector< ptrdiff_t > &stridep, const std::vector< ptrdiff_t > &imapp, const long long *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const std::vector< ptrdiff_t > &stridep, const std::vector< ptrdiff_t > &imapp, const short *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const std::vector< ptrdiff_t > &stridep, const std::vector< ptrdiff_t > &imapp, const signed char *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const std::vector< ptrdiff_t > &stridep, const std::vector< ptrdiff_t > &imapp, const unsigned char *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const std::vector< ptrdiff_t > &stridep, const std::vector< ptrdiff_t > &imapp, const unsigned int *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const std::vector< ptrdiff_t > &stridep, const std::vector< ptrdiff_t > &imapp, const unsigned long long *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const std::vector< ptrdiff_t > &stridep, const std::vector< ptrdiff_t > &imapp, const unsigned short *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const std::vector< ptrdiff_t > &stridep, const std::vector< ptrdiff_t > &imapp, const void *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const std::vector< ptrdiff_t > &stridep, const unsigned char *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const std::vector< ptrdiff_t > &stridep, const unsigned int *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const std::vector< ptrdiff_t > &stridep, const unsigned long long *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const std::vector< ptrdiff_t > &stridep, const unsigned short *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const std::vector< ptrdiff_t > &stridep, const void *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const unsigned char *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const unsigned int *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const unsigned long long *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const unsigned short *dataValues) const |
void | putVar (const std::vector< size_t > &startp, const std::vector< size_t > &countp, const void *dataValues) const |
void | putVar (const unsigned char *dataValues) const |
void | putVar (const unsigned int *dataValues) const |
void | putVar (const unsigned long long *dataValues) const |
void | putVar (const unsigned short *dataValues) const |
void | putVar (const void *dataValues) const |
void | rename (const std::string &newname) const |
void | setChecksum (ChecksumMode checksumMode) const |
void | setChunkCache (size_t size, size_t nelems, float preemption) const |
void | setChunking (ChunkMode chunkMode, std::vector< size_t > &chunksizes) const |
void | setCompression (bool enableShuffleFilter, bool enableDeflateFilter, int deflateLevel) const |
void | setEndianness (EndianMode endianMode) const |
void | setFill (bool fillMode, const void *fillValue=NULL) const |
template<class T > | |
void | setFill (bool fillMode, T fillValue) const |
void | setFill (bool fillMode, void *fillValue=NULL) const |
void | setFilter (unsigned int id, size_t nparams, const unsigned int *parms) const |
~NcVar () | |
Friends | |
bool | operator< (const NcVar &lhs, const NcVar &rhs) |
bool | operator> (const NcVar &lhs, const NcVar &rhs) |
Class represents a netCDF variable.
Used for checksum specification (see NcVar::setChecksum, NcVar::getChecksum).
Enumerator | |
---|---|
nc_NOCHECKSUM | No checksum (the default). |
nc_FLETCHER32 | Selects the Fletcher32 checksum filter. |
Used for chunking specifications (see NcVar::setChunking, NcVar::getChunkingParameters).
Used to specifying the endianess of the data, (see NcVar::setEndianness, NcVar::getEndianness). By default this is NC_ENDIAN_NATIVE.
Enumerator | |
---|---|
nc_ENDIAN_NATIVE | Native endian. |
nc_ENDIAN_LITTLE | Little endian. |
nc_ENDIAN_BIG | Big endian. |
|
inline |
destructor
NcVar::NcVar | ( | ) |
Constructor generates a null object.
NcVar::NcVar | ( | const NcGroup & | grp, |
const int & | varId | ||
) |
NcVar::NcVar | ( | const NcVar & | ncVar | ) |
The copy constructor.
void NcVar::freeString | ( | size_t | len, |
char ** | data | ||
) | const |
Free memory allocated for a string.
NcVarAtt NcVar::getAtt | ( | const std::string & | name | ) | const |
Gets attribute by name
int NcVar::getAttCount | ( | ) | const |
Gets the number of attributes.
map< string, NcVarAtt > NcVar::getAtts | ( | ) | const |
Gets the set of attributes.
NcVar::ChecksumMode NcVar::getChecksum | ( | ) | const |
Gets the checksum parameters of the variable.
void NcVar::getChunkingParameters | ( | ChunkMode & | chunkMode, |
std::vector< size_t > & | chunkSizes | ||
) | const |
Gets the chunking parameters
chunkMode | On return contains either: "nc_CONTIGUOUS" or "nc_CHUNKED" |
chunksizes | On return contains shape of chunking, used if ChunkMode=nc_CHUNKED. |
void NcVar::getCompressionParameters | ( | bool & | shuffleFilterEnabled, |
bool & | deflateFilterEnabled, | ||
int & | deflateLevel | ||
) | const |
Gets the compression parameters
enableShuffleFilter | On return set to true if the shuffle filter is enabled. |
enableDeflateFilter | On return set to true if the deflate filter is enabled. |
deflateLevel | On return set to the deflate level. |
int NcVar::getDimCount | ( | ) | const |
The the number of dimensions.
NcVar::EndianMode NcVar::getEndianness | ( | ) | const |
Gets the endianness of the variable.
|
inline |
Gets the fill parameters
On | return set to true if fill mode is enabled. |
On | return is set to the fill value. |
void NcVar::getFillModeParameters | ( | bool & | fillMode, |
void * | fillValue = NULL |
||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function in what argument(s) it accepts. The function can be used for any type, including user-defined types.
fillMode | On return set to true if fill mode is enabled. |
fillValue | On return containts a pointer to fill value. Must be the same type as the variable. Ignored if fillMode=.false. |
void NcVar::getFilter | ( | unsigned int * | idp, |
size_t * | nparamsp, | ||
unsigned int * | params | ||
) | const |
Query filter properties (if a filter has been applied).
int NcVar::getId | ( | ) | const |
Get the variable id.
string NcVar::getName | ( | ) | const |
Name of this NcVar object.
NcGroup NcVar::getParentGroup | ( | ) | const |
Gets parent group.
NcType NcVar::getType | ( | ) | const |
Returns the variable type.
void NcVar::getTypeLen | ( | nc_type | type | ) | const |
Query the length of a given ncType.
void NcVar::getVar | ( | char ** | dataValues | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void NcVar::getVar | ( | char * | dataValues | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | index, |
char ** | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | index, |
char * | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | index, |
double * | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | index, |
float * | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | index, |
int * | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | index, |
long * | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | index, |
long long * | datumValue | ||
) | const |
Reads a single datum value from a variable of an open netCDF dataset. The value is converted from the external data type of the variable, if necessary.
index | Vector specifying the index of the data value to be read. The indices are relative to 0, so for example, the first data value of a two-dimensional variable would have index (0,0). The elements of index must correspond to the variable's dimensions. Hence, if the variable is a record variable, the first index is the record number. |
datumValue | Pointer to the location into which the data value is read. If the type of data value differs from the netCDF variable type, type conversion will occur. (However, no type conversion is carried out for variables using the user-defined data types: nc_Vlen, nc_Opaque, nc_Compound and nc_Enum.) |
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | index, |
short * | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | index, |
signed char * | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | index, |
unsigned char * | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | index, |
unsigned int * | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | index, |
unsigned long long * | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | index, |
unsigned short * | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | index, |
void * | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function in what argument(s) it accepts. In addition, no data conversion is carried out. This means that the type of the data in memory must match the type of the variable.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
char ** | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
char * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
const std::vector< ptrdiff_t > & | stride, | ||
char ** | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
const std::vector< ptrdiff_t > & | stride, | ||
char * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
const std::vector< ptrdiff_t > & | stride, | ||
const std::vector< ptrdiff_t > & | imap, | ||
char ** | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
const std::vector< ptrdiff_t > & | stride, | ||
const std::vector< ptrdiff_t > & | imap, | ||
char * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
const std::vector< ptrdiff_t > & | stride, | ||
const std::vector< ptrdiff_t > & | imap, | ||
double * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
const std::vector< ptrdiff_t > & | stride, | ||
const std::vector< ptrdiff_t > & | imap, | ||
float * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
const std::vector< ptrdiff_t > & | stride, | ||
const std::vector< ptrdiff_t > & | imap, | ||
int * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
const std::vector< ptrdiff_t > & | stride, | ||
const std::vector< ptrdiff_t > & | imap, | ||
long * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
const std::vector< ptrdiff_t > & | stride, | ||
const std::vector< ptrdiff_t > & | imap, | ||
long long * | dataValues | ||
) | const |
Reads a mapped array section of values from a netCDF variable. The mapped array section is specified by giving a corner, a vector of edge lengths, a stride vector, and an index mapping vector. The index mapping vector is a vector of integers that specifies the mapping between the dimensions of a netCDF variable and the in-memory structure of the internal data array. No assumptions are made about the ordering or length of the dimensions of the data array.
start | Vector specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | Vector specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
stride | Vector specifying the interval between selected indices. The elements of the stride vector correspond, in order, to the variable's dimensions. A value of 1 accesses adjacent values of the netCDF variable in the corresponding dimension; a value of 2 accesses every other value of the netCDF variable in the corresponding dimension; and so on. A NULL stride argument is treated as (1, 1, ... , 1). |
imap | Vector of integers that specifies the mapping between the dimensions of a netCDF variable and the in-memory structure of the internal data array. imap[0] gives the distance between elements of the internal array corresponding to the most slowly varying dimension of the netCDF variable. imap[n-1] (where n is the rank of the netCDF variable) gives the distance between elements of the internal array corresponding to the most rapidly varying dimension of the netCDF variable. Intervening imap elements correspond to other dimensions of the netCDF variable in the obvious way. Distances between elements are specified in type-independent units of elements (the distance between internal elements that occupy adjacent memory locations is 1 and not the element's byte-length as in netCDF 2). |
dataValues | Pointer to the location into which the data value is read. If the type of data value differs from the netCDF variable type, type conversion will occur. (However, no type conversion is carried out for variables using the user-defined data types: nc_Vlen, nc_Opaque, nc_Compound and nc_Enum.) |
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
const std::vector< ptrdiff_t > & | stride, | ||
const std::vector< ptrdiff_t > & | imap, | ||
short * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
const std::vector< ptrdiff_t > & | stride, | ||
const std::vector< ptrdiff_t > & | imap, | ||
signed char * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
const std::vector< ptrdiff_t > & | stride, | ||
const std::vector< ptrdiff_t > & | imap, | ||
unsigned char * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
const std::vector< ptrdiff_t > & | stride, | ||
const std::vector< ptrdiff_t > & | imap, | ||
unsigned int * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
const std::vector< ptrdiff_t > & | stride, | ||
const std::vector< ptrdiff_t > & | imap, | ||
unsigned long long * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
const std::vector< ptrdiff_t > & | stride, | ||
const std::vector< ptrdiff_t > & | imap, | ||
unsigned short * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
const std::vector< ptrdiff_t > & | stride, | ||
const std::vector< ptrdiff_t > & | imap, | ||
void * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function in what argument(s) it accepts. In addition, no data conversion is carried out. This means that the type of the data in memory must match the type of the variable.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
const std::vector< ptrdiff_t > & | stride, | ||
double * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
const std::vector< ptrdiff_t > & | stride, | ||
float * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
const std::vector< ptrdiff_t > & | stride, | ||
int * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
const std::vector< ptrdiff_t > & | stride, | ||
long * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
const std::vector< ptrdiff_t > & | stride, | ||
long long * | dataValues | ||
) | const |
Reads a subsampled (strided) array section of values from a netCDF variable. The subsampled array section is specified by giving a corner, a vector of edge lengths, and a stride vector. The values are read with the last dimension of the netCDF variable varying fastest.
start | Vector specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | Vector specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
stride | Vector specifying the interval between selected indices. The elements of the stride vector correspond, in order, to the variable's dimensions. A value of 1 accesses adjacent values of the netCDF variable in the corresponding dimension; a value of 2 accesses every other value of the netCDF variable in the corresponding dimension; and so on. A NULL stride argument is treated as (1, 1, ... , 1). |
dataValues | Pointer to the location into which the data value is read. If the type of data value differs from the netCDF variable type, type conversion will occur. (However, no type conversion is carried out for variables using the user-defined data types: nc_Vlen, nc_Opaque, nc_Compound and nc_Enum.) |
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
const std::vector< ptrdiff_t > & | stride, | ||
short * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
const std::vector< ptrdiff_t > & | stride, | ||
signed char * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
const std::vector< ptrdiff_t > & | stride, | ||
unsigned char * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
const std::vector< ptrdiff_t > & | stride, | ||
unsigned int * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
const std::vector< ptrdiff_t > & | stride, | ||
unsigned long long * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
const std::vector< ptrdiff_t > & | stride, | ||
unsigned short * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
const std::vector< ptrdiff_t > & | stride, | ||
void * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function in what argument(s) it accepts. In addition, no data conversion is carried out. This means that the type of the data in memory must match the type of the variable.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
double * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
float * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
int * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
long * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
long long * | dataValues | ||
) | const |
Reads an array of values from a netCDF variable of an open netCDF dataset. The array is specified by giving a corner and a vector of edge lengths. The values are read into consecutive locations with the last dimension varying fastest.
start | Vector specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | Vector specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
dataValues | Pointer to the location into which the data value is read. If the type of data value differs from the netCDF variable type, type conversion will occur. (However, no type conversion is carried out for variables using the user-defined data types: nc_Vlen, nc_Opaque, nc_Compound and nc_Enum.) |
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
short * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
signed char * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
unsigned char * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
unsigned int * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
unsigned long long * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
unsigned short * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::getVar | ( | const std::vector< size_t > & | start, |
const std::vector< size_t > & | count, | ||
void * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function in what argument(s) it accepts. In addition, no data conversion is carried out. This means that the type of the data in memory must match the type of the variable.
void NcVar::getVar | ( | double * | dataValues | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void NcVar::getVar | ( | float * | dataValues | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void NcVar::getVar | ( | int * | dataValues | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void NcVar::getVar | ( | long * | dataValues | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void NcVar::getVar | ( | long long * | dataValues | ) | const |
Reads the entire data from an netCDF variable. This is the simplest interface to use for reading the value of a scalar variable or when all the values of a multidimensional variable can be read at once. The values are read into consecutive locations with the last dimension varying fastest.
Take care when using the simplest forms of this interface with record variables when you don't specify how many records are to be read. If you try to read all the values of a record variable into an array but there are more records in the file than you assume, more data will be read than you expect, which may cause a segmentation violation.
dataValues | Pointer to the location into which the data value is read. If the type of data value differs from the netCDF variable type, type conversion will occur. (However, no type conversion is carried out for variables using the user-defined data types: nc_Vlen, nc_Opaque, nc_Compound and nc_Enum.) |
void NcVar::getVar | ( | short * | dataValues | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void NcVar::getVar | ( | signed char * | dataValues | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void NcVar::getVar | ( | unsigned char * | dataValues | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void NcVar::getVar | ( | unsigned int * | dataValues | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void NcVar::getVar | ( | unsigned long long * | dataValues | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void NcVar::getVar | ( | unsigned short * | dataValues | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void NcVar::getVar | ( | void * | dataValues | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function in what argument(s) it accepts. In addition, no data conversion is carried out. This means that the type of the data in memory must match the type of the variable.
|
inline |
Returns true if this object variable is not defined.
bool NcVar::operator!= | ( | const NcVar & | rhs | ) | const |
!= operator
bool NcVar::operator== | ( | const NcVar & | rhs | ) | const |
equivalence operator
NcVarAtt netCDF::NcVar::putAtt | ( | const std::string & | name, |
const NcType & | type, | ||
double | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcVarAtt netCDF::NcVar::putAtt | ( | const std::string & | name, |
const NcType & | type, | ||
float | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcVarAtt netCDF::NcVar::putAtt | ( | const std::string & | name, |
const NcType & | type, | ||
int | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcVarAtt netCDF::NcVar::putAtt | ( | const std::string & | name, |
const NcType & | type, | ||
long | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcVarAtt netCDF::NcVar::putAtt | ( | const std::string & | name, |
const NcType & | type, | ||
long long | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcVarAtt netCDF::NcVar::putAtt | ( | const std::string & | name, |
const NcType & | type, | ||
short | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcVarAtt netCDF::NcVar::putAtt | ( | const std::string & | name, |
const NcType & | type, | ||
size_t | len, | ||
const double * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcVarAtt netCDF::NcVar::putAtt | ( | const std::string & | name, |
const NcType & | type, | ||
size_t | len, | ||
const float * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcVarAtt netCDF::NcVar::putAtt | ( | const std::string & | name, |
const NcType & | type, | ||
size_t | len, | ||
const int * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcVarAtt netCDF::NcVar::putAtt | ( | const std::string & | name, |
const NcType & | type, | ||
size_t | len, | ||
const long * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcVarAtt netCDF::NcVar::putAtt | ( | const std::string & | name, |
const NcType & | type, | ||
size_t | len, | ||
const long long * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcVarAtt netCDF::NcVar::putAtt | ( | const std::string & | name, |
const NcType & | type, | ||
size_t | len, | ||
const short * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcVarAtt netCDF::NcVar::putAtt | ( | const std::string & | name, |
const NcType & | type, | ||
size_t | len, | ||
const signed char * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcVarAtt netCDF::NcVar::putAtt | ( | const std::string & | name, |
const NcType & | type, | ||
size_t | len, | ||
const unsigned char * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcVarAtt netCDF::NcVar::putAtt | ( | const std::string & | name, |
const NcType & | type, | ||
size_t | len, | ||
const unsigned int * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcVarAtt netCDF::NcVar::putAtt | ( | const std::string & | name, |
const NcType & | type, | ||
size_t | len, | ||
const unsigned long long * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcVarAtt netCDF::NcVar::putAtt | ( | const std::string & | name, |
const NcType & | type, | ||
size_t | len, | ||
const unsigned short * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcVarAtt netCDF::NcVar::putAtt | ( | const std::string & | name, |
const NcType & | type, | ||
size_t | len, | ||
const void * | dataValues | ||
) | const |
Creates a new variable attribute or if already exisiting replaces it. If you are writing a Fill_Value attribute, and will tell the HDF5 layer to use the specified fill value for that variable.
name | Name of attribute. |
type | The attribute type. |
len | The length of the attribute (number of Nctype repeats). |
dataValues | Data Values to put into the new attribute. If the type of data values differs from the netCDF variable type, type conversion will occur. (However, no type conversion is carried out for variables using the user-defined data types: nc_Vlen, nc_Opaque, nc_Compound and nc_Enum.) |
NcVarAtt netCDF::NcVar::putAtt | ( | const std::string & | name, |
const NcType & | type, | ||
unsigned int | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcVarAtt netCDF::NcVar::putAtt | ( | const std::string & | name, |
const NcType & | type, | ||
unsigned long long | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcVarAtt netCDF::NcVar::putAtt | ( | const std::string & | name, |
const NcType & | type, | ||
unsigned short | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcVarAtt netCDF::NcVar::putAtt | ( | const std::string & | name, |
const std::string & | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcVarAtt netCDF::NcVar::putAtt | ( | const std::string & | name, |
size_t | len, | ||
const char ** | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void NcVar::putVar | ( | const char ** | dataValues | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void NcVar::putVar | ( | const char * | dataValues | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void NcVar::putVar | ( | const double * | dataValues | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void NcVar::putVar | ( | const float * | dataValues | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void NcVar::putVar | ( | const int * | dataValues | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void NcVar::putVar | ( | const long * | dataValues | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void NcVar::putVar | ( | const long long * | dataValues | ) | const |
Writes the entire data into the netCDF variable. This is the simplest interface to use for writing a value in a scalar variable or whenever all the values of a multidimensional variable can all be written at once. The values to be written are associated with the netCDF variable by assuming that the last dimension of the netCDF variable varies fastest in the C interface.
Take care when using the simplest forms of this interface with record variables when you don't specify how many records are to be written. If you try to write all the values of a record variable into a netCDF file that has no record data yet (hence has 0 records), nothing will be written. Similarly, if you try to write all of a record variable but there are more records in the file than you assume, more data may be written to the file than you supply, which may result in a segmentation violation.
dataValues | The data values. The order in which the data will be written to the netCDF variable is with the last dimension of the specified variable varying fastest. If the type of data values differs from the netCDF variable type, type conversion will occur. (However, no type conversion is carried out for variables using the user-defined data types: nc_Vlen, nc_Opaque, nc_Compound and nc_Enum.) |
void NcVar::putVar | ( | const short * | dataValues | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void NcVar::putVar | ( | const signed char * | dataValues | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | index, |
const char ** | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | index, |
const double | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | index, |
const float | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | index, |
const int | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | index, |
const long | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | index, |
const long long | datumValue | ||
) | const |
Writes a single datum into the netCDF variable.
index | Vector specifying the index where the data values will be written. The indices are relative to 0, so for example, the first data value of a two-dimensional variable would have index (0,0). The elements of index must correspond to the variable's dimensions. Hence, if the variable uses the unlimited dimension, the first index would correspond to the unlimited dimension. |
datumValue | The data value. If the type of data values differs from the netCDF variable type, type conversion will occur. (However, no type conversion is carried out for variables using the user-defined data types: nc_Vlen, nc_Opaque, nc_Compound and nc_Enum.) |
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | index, |
const short | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | index, |
const signed char * | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | index, |
const std::string & | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | index, |
const unsigned char * | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | index, |
const unsigned int | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | index, |
const unsigned long long | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | index, |
const unsigned short | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | index, |
const void * | datumValue | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function in what argument(s) it accepts. In addition, no data conversion is carried out. This means that the type of the data in memory must match the type of the variable.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const char ** | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const char * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const double * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const float * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const int * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const long * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const long long * | dataValues | ||
) | const |
Writes an array of values into the netCDF variable. The portion of the netCDF variable to write is specified by giving a corner and a vector of edge lengths that refer to an array section of the netCDF variable. The values to be written are associated with the netCDF variable by assuming that the last dimension of the netCDF variable varies fastest.
startp | Vector specifying the index where the first data values will be written. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index corresponds to the starting record number for writing the data values. |
countp | Vector specifying the number of indices selected along each dimension. To write a single value, for example, specify count as (1, 1, ... , 1). The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to write. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
dataValues | The data values. The order in which the data will be written to the netCDF variable is with the last dimension of the specified variable varying fastest. If the type of data values differs from the netCDF variable type, type conversion will occur. (However, no type conversion is carried out for variables using the user-defined data types: nc_Vlen, nc_Opaque, nc_Compound and nc_Enum.) |
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const short * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const signed char * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const std::vector< ptrdiff_t > & | stridep, | ||
const char ** | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const std::vector< ptrdiff_t > & | stridep, | ||
const char * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const std::vector< ptrdiff_t > & | stridep, | ||
const double * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const std::vector< ptrdiff_t > & | stridep, | ||
const float * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const std::vector< ptrdiff_t > & | stridep, | ||
const int * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const std::vector< ptrdiff_t > & | stridep, | ||
const long * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const std::vector< ptrdiff_t > & | stridep, | ||
const long long * | dataValues | ||
) | const |
Writes an array of values into the netCDF variable. The subsampled array section is specified by giving a corner, a vector of counts, and a stride vector.
startp | Vector specifying the index where the first data values will be written. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index corresponds to the starting record number for writing the data values. |
countp | Vector specifying the number of indices selected along each dimension. To write a single value, for example, specify count as (1, 1, ... , 1). The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to write. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
stridep | A vector of ptrdiff_t integers that specifies the sampling interval along each dimension of the netCDF variable. The elements of the stride vector correspond, in order, to the netCDF variable's dimensions (stride[0] gives the sampling interval along the most slowly varying dimension of the netCDF variable). Sampling intervals are specified in type-independent units of elements (a value of 1 selects consecutive elements of the netCDF variable along the corresponding dimension, a value of 2 selects every other element, etc.). A NULL stride argument is treated as (1, 1, ... , 1). |
dataValues | The data values. The order in which the data will be written to the netCDF variable is with the last dimension of the specified variable varying fastest. If the type of data values differs from the netCDF variable type, type conversion will occur. (However, no type conversion is carried out for variables using the user-defined data types: nc_Vlen, nc_Opaque, nc_Compound and nc_Enum. |
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const std::vector< ptrdiff_t > & | stridep, | ||
const short * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const std::vector< ptrdiff_t > & | stridep, | ||
const signed char * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const std::vector< ptrdiff_t > & | stridep, | ||
const std::vector< ptrdiff_t > & | imapp, | ||
const char ** | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const std::vector< ptrdiff_t > & | stridep, | ||
const std::vector< ptrdiff_t > & | imapp, | ||
const char * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const std::vector< ptrdiff_t > & | stridep, | ||
const std::vector< ptrdiff_t > & | imapp, | ||
const double * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const std::vector< ptrdiff_t > & | stridep, | ||
const std::vector< ptrdiff_t > & | imapp, | ||
const float * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const std::vector< ptrdiff_t > & | stridep, | ||
const std::vector< ptrdiff_t > & | imapp, | ||
const int * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const std::vector< ptrdiff_t > & | stridep, | ||
const std::vector< ptrdiff_t > & | imapp, | ||
const long * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const std::vector< ptrdiff_t > & | stridep, | ||
const std::vector< ptrdiff_t > & | imapp, | ||
const long long * | dataValues | ||
) | const |
Writes a mapped array section of values into the netCDF variable. The mapped array section is specified by giving a corner, a vector of counts, a stride vector, and an index mapping vector. The index mapping vector is a vector of integers that specifies the mapping between the dimensions of a netCDF variable and the in-memory structure of the internal data array. No assumptions are made about the ordering or length of the dimensions of the data array.
countp | Vector specifying the number of indices selected along each dimension. To write a single value, for example, specify count as (1, 1, ... , 1). The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to write. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
stridep | A vector of ptrdiff_t integers that specifies the sampling interval along each dimension of the netCDF variable. The elements of the stride vector correspond, in order, to the netCDF variable's dimensions (stride[0] gives the sampling interval along the most slowly varying dimension of the netCDF variable). Sampling intervals are specified in type-independent units of elements (a value of 1 selects consecutive elements of the netCDF variable along the corresponding dimension, a value of 2 selects every other element, etc.). A NULL stride argument is treated as (1, 1, ... , 1). |
imap | Vector specifies the mapping between the dimensions of a netCDF variable and the in-memory structure of the internal data array. The elements of the index mapping vector correspond, in order, to the netCDF variable's dimensions (imap[0] gives the distance between elements of the internal array corresponding to the most slowly varying dimension of the netCDF variable). Distances between elements are specified in type-independent units of elements (the distance between internal elements that occupy adjacent memory locations is 1 and not the element's byte-length as in netCDF 2). A NULL argument means the memory-resident values have the same structure as the associated netCDF variable. |
dataValues | The data values. The order in which the data will be written to the netCDF variable is with the last dimension of the specified variable varying fastest. If the type of data values differs from the netCDF variable type, type conversion will occur. (However, no type conversion is carried out for variables using the user-defined data types: nc_Vlen, nc_Opaque, nc_Compound and nc_Enum.) |
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const std::vector< ptrdiff_t > & | stridep, | ||
const std::vector< ptrdiff_t > & | imapp, | ||
const short * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const std::vector< ptrdiff_t > & | stridep, | ||
const std::vector< ptrdiff_t > & | imapp, | ||
const signed char * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const std::vector< ptrdiff_t > & | stridep, | ||
const std::vector< ptrdiff_t > & | imapp, | ||
const unsigned char * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const std::vector< ptrdiff_t > & | stridep, | ||
const std::vector< ptrdiff_t > & | imapp, | ||
const unsigned int * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const std::vector< ptrdiff_t > & | stridep, | ||
const std::vector< ptrdiff_t > & | imapp, | ||
const unsigned long long * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const std::vector< ptrdiff_t > & | stridep, | ||
const std::vector< ptrdiff_t > & | imapp, | ||
const unsigned short * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const std::vector< ptrdiff_t > & | stridep, | ||
const std::vector< ptrdiff_t > & | imapp, | ||
const void * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function in what argument(s) it accepts. In addition, no data conversion is carried out. This means that the type of the data in memory must match the type of the variable.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const std::vector< ptrdiff_t > & | stridep, | ||
const unsigned char * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const std::vector< ptrdiff_t > & | stridep, | ||
const unsigned int * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const std::vector< ptrdiff_t > & | stridep, | ||
const unsigned long long * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const std::vector< ptrdiff_t > & | stridep, | ||
const unsigned short * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const std::vector< ptrdiff_t > & | stridep, | ||
const void * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function in what argument(s) it accepts. In addition, no data conversion is carried out. This means that the type of the data in memory must match the type of the variable.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const unsigned char * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const unsigned int * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const unsigned long long * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const unsigned short * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void netCDF::NcVar::putVar | ( | const std::vector< size_t > & | startp, |
const std::vector< size_t > & | countp, | ||
const void * | dataValues | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function in what argument(s) it accepts. In addition, no data conversion is carried out. This means that the type of the data in memory must match the type of the variable.
void NcVar::putVar | ( | const unsigned char * | dataValues | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void NcVar::putVar | ( | const unsigned int * | dataValues | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void NcVar::putVar | ( | const unsigned long long * | dataValues | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void NcVar::putVar | ( | const unsigned short * | dataValues | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void NcVar::putVar | ( | const void * | dataValues | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function in what argument(s) it accepts. In addition, no data conversion is carried out. This means that the type of the data in memory must match the type of the variable.
void NcVar::rename | ( | const std::string & | newname | ) | const |
Rename the variable.
void NcVar::setChecksum | ( | ChecksumMode | checksumMode | ) | const |
Sets the checksum parameters of a variable.
ChecksumMode | Enumeration type. Allowable parameters are: "nc_NOCHECKSUM", "nc_FLETCHER32". |
void NcVar::setChunkCache | ( | size_t | size, |
size_t | nelems, | ||
float | preemption | ||
) | const |
Change cache setttings for a chunked variable.
void NcVar::setChunking | ( | ChunkMode | chunkMode, |
std::vector< size_t > & | chunksizes | ||
) | const |
Sets chunking parameters.
chunkMode | Enumeration type. Allowable parameters are: "nc_CONTIGUOUS", "nc_CHUNKED" |
chunksizes | Shape of chunking, used if ChunkMode=nc_CHUNKED. |
void NcVar::setCompression | ( | bool | enableShuffleFilter, |
bool | enableDeflateFilter, | ||
int | deflateLevel | ||
) | const |
Sets the compression parameters
enableShuffleFilter | Set to true to turn on shuffle filter. |
enableDeflateFilter | Set to true to turn on deflate filter. |
deflateLevel | The deflate level, must be 0 and 9. |
void NcVar::setEndianness | ( | EndianMode | endianMode | ) | const |
Sets the endianness of the variable.
Endianness | enumeration type. Allowable parameters are: "nc_ENDIAN_NATIVE" (the default), "nc_ENDIAN_LITTLE", "nc_ENDIAN_BIG" |
void NcVar::setFill | ( | bool | fillMode, |
const void * | fillValue = NULL |
||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function in what argument(s) it accepts. The function can be used for any type, including user-defined types.
fillMode | Setting to true, turns on fill mode. |
fillValue | Pointer to fill value. Must be the same type as the variable. Ignored if fillMode=.false. |
|
inline |
Sets the fill parameters
fillMode | Setting to true, turns on fill mode. |
fillValue | Fill value for the variable. Must be the same type as the variable. Ignored if fillMode=.false. |
void NcVar::setFill | ( | bool | fillMode, |
void * | fillValue = NULL |
||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void NcVar::setFilter | ( | unsigned int | id, |
size_t | nparams, | ||
const unsigned int * | parms | ||
) | const |
Define new variable for compression/decompression.