NetCDF-C++ 4.3.1
netCDF Namespace Reference

C++ API for netCDF4. More...

Namespaces

namespace  exceptions
 Exception classes.
 

Data Structures

class  NcAtt
 Abstract base class represents inherited by ncVarAtt and ncGroupAtt. More...
 
class  NcByte
 Class represents a netCDF atomic Byte type. More...
 
class  NcChar
 Class represents a netCDF atomic Char type. More...
 
class  NcCompoundType
 Class represents a netCDF compound type. More...
 
class  NcDim
 Class represents a netCDF dimension. More...
 
class  NcDouble
 Class represents a netCDF atomic Double type. More...
 
class  NcEnumType
 Class represents a netCDF enum type. More...
 
class  NcFile
 Class represents a netCDF root group. More...
 
class  NcFloat
 Class represents a netCDF atomic Float type. More...
 
class  NcGroup
 Class represents a netCDF group. More...
 
class  NcGroupAtt
 Class represents a netCDF group attribute. More...
 
class  NcInt
 Class represents a netCDF atomic Int type. More...
 
class  NcInt64
 Class represents a netCDF atomic Int64 type. More...
 
class  NcOpaqueType
 Class represents a netCDF opaque type. More...
 
class  NcShort
 Class represents a netCDF atomic Short type. More...
 
class  NcString
 Class represents a netCDF atomic String type. More...
 
class  NcType
 Base class inherited by NcOpaque, NcVlen, NcCompound and NcEnum classes. More...
 
class  NcUbyte
 Class represents a netCDF atomic Ubyte type. More...
 
class  NcUint
 Class represents a netCDF atomic Uint type. More...
 
class  NcUint64
 Class represents a netCDF atomic Uint64 type. More...
 
class  NcUshort
 Class represents a netCDF atomic Ushort type. More...
 
class  NcVar
 Class represents a netCDF variable. More...
 
class  NcVarAtt
 Class represents a netCDF attribute local to a netCDF variable. More...
 
class  NcVlenType
 Class represents a netCDF VLEN type. More...
 

Functions

void ncCheck (int retCode, const char *file, int line)
 Function checks error code and if necessary throws an exception. More...
 
void ncCheckDataMode (int ncid)
 Function checks if the file (group) is in data mode. More...
 
void ncCheckDefineMode (int ncid)
 Function checks if the file (group) is in define mode. More...
 
bool operator< (const NcDim &lhs, const NcDim &rhs)
 
bool operator< (const NcGroup &lhs, const NcGroup &rhs)
 
bool operator< (const NcGroupAtt &lhs, const NcGroupAtt &rhs)
 
bool operator< (const NcType &lhs, const NcType &rhs)
 
bool operator< (const NcVar &lhs, const NcVar &rhs)
 
bool operator< (const NcVarAtt &lhs, const NcVarAtt &rhs)
 
bool operator> (const NcDim &lhs, const NcDim &rhs)
 
bool operator> (const NcGroup &lhs, const NcGroup &rhs)
 
bool operator> (const NcGroupAtt &lhs, const NcGroupAtt &rhs)
 
bool operator> (const NcType &lhs, const NcType &rhs)
 
bool operator> (const NcVar &lhs, const NcVar &rhs)
 
bool operator> (const NcVarAtt &lhs, const NcVarAtt &rhs)
 

Variables

NcByte ncByte
 A global instance of the NcByte class within the netCDF namespace. More...
 
NcChar ncChar
 A global instance of the NcChar class within the netCDF namespace. More...
 
NcDouble ncDouble
 A global instance of the NcDouble class within the netCDF namespace. More...
 
NcFloat ncFloat
 A global instance of the NcFloat class within the netCDF namespace. More...
 
NcInt ncInt
 A global instance of the NcInt class within the netCDF namespace. More...
 
NcInt64 ncInt64
 A global instance of the NcInt64 class within the netCDF namespace. More...
 
NcShort ncShort
 A global instance of the NcShort class within the netCDF namespace. More...
 
NcString ncString
 A global instance of the NcString class within the netCDF namespace. More...
 
NcUbyte ncUbyte
 A global instance of the NcUbyte class within the netCDF namespace. More...
 
NcUint ncUint
 A global instance of the NcUint class within the netCDF namespace. More...
 
NcUint64 ncUint64
 A global instance of the NcUint64 class within the netCDF namespace. More...
 
NcUshort ncUshort
 

Detailed Description

C++ API for netCDF4.

Function Documentation

◆ ncCheck()

void netCDF::ncCheck ( int  retCode,
const char *  file,
int  line 
)

Function checks error code and if necessary throws an exception.

Parameters
retCodeInteger value returned by netCDF C-routines.
fileThe name of the file from which this call originates.
lineThe line number in the file from which this call originates.

Definition at line 11 of file ncCheck.cpp.

◆ ncCheckDataMode()

void netCDF::ncCheckDataMode ( int  ncid)

Function checks if the file (group) is in data mode.

If not, it places it in the data mode. While this is automatically done by the underlying C API for netCDF-4 files, the netCDF-3 files still need this call.

Definition at line 89 of file ncCheck.cpp.

◆ ncCheckDefineMode()

void netCDF::ncCheckDefineMode ( int  ncid)

Function checks if the file (group) is in define mode.

If not, it places it in the define mode. While this is automatically done by the underlying C API for netCDF-4 files, the netCDF-3 files still need this call.

Definition at line 83 of file ncCheck.cpp.

◆ operator<() [1/6]

bool netCDF::operator< ( const NcDim lhs,
const NcDim rhs 
)

Definition at line 11 of file ncDim.cpp.

◆ operator<() [2/6]

bool netCDF::operator< ( const NcGroup lhs,
const NcGroup rhs 
)

Definition at line 28 of file ncGroup.cpp.

◆ operator<() [3/6]

bool netCDF::operator< ( const NcGroupAtt lhs,
const NcGroupAtt rhs 
)

Definition at line 11 of file ncGroupAtt.cpp.

◆ operator<() [4/6]

bool netCDF::operator< ( const NcType lhs,
const NcType rhs 
)

Definition at line 12 of file ncType.cpp.

◆ operator<() [5/6]

bool netCDF::operator< ( const NcVar lhs,
const NcVar rhs 
)

Definition at line 14 of file ncVar.cpp.

◆ operator<() [6/6]

bool netCDF::operator< ( const NcVarAtt lhs,
const NcVarAtt rhs 
)

Definition at line 12 of file ncVarAtt.cpp.

◆ operator>() [1/6]

bool netCDF::operator> ( const NcDim lhs,
const NcDim rhs 
)

Definition at line 17 of file ncDim.cpp.

◆ operator>() [2/6]

bool netCDF::operator> ( const NcGroup lhs,
const NcGroup rhs 
)

Definition at line 34 of file ncGroup.cpp.

◆ operator>() [3/6]

bool netCDF::operator> ( const NcGroupAtt lhs,
const NcGroupAtt rhs 
)

Definition at line 17 of file ncGroupAtt.cpp.

◆ operator>() [4/6]

bool netCDF::operator> ( const NcType lhs,
const NcType rhs 
)

Definition at line 18 of file ncType.cpp.

◆ operator>() [5/6]

bool netCDF::operator> ( const NcVar lhs,
const NcVar rhs 
)

Definition at line 20 of file ncVar.cpp.

◆ operator>() [6/6]

bool netCDF::operator> ( const NcVarAtt lhs,
const NcVarAtt rhs 
)

Definition at line 18 of file ncVarAtt.cpp.

Variable Documentation

◆ ncByte

NcByte netCDF::ncByte

A global instance of the NcByte class within the netCDF namespace.

Definition at line 7 of file ncByte.cpp.

◆ ncChar

NcChar netCDF::ncChar

A global instance of the NcChar class within the netCDF namespace.

Definition at line 7 of file ncChar.cpp.

◆ ncDouble

NcDouble netCDF::ncDouble

A global instance of the NcDouble class within the netCDF namespace.

Definition at line 7 of file ncDouble.cpp.

◆ ncFloat

NcFloat netCDF::ncFloat

A global instance of the NcFloat class within the netCDF namespace.

Definition at line 7 of file ncFloat.cpp.

◆ ncInt

NcInt netCDF::ncInt

A global instance of the NcInt class within the netCDF namespace.

Definition at line 7 of file ncInt.cpp.

◆ ncInt64

NcInt64 netCDF::ncInt64

A global instance of the NcInt64 class within the netCDF namespace.

Definition at line 7 of file ncInt64.cpp.

◆ ncShort

NcShort netCDF::ncShort

A global instance of the NcShort class within the netCDF namespace.

Definition at line 7 of file ncShort.cpp.

◆ ncString

NcString netCDF::ncString

A global instance of the NcString class within the netCDF namespace.

Definition at line 7 of file ncString.cpp.

◆ ncUbyte

NcUbyte netCDF::ncUbyte

A global instance of the NcUbyte class within the netCDF namespace.

Definition at line 7 of file ncUbyte.cpp.

◆ ncUint

NcUint netCDF::ncUint

A global instance of the NcUint class within the netCDF namespace.

Definition at line 7 of file ncUint.cpp.

◆ ncUint64

NcUint64 netCDF::ncUint64

A global instance of the NcUint64 class within the netCDF namespace.

Definition at line 7 of file ncUint64.cpp.

◆ ncUshort

NcUshort netCDF::ncUshort

Definition at line 7 of file ncUshort.cpp.


Return to the Main Unidata NetCDF page.
Generated on Wed Nov 10 2021 15:25:08 for NetCDF-C++. NetCDF is a Unidata library.