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

Represents a netCDF group attribute. More...

#include <NetCDF/cpp4/src/NcGroupAtt.h>

+ Inheritance diagram for netcdf::NcGroupAtt:

Detailed Description

Copyright:
Original C++ API developed by Lynton Appel.
Portions of this software were developed by the Unidata Program at the
University Corporation for Atmospheric Research.
Modifications: 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
2013Jan

Public Member Functions

 NcGroupAtt (int const useFileID, NcGroup const &grp, const int index, std::string const attName)
 attribute name More...
 
 NcGroupAtt (NcGroupAtt const &rhs)
 Simple copy of attribute; does not affect file. More...
 
 NcGroupAtt (int const useGroupID, NcGroupAtt const &rhs)
 Copy attribute and its data to this variable. More...
 
NcGroupAtt & operator= (NcGroupAtt const &rhs)
 Copy attribute to this variable. More...
 
- Public Member Functions inherited from netcdf::NcAtt
virtual ~NcAtt ()
 
 NcAtt ()
 
 NcAtt (bool const isNullObject)
 
 NcAtt (int const useFileID, int const useID, std::string const attName, int const useGroupID=nullID, int const useVarID=NcItem::idGlobal)
 variable ID number More...
 
 NcAtt (NcAtt const &rhs)
 Simple copy of attribute; does not affect file. More...
 
 NcAtt (int const useID, NcAtt const &rhs)
 Copy attribute and its data to this variable. More...
 
NcAtt & operator= (NcAtt const &rhs)
 Copy attribute to this variable. More...
 
int Size () const
 number of elements More...
 
NcType GetType () const
 
NcGroup GetParentGroup () const
 
int const GetVarID () const
 
bool operator== (NcAtt const &rhs) const
 
bool operator!= (NcAtt const &rhs) const
 
bool operator< (NcAtt const &rhs) const
 
void Get (TVecUbyte &data) const
 get NcUbyte vector More...
 
void Get (TVecByte &data) const
 get NcByte vector More...
 
void Get (TVecChar &data) const
 get NcChar vector More...
 
void Get (TVecShort &data) const
 get NcShort vector More...
 
void Get (TVecUshort &data) const
 get NcUshort vector More...
 
void Get (TVecInt &data) const
 get NcInt vector More...
 
void Get (TVecUint &data) const
 get NcUint vector More...
 
void Get (TVecFloat &data) const
 get NcFloat vector More...
 
void Get (TVecDouble &data) const
 get NcDouble vector More...
 
void Get (TVecInt64 &data) const
 get NcInt64 vector More...
 
void Get (TVecUint64 &data) const
 get NcUint64 vector More...
 
void Get (TVecString &data) const
 get NcString vector More...
 
void Get (unsigned char &data) const
 get NcUbyte More...
 
void Get (signed char &data) const
 get NcByte More...
 
void Get (char &data) const
 get NcChar More...
 
void Get (short &data) const
 get NcShort More...
 
void Get (unsigned short &data) const
 get NcUshort More...
 
void Get (int &data) const
 get NcInt More...
 
void Get (long &data) const
 get NcInt More...
 
void Get (unsigned int &data) const
 get NcUint More...
 
void Get (unsigned long &data) const
 get NcUint More...
 
void Get (float &data) const
 get NcFloat More...
 
void Get (double &data) const
 get NcDouble More...
 
void Get (long long &data) const
 get NcInt64 More...
 
void Get (unsigned long long &data) const
 get NcUint64 More...
 
void Get (unsigned char *const data) const
 get NcUbyte More...
 
void Get (signed char *const data) const
 get NcByte More...
 
void Get (char *const data) const
 get NcChar More...
 
void Get (short *const data) const
 get NcShort More...
 
void Get (unsigned short *const data) const
 get NcUshort More...
 
void Get (int *const data) const
 get NcInt More...
 
void Get (long *const data) const
 get NcInt More...
 
void Get (unsigned int *const data) const
 get NcUint More...
 
void Get (float *const data) const
 get NcFloat More...
 
void Get (double *const data) const
 get NcDouble More...
 
void Get (long long *const data) const
 get NcInt64 More...
 
void Get (unsigned long long *const data) const
 get NcUint64 More...
 
void Get (char **const data) const
 get NcString More...
 
void Get (std::string &data) const
 get NcString More...
 
void Get (void *data) const
 
virtual void Rename (std::string const &newname)
 
- Public Member Functions inherited from netcdf::NcItem
virtual ~NcItem ()=0
 
bool IsNull () const
 
std::string const & GetName () const
 
int GetID () const
 
int GetGroupID () const
 
int GetFileID () const
 
NcItem & operator= (NcItem const &rhs)
 
bool operator== (NcItem const &rhs) const
 
bool operator!= (NcItem const &rhs) const
 
bool operator< (NcItem const &rhs) const
 

Additional Inherited Members

- Public Types inherited from netcdf::NcAtt
typedef std::multimap
< std::string, NcType > 		NcTypeMap
 
- Public Types inherited from netcdf::NcItem
enum  { idGlobal = NC_GLOBAL }
 
- Static Public Attributes inherited from netcdf::NcItem
static int const nullID = -999
 
- Protected Member Functions inherited from netcdf::NcItem
 NcItem (bool const isNullObject=true)
 
 NcItem (int const useFileID, int const useID, int const useGroupID=NcItem::idGlobal, std::string const useName=std::string())
 
 NcItem (NcItem const &rhs)
 
void Copy (NcItem const &rhs)
 
- Protected Attributes inherited from netcdf::NcItem
bool nullObject
 
int myID
 object ID number More...
 
int groupID
 group ID number (can be unused) More...
 
int fileID
 netCDF file ID number More...
 
std::string myName
 optional name of object More...
 

Constructor & Destructor Documentation

netcdf::NcGroupAtt::NcGroupAtt ( int const  useFileID,
NcGroup const &  grp,
const int  index,
std::string const  attName 
)
Parameters
useFileIDnetCDF file ID number
grpParent Group object
indexindex (id) of the attribute
netcdf::NcGroupAtt::NcGroupAtt ( NcGroupAtt const &  rhs)
inline
netcdf::NcGroupAtt::NcGroupAtt ( int const  useGroupID,
NcGroupAtt const &  rhs 
)

attribute to copy

Parameters
useGroupIDdestination group ID number

Member Function Documentation

NcGroupAtt& netcdf::NcGroupAtt::operator= ( NcGroupAtt const &  rhs)
inline
The documentation for this class was generated from the following files: