NetCDF4 C++ API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | List of all members
netcdf::NcVarMetaCF Class Reference

Class for read/write CF-convention metadata for a netCDF variable. A typical set of attributes are known. More...

#include <NetCDF/cpp4/src/metadata/NcVarMetaCF.h>

Detailed Description

Copyright:
Copyright 2013 Colorado State University. All rights reserved.
Organization:
Natural Resource Ecology Laboratory
Colorado State University, Fort Collins, CO 80523 USA
www.nrel.colostate.edu
Project:
IRC <www.nrel.colostate.edu/projects/irc/>
Author
Tom Hilinski tom.h.nosp@m.ilin.nosp@m.ski@c.nosp@m.olos.nosp@m.tate..nosp@m.edu
Date
2013Jul
Examples:
Test_NcVarMetaCF.cpp.

Public Types

enum  MetaItem {
  Meta_longName, Meta_standardName, Meta_units, Meta_validMin,
  Meta_validMax, Meta_FillValue, Meta_Encoding, Meta_Unknown
}
 

Public Member Functions

 NcVarMetaCF (netcdf::NcVar &useNcVar)
 
template<class data_type >
void Set (MetaItem const which, data_type const &data)
 
void Set (MetaItem const which, std::string const &data)
 
void Set (MetaItem const which, char const *const data)
 
template<class data_type >
void Get (MetaItem const which, data_type &data)
 
bool Exists (MetaItem const which) const
 

Static Public Member Functions

static char const *const GetAttName (MetaItem const which)
 

Member Enumeration Documentation

enum netcdf::NcVarMetaCF::MetaItem
Enumerator
Meta_longName 

long_name : string

Meta_standardName 

standard_name : string

Meta_units 

units : string

Meta_validMin 

valid_min : numeric type

Meta_validMax 

valid_max : numeric type

Meta_FillValue 

_FillValue : matching type

Meta_Encoding 

_Encoding : string

Meta_Unknown 

Constructor & Destructor Documentation

netcdf::NcVarMetaCF::NcVarMetaCF ( netcdf::NcVar &  useNcVar)
inline

Member Function Documentation

bool netcdf::NcVarMetaCF::Exists ( MetaItem const  which) const
inline
template<class data_type >
void netcdf::NcVarMetaCF::Get ( MetaItem const  which,
data_type &  data 
)
inline
static char const* const netcdf::NcVarMetaCF::GetAttName ( MetaItem const  which)
inlinestatic
template<class data_type >
void netcdf::NcVarMetaCF::Set ( MetaItem const  which,
data_type const &  data 
)
inline
void netcdf::NcVarMetaCF::Set ( MetaItem const  which,
std::string const &  data 
)
inline
void netcdf::NcVarMetaCF::Set ( MetaItem const  which,
char const *const  data 
)
inline
The documentation for this class was generated from the following files: