netCDF::NcDim Class Reference

Class represents a netCDF dimension. More...

#include "ncDim.h"

Public Member Functions
	NcDim ()
	Constructor generates a null object.
	NcDim (const NcDim &ncDim)
	The copy constructor.
	NcDim (const NcGroup &grp, int dimId)
	Constructor for a dimension .
	~NcDim ()
	destructor
int	getId () const
	The netCDF Id of this dimension.
std::string	getName () const
	The name of this dimension.
NcGroup	getParentGroup () const
	Gets a NcGroup object of the parent group.
size_t	getSize () const
	The size of the dimension; for unlimited, this is the number of records written so far.
bool	isNull () const
	Returns true if this object is null (i.e.
bool	isUnlimited () const
	Returns true if this is an unlimited dimension.
bool	operator!= (const NcDim &rhs) const
	!= operator
NcDim &	operator= (const NcDim &)
	assignment operator
bool	operator== (const NcDim &rhs) const
	equivalence operator
void	rename (const std::string &newName)
	renames the dimension

Friends
bool	operator< (const NcDim &lhs, const NcDim &rhs)
	comparator operator
bool	operator> (const NcDim &lhs, const NcDim &rhs)
	comparator operator

Detailed Description

Class represents a netCDF dimension.

Definition at line 13 of file ncDim.h.

Constructor & Destructor Documentation

~NcDim()

netCDF::NcDim::~NcDim ( )

inline

destructor

Definition at line 18 of file ncDim.h.

NcDim() [1/3]

NcDim::NcDim

(

)

Constructor generates a null object.

Definition at line 64 of file ncDim.cpp.

NcDim() [2/3]

NcDim::NcDim	(	const NcGroup &	grp,
		int	dimId )

Constructor for a dimension .

The dimension must already exist in the netCDF file. New netCDF variables can be added using NcGroup::addNcDim();

Parameters

grp	Parent NcGroup object.
dimId	Id of the NcDim object.

Definition at line 69 of file ncDim.cpp.

NcDim() [3/3]

NcDim::NcDim

(

const NcDim &

ncDim

)

The copy constructor.

Definition at line 35 of file ncDim.cpp.

Member Function Documentation

getId()

int netCDF::NcDim::getId ( ) const

inline

The netCDF Id of this dimension.

Definition at line 47 of file ncDim.h.

getName()

string NcDim::getName

(

)

const

The name of this dimension.

Definition at line 106 of file ncDim.cpp.

getParentGroup()

NcGroup NcDim::getParentGroup

(

)

const

Gets a NcGroup object of the parent group.

Definition at line 59 of file ncDim.cpp.

getSize()

size_t NcDim::getSize

(

)

const

The size of the dimension; for unlimited, this is the number of records written so far.

Definition at line 77 of file ncDim.cpp.

isNull()

bool netCDF::NcDim::isNull ( ) const

inline

Returns true if this object is null (i.e.

it has no contents); otherwise returns false.

Definition at line 62 of file ncDim.h.

isUnlimited()

bool NcDim::isUnlimited

(

)

const

Returns true if this is an unlimited dimension.

Definition at line 86 of file ncDim.cpp.

operator!=()

bool NcDim::operator!=

(

const NcDim &

rhs

)

const

!= operator

Definition at line 52 of file ncDim.cpp.

operator=()

NcDim & NcDim::operator=

(

const NcDim &

rhs

)

assignment operator

Definition at line 26 of file ncDim.cpp.

operator==()

bool NcDim::operator==

(

const NcDim &

rhs

)

const

equivalence operator

Definition at line 43 of file ncDim.cpp.

rename()

void NcDim::rename

(

const std::string &

newName

)

renames the dimension

Definition at line 114 of file ncDim.cpp.

Friends And Related Symbol Documentation

operator<

bool operator< ( const NcDim & lhs, const NcDim & rhs )

friend

comparator operator

Definition at line 11 of file ncDim.cpp.

operator>

bool operator> ( const NcDim & lhs, const NcDim & rhs )

friend

comparator operator

Definition at line 17 of file ncDim.cpp.

---

The documentation for this class was generated from the following files:

• ncDim.h
• ncDim.cpp