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

Base class for NcAtt, NcVar, NcDim, NcGroup. More...

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

+ Inheritance diagram for netcdf::NcItem:

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
2013Jan

Public Types

enum  { idGlobal = NC_GLOBAL }
 

Public Member Functions

virtual ~NcItem ()=0
 
bool IsNull () const
 
std::string const & GetName () const
 
int GetID () const
 
int GetGroupID () const
 
int GetFileID () const
 
virtual void Rename (std::string const &newName)=0
 
NcItem & operator= (NcItem const &rhs)
 
bool operator== (NcItem const &rhs) const
 
bool operator!= (NcItem const &rhs) const
 
bool operator< (NcItem const &rhs) const
 

Static Public Attributes

static int const nullID = -999
 

Protected Member Functions

 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

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...
 

Member Enumeration Documentation

anonymous enum
Enumerator
idGlobal 

Constructor & Destructor Documentation

netcdf::NcItem::~NcItem ( )
inlinepure virtual
netcdf::NcItem::NcItem ( bool const  isNullObject = true)
inlineprotected
netcdf::NcItem::NcItem ( int const  useFileID,
int const  useID,
int const  useGroupID = NcItem::idGlobal,
std::string const  useName = std::string() 
)
inlineprotected
Parameters
useFileIDnetCDF file ID number
useIDobject ID number
useGroupIDgroup ID number (can be unused)
useNameoptional name of object
netcdf::NcItem::NcItem ( NcItem const &  rhs)
inlineprotected

Member Function Documentation

void netcdf::NcItem::Copy ( NcItem const &  rhs)
inlineprotected
int netcdf::NcItem::GetFileID ( ) const
inline
int netcdf::NcItem::GetGroupID ( ) const
inline
int netcdf::NcItem::GetID ( ) const
inline
std::string const& netcdf::NcItem::GetName ( ) const
inline
bool netcdf::NcItem::IsNull ( ) const
inline
Examples:
Test_NcString.cpp.
bool netcdf::NcItem::operator!= ( NcItem const &  rhs) const
inline
bool netcdf::NcItem::operator< ( NcItem const &  rhs) const
inline
NcItem& netcdf::NcItem::operator= ( NcItem const &  rhs)
inline
bool netcdf::NcItem::operator== ( NcItem const &  rhs) const
inline
virtual void netcdf::NcItem::Rename ( std::string const &  newName)
pure virtual

Implemented in netcdf::NcGroup, netcdf::NcAtt, netcdf::NcVar, and netcdf::NcDim.

Member Data Documentation

int netcdf::NcItem::fileID
protected
int netcdf::NcItem::groupID
protected
int netcdf::NcItem::myID
protected
std::string netcdf::NcItem::myName
protected
int const netcdf::NcItem::nullID = -999
static
bool netcdf::NcItem::nullObject
protected
The documentation for this class was generated from the following file: