ncutils::NCVar Struct Reference

Representation of a NetCDF variable. More...

#include <ERF_NCInterface.H>

Collaboration diagram for ncutils::NCVar:

Public Member Functions
std::string	name () const
	Name of this variable. More...
int	ndim () const
	Number of array dimensions for this variable. More...
std::vector< size_t >	shape () const
	Shape of the array (size in each array dimension) More...
void	put (const double *) const
	Write out the entire variable. More...
void	put (const float *) const
void	put (const int *) const
void	put (const double *, const std::vector< size_t > &, const std::vector< size_t > &) const
	Write out a slice of data. More...
void	put (const double *, const std::vector< size_t > &, const std::vector< size_t > &, const std::vector< ptrdiff_t > &) const
void	put (const float *, const std::vector< size_t > &, const std::vector< size_t > &) const
	Write out a slice of data. More...
void	put (const float *, const std::vector< size_t > &, const std::vector< size_t > &, const std::vector< ptrdiff_t > &) const
void	put (const int *, const std::vector< size_t > &, const std::vector< size_t > &) const
void	put (const int *, const std::vector< size_t > &, const std::vector< size_t > &, const std::vector< ptrdiff_t > &) const
void	put (const char **, const std::vector< size_t > &, const std::vector< size_t > &) const
void	put (const char **dptr, const std::vector< size_t > &start, const std::vector< size_t > &count, const std::vector< ptrdiff_t > &stride) const
void	get (double *) const
	Read the entire variable from file. More...
void	get (float *) const
void	get (int *) const
void	get (double *, const std::vector< size_t > &, const std::vector< size_t > &) const
	Read a chunk of data from the file. More...
void	get (double *, const std::vector< size_t > &, const std::vector< size_t > &, const std::vector< ptrdiff_t > &) const
	Read a chunk of data with strides. More...
void	get (float *, const std::vector< size_t > &, const std::vector< size_t > &) const
	Read a chunk of data from the file. More...
void	get (float *, const std::vector< size_t > &, const std::vector< size_t > &, const std::vector< ptrdiff_t > &) const
	Read a chunk of data with strides. More...
void	get (int *, const std::vector< size_t > &, const std::vector< size_t > &) const
void	get (int *, const std::vector< size_t > &, const std::vector< size_t > &, const std::vector< ptrdiff_t > &) const
void	get (char *, const std::vector< size_t > &, const std::vector< size_t > &) const
	Read a chunk of data from the file. More...
void	get (char *, const std::vector< size_t > &, const std::vector< size_t > &, const std::vector< ptrdiff_t > &) const
	Read a chunk of data with strides. More...
bool	has_attr (const std::string &name) const
void	put_attr (const std::string &name, const std::string &value) const
void	put_attr (const std::string &name, const std::vector< double > &value) const
void	put_attr (const std::string &name, const std::vector< float > &value) const
void	put_attr (const std::string &name, const std::vector< int > &value) const
std::string	get_attr (const std::string &name) const
void	get_attr (const std::string &name, std::vector< double > &value) const
void	get_attr (const std::string &name, std::vector< float > &value) const
void	get_attr (const std::string &name, std::vector< int > &value) const
void	par_access (int cmode) const

Public Attributes
const int	ncid
	File/Group identifier. More...
const int	varid
	Variable ID used with NetCDF API. More...

Detailed Description

Representation of a NetCDF variable.

Member Function Documentation

get() [1/11]

void ncutils::NCVar::get	(	char *	dptr,
		const std::vector< size_t > &	start,
		const std::vector< size_t > &	count
	)		const

Read a chunk of data from the file.

{
    check_nc_error(
            nc_get_vara_text(ncid, varid, start.data(), count.data(), dptr));
}

get() [2/11]

void ncutils::NCVar::get	(	char *	dptr,
		const std::vector< size_t > &	start,
		const std::vector< size_t > &	count,
		const std::vector< ptrdiff_t > &	stride
	)		const

Read a chunk of data with strides.

{
    check_nc_error(nc_get_vars_text(
            ncid, varid, start.data(), count.data(), stride.data(), dptr));
}

get() [3/11]

void ncutils::NCVar::get

(

double *

ptr

)

const

Read the entire variable from file.

Error-checking wrapper for NetCDF function nc_get_var_double

Parameters

ptr	Pointer to the data location we use to get

{
    check_nc_error(nc_get_var_double(ncid, varid, ptr));
}

get() [4/11]

void ncutils::NCVar::get	(	double *	dptr,
		const std::vector< size_t > &	start,
		const std::vector< size_t > &	count
	)		const

Read a chunk of data from the file.

Error-checking wrapper for NetCDF function nc_get_vara_double

Parameters

dptr	Pointer to the data location for get
start	Starting indices
count	Count sizes

{
    check_nc_error(
        nc_get_vara_double(ncid, varid, start.data(), count.data(), dptr));
}

get() [5/11]

void ncutils::NCVar::get	(	double *	dptr,
		const std::vector< size_t > &	start,
		const std::vector< size_t > &	count,
		const std::vector< ptrdiff_t > &	stride
	)		const

Read a chunk of data with strides.

Error-checking wrapper for NetCDF function nc_get_vars_double

Parameters

dptr	Pointer to the data location for get
start	Starting indices
count	Count sizes
stride	Stride length for the data

{
    check_nc_error(nc_get_vars_double(
        ncid, varid, start.data(), count.data(), stride.data(), dptr));
}

get() [6/11]

void ncutils::NCVar::get

(

float *

ptr

)

const

Error-checking wrapper for NetCDF function nc_get_var_float

Parameters

ptr	Pointer to the data location we use to get

{
    check_nc_error(nc_get_var_float(ncid, varid, ptr));
}

get() [7/11]

void ncutils::NCVar::get	(	float *	dptr,
		const std::vector< size_t > &	start,
		const std::vector< size_t > &	count
	)		const

Read a chunk of data from the file.

Error-checking wrapper for NetCDF function nc_get_vara_float

Parameters

dptr	Pointer to the data location for get
start	Starting indices
count	Count sizes

{
    check_nc_error(
        nc_get_vara_float(ncid, varid, start.data(), count.data(), dptr));
}

get() [8/11]

void ncutils::NCVar::get	(	float *	dptr,
		const std::vector< size_t > &	start,
		const std::vector< size_t > &	count,
		const std::vector< ptrdiff_t > &	stride
	)		const

Read a chunk of data with strides.

Error-checking wrapper for NetCDF function nc_get_vars_float

Parameters

dptr	Pointer to the data location for get
start	Starting indices
count	Count sizes
stride	Stride length for the data

{
    check_nc_error(nc_get_vars_float(
        ncid, varid, start.data(), count.data(), stride.data(), dptr));
}

get() [9/11]

void ncutils::NCVar::get

(

int *

ptr

)

const

Error-checking wrapper for NetCDF function nc_get_var_int

Parameters

ptr	Pointer to the data location we use to get

{
    check_nc_error(nc_get_var_int(ncid, varid, ptr));
}

get() [10/11]

void ncutils::NCVar::get	(	int *	dptr,
		const std::vector< size_t > &	start,
		const std::vector< size_t > &	count
	)		const

{
    check_nc_error(
        nc_get_vara_int(ncid, varid, start.data(), count.data(), dptr));
}

get() [11/11]

void ncutils::NCVar::get	(	int *	dptr,
		const std::vector< size_t > &	start,
		const std::vector< size_t > &	count,
		const std::vector< ptrdiff_t > &	stride
	)		const

{
    check_nc_error(nc_get_vars_int(
        ncid, varid, start.data(), count.data(), stride.data(), dptr));
}

get_attr() [1/4]

std::string ncutils::NCVar::get_attr

(

const std::string &

name

)

const

{
    size_t lenp;
    std::vector<char> aval;
    check_nc_error(nc_inq_attlen(ncid, varid, name.data(), &lenp));
    aval.resize(lenp);
    check_nc_error(nc_get_att_text(ncid, varid, name.data(), aval.data()));
    return std::string{aval.begin(), aval.end()};
}

Here is the call graph for this function:

get_attr() [2/4]

void ncutils::NCVar::get_attr	(	const std::string &	name,
		std::vector< double > &	value
	)		const

{
    size_t lenp;
    check_nc_error(nc_inq_attlen(ncid, varid, name.data(), &lenp));
    values.resize(lenp);
    check_nc_error(nc_get_att_double(ncid, varid, name.data(), values.data()));
}

Here is the call graph for this function:

get_attr() [3/4]

void ncutils::NCVar::get_attr	(	const std::string &	name,
		std::vector< float > &	value
	)		const

{
    size_t lenp;
    check_nc_error(nc_inq_attlen(ncid, varid, name.data(), &lenp));
    values.resize(lenp);
    check_nc_error(nc_get_att_float(ncid, varid, name.data(), values.data()));
}

Here is the call graph for this function:

get_attr() [4/4]

void ncutils::NCVar::get_attr	(	const std::string &	name,
		std::vector< int > &	value
	)		const

{
    size_t lenp;
    check_nc_error(nc_inq_attlen(ncid, varid, name.data(), &lenp));
    values.resize(lenp);
    check_nc_error(nc_get_att_int(ncid, varid, name.data(), values.data()));
}

Here is the call graph for this function:

has_attr()

bool ncutils::NCVar::has_attr

(

const std::string &

name

)

const

{
    int ierr;
    size_t lenp;
    ierr = nc_inq_att(ncid, varid, name.data(), nullptr, &lenp);
    return (ierr == NC_NOERR);
}

Here is the call graph for this function:

name()

std::string ncutils::NCVar::name

(

)

const

Name of this variable.

Error-checking wrapper for NetCDF function nc_inq_varname

{
    check_nc_error(nc_inq_varname(ncid, varid, recname));
    return std::string(recname);
}

Referenced by get_attr(), has_attr(), and put_attr().

Here is the caller graph for this function:

ndim()

int ncutils::NCVar::ndim

(

)

const

Number of array dimensions for this variable.

Error-checking wrapper for NetCDF function nc_inq_varndims

{
    int ndims;
    check_nc_error(nc_inq_varndims(ncid, varid, &ndims));
    return ndims;
}

Referenced by shape().

Here is the caller graph for this function:

par_access()

void ncutils::NCVar::par_access

(

int

cmode

)

const

{
    check_nc_error(nc_var_par_access(ncid, varid, cmode));
}

put() [1/11]

void ncutils::NCVar::put	(	const char **	dptr,
		const std::vector< size_t > &	start,
		const std::vector< size_t > &	count
	)		const

Error-checking wrapper for NetCDF function nc_put_vara_string

Parameters

dptr	Pointer to the data to put
start	Starting indices
count	Count sizes

{
    check_nc_error(
        nc_put_vara_string(ncid, varid, start.data(), count.data(), dptr));
}

put() [2/11]

void ncutils::NCVar::put	(	const char **	dptr,
		const std::vector< size_t > &	start,
		const std::vector< size_t > &	count,
		const std::vector< ptrdiff_t > &	stride
	)		const

Error-checking wrapper for NetCDF function nc_put_vars_string

Parameters

dptr	Pointer to the data to put
start	Starting indices
count	Count sizes
stride	Stride length for the data

{
    check_nc_error(nc_put_vars_string(
        ncid, varid, start.data(), count.data(), stride.data(), dptr));
}

put() [3/11]

void ncutils::NCVar::put

(

const double *

ptr

)

const

Write out the entire variable.

Error-checking wrapper for NetCDF function nc_put_var_double

Parameters

ptr	Pointer to the data to put

{
    check_nc_error(nc_put_var_double(ncid, varid, ptr));
}

put() [4/11]

void ncutils::NCVar::put	(	const double *	dptr,
		const std::vector< size_t > &	start,
		const std::vector< size_t > &	count
	)		const

Write out a slice of data.

Error-checking wrapper for NetCDF function nc_put_vara_double

Parameters

dptr	Pointer to the data to put
start	Starting indices
count	Count sizes

{
    check_nc_error(
        nc_put_vara_double(ncid, varid, start.data(), count.data(), dptr));
}

put() [5/11]

void ncutils::NCVar::put	(	const double *	dptr,
		const std::vector< size_t > &	start,
		const std::vector< size_t > &	count,
		const std::vector< ptrdiff_t > &	stride
	)		const

Write out a slice of data with with strides (see hyperslab definition in NetCDF)

Error-checking wrapper for NetCDF function nc_put_vars_double

Parameters

dptr	Pointer to the data to put
start	Starting indices
count	Count sizes
stride	Stride length for the data

{
    check_nc_error(nc_put_vars_double(
        ncid, varid, start.data(), count.data(), stride.data(), dptr));
}

put() [6/11]

void ncutils::NCVar::put

(

const float *

ptr

)

const

Error-checking wrapper for NetCDF function nc_put_var_float

Parameters

ptr	Pointer to the data to put

{
    check_nc_error(nc_put_var_float(ncid, varid, ptr));
}

put() [7/11]

void ncutils::NCVar::put	(	const float *	dptr,
		const std::vector< size_t > &	start,
		const std::vector< size_t > &	count
	)		const

Write out a slice of data.

Error-checking wrapper for NetCDF function nc_put_vara_float

Parameters

dptr	Pointer to the data to put
start	Starting indices
count	Count sizes

{
    check_nc_error(
        nc_put_vara_float(ncid, varid, start.data(), count.data(), dptr));
}

put() [8/11]

void ncutils::NCVar::put	(	const float *	dptr,
		const std::vector< size_t > &	start,
		const std::vector< size_t > &	count,
		const std::vector< ptrdiff_t > &	stride
	)		const

Write out a slice of data with with strides (see hyperslab definition in NetCDF)

Error-checking wrapper for NetCDF function nc_put_vars_float

Parameters

dptr	Pointer to the data to put
start	Starting indices
count	Count sizes
stride	Stride length for the data

{
    check_nc_error(nc_put_vars_float(
        ncid, varid, start.data(), count.data(), stride.data(), dptr));
}

put() [9/11]

void ncutils::NCVar::put

(

const int *

ptr

)

const

Error-checking wrapper for NetCDF function nc_put_var_int

Parameters

ptr	Pointer to the data to put

{
    check_nc_error(nc_put_var_int(ncid, varid, ptr));
}

put() [10/11]

void ncutils::NCVar::put	(	const int *	dptr,
		const std::vector< size_t > &	start,
		const std::vector< size_t > &	count
	)		const

Error-checking wrapper for NetCDF function nc_put_vara_int

Parameters

dptr	Pointer to the data to put
start	Starting indices
count	Count sizes

{
    check_nc_error(
        nc_put_vara_int(ncid, varid, start.data(), count.data(), dptr));
}

put() [11/11]

void ncutils::NCVar::put	(	const int *	dptr,
		const std::vector< size_t > &	start,
		const std::vector< size_t > &	count,
		const std::vector< ptrdiff_t > &	stride
	)		const

Error-checking wrapper for NetCDF function nc_put_vars_int

Parameters

dptr	Pointer to the data to put
start	Starting indices
count	Count sizes
stride	Stride length for the data

{
    check_nc_error(nc_put_vars_int(
        ncid, varid, start.data(), count.data(), stride.data(), dptr));
}

put_attr() [1/4]

void ncutils::NCVar::put_attr	(	const std::string &	name,
		const std::string &	value
	)		const

{
    check_nc_error(
        nc_put_att_text(ncid, varid, name.data(), value.size(), value.data()));
}

Here is the call graph for this function:

put_attr() [2/4]

void ncutils::NCVar::put_attr	(	const std::string &	name,
		const std::vector< double > &	value
	)		const

{
    check_nc_error(nc_put_att_double(
        ncid, varid, name.data(), NC_DOUBLE, value.size(), value.data()));
}

Here is the call graph for this function:

put_attr() [3/4]

void ncutils::NCVar::put_attr	(	const std::string &	name,
		const std::vector< float > &	value
	)		const

{
    check_nc_error(nc_put_att_float(
        ncid, varid, name.data(), NC_FLOAT, value.size(), value.data()));
}

Here is the call graph for this function:

put_attr() [4/4]

void ncutils::NCVar::put_attr	(	const std::string &	name,
		const std::vector< int > &	value
	)		const

{
    check_nc_error(nc_put_att_int(
        ncid, varid, name.data(), NC_INT, value.size(), value.data()));
}

Here is the call graph for this function:

shape()

std::vector< size_t > ncutils::NCVar::shape

(

)

const

Shape of the array (size in each array dimension)

Error-checking function to get the length of each dimension from a NetCDF identity

{
    int ndims = ndim();
    std::vector<int> dimids(ndims);
    std::vector<size_t> vshape(ndims);
 
    for (int i = 0; i < ndims; ++i)
        check_nc_error(nc_inq_vardimid(ncid, varid, dimids.data()));
 
    for (int i = 0; i < ndims; ++i)
        check_nc_error(nc_inq_dimlen(ncid, dimids[i], &vshape[i]));
 
    return vshape;
}

Here is the call graph for this function:

Member Data Documentation

ncid

const int ncutils::NCVar::ncid

File/Group identifier.

Referenced by get(), get_attr(), has_attr(), name(), ndim(), par_access(), put(), put_attr(), and shape().

varid

const int ncutils::NCVar::varid

Variable ID used with NetCDF API.

Referenced by get(), get_attr(), has_attr(), name(), ndim(), par_access(), put(), put_attr(), and shape().

---

The documentation for this struct was generated from the following files:

• Source/IO/ERF_NCInterface.H
• Source/IO/ERF_NCInterface.cpp