MeteoIODoc 2.11.0
Public Member Functions | Public Attributes | List of all members
nc_variable Struct Reference

Detailed Description

This structure contains the metadata associated with a NetCDF variable that are file specific as well as contains the schema specific metadata

#include <libncpp.h>

Public Member Functions

 NC_VARIABLE ()
 
 NC_VARIABLE (const int &i_type)
 
 NC_VARIABLE (const var_attr &attr, const double &i_nodata)
 
 NC_VARIABLE (const var_attr &attr, const size_t &i_dimid_time, const size_t &i_dimid_X, const size_t &i_dimid_Y, const double &i_scale, const double &i_offset, const double &i_nodata, const int &i_varid)
 
bool isUndef () const
 
std::string toString () const
 

Public Attributes

var_attr attributes
 metadata about the variable More...
 
std::vector< int > dimids
 dimensions this variable depends on More...
 
size_t dimid_time
 dimension sequence for time variable More...
 
size_t dimid_X
 dimension sequence for longitude/easting More...
 
size_t dimid_Y
 dimension sequence for latitude/northing More...
 
double scale
 
double offset
 
double nodata
 scale and offset for data packing, nodata value More...
 
int varid
 variable ID, set to -1 and then to a positive value after reading/writing to/from a file More...
 

Member Function Documentation

◆ isUndef()

bool nc_variable::isUndef ( ) const
inline

◆ NC_VARIABLE() [1/4]

nc_variable::NC_VARIABLE ( )
inline

◆ NC_VARIABLE() [2/4]

nc_variable::NC_VARIABLE ( const int &  i_type)
inline

◆ NC_VARIABLE() [3/4]

nc_variable::NC_VARIABLE ( const var_attr &  attr,
const double &  i_nodata 
)
inline

◆ NC_VARIABLE() [4/4]

nc_variable::NC_VARIABLE ( const var_attr &  attr,
const size_t &  i_dimid_time,
const size_t &  i_dimid_X,
const size_t &  i_dimid_Y,
const double &  i_scale,
const double &  i_offset,
const double &  i_nodata,
const int &  i_varid 
)
inline

◆ toString()

std::string nc_variable::toString ( ) const
inline

Member Data Documentation

◆ attributes

var_attr nc_variable::attributes

metadata about the variable

◆ dimid_time

size_t nc_variable::dimid_time

dimension sequence for time variable

◆ dimid_X

size_t nc_variable::dimid_X

dimension sequence for longitude/easting

◆ dimid_Y

size_t nc_variable::dimid_Y

dimension sequence for latitude/northing

◆ dimids

std::vector<int> nc_variable::dimids

dimensions this variable depends on

◆ nodata

double nc_variable::nodata

scale and offset for data packing, nodata value

◆ offset

double nc_variable::offset

◆ scale

double nc_variable::scale

◆ varid

int nc_variable::varid

variable ID, set to -1 and then to a positive value after reading/writing to/from a file

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