Class represents a netCDF root group. More...

#include "ncFile.h"

Inheritance diagram for netCDF::NcFile:

Collaboration diagram for netCDF::NcFile:

Public Types
enum	FileFormat { classic , classic64 , nc4 , nc4classic }
enum	FileMode { read , write , replace , newFile }
enum	GroupLocation { ChildrenGrps , ParentsGrps , ChildrenOfChildrenGrps , AllChildrenGrps , ParentsAndCurrentGrps , AllGrps }
	The enumeration list contains the options for selecting groups (used for returned set of NcGroup objects). More...
enum	Location { Current , Parents , Children , ParentsAndCurrent , ChildrenAndCurrent , All }
	The enumeration list contains the options for selecting groups. More...

Public Member Functions
	NcFile ()
	Constructor generates a null object.
	NcFile (const std::string &filePath, const FileMode fMode)
	Opens a netCDF file.
	NcFile (const std::string &filePath, const FileMode fMode, const FileFormat fFormat)
	Creates a netCDF file of a specified format.
	NcFile (const std::string &filePath, const int ncFileFlags)
	Opens a netCDF file.
virtual	~NcFile ()
	destructor
NcCompoundType	addCompoundType (const std::string &name, size_t size) const
	Adds a new netCDF UserDefined type.
NcDim	addDim (const std::string &name) const
	Adds a new unlimited netCDF dimension.
NcDim	addDim (const std::string &name, size_t dimSize) const
	Adds a new netCDF dimension.
NcEnumType	addEnumType (const std::string &name, NcEnumType::ncEnumType basetype) const
	Adds a new netCDF enum type.
NcGroup	addGroup (const std::string &name) const
	Adds a new child netCDF group object.
NcOpaqueType	addOpaqueType (const std::string &name, size_t size) const
	Adds a new netCDF Opaque type.
NcVar	addVar (const std::string &name, const NcType &ncType) const
	Adds a new netCDF scalar variable.
NcVar	addVar (const std::string &name, const NcType &ncType, const NcDim &ncDim) const
	Adds a new netCDF variable.
NcVar	addVar (const std::string &name, const NcType &ncType, const std::vector< NcDim > &ncDimVector) const
	Adds a new multi-dimensional netCDF variable.
NcVar	addVar (const std::string &name, const std::string &typeName, const std::string &dimName) const
	Adds a new netCDF variable.
NcVar	addVar (const std::string &name, const std::string &typeName, const std::vector< std::string > &dimNames) const
	Adds a new netCDF multi-dimensional variable.
NcVlenType	addVlenType (const std::string &name, NcType &basetype) const
	Adds a new netCDF Vlen type.
void	close ()
	Close a file before destructor call.
void	create (const std::string &filePath, const int ncFileFlags)
	Create a netCDF file.
void	enddef ()
	Leave define mode, used for classic model.
NcGroupAtt	getAtt (const std::string &name, NcGroup::Location location=Current) const
	Gets the named NcGroupAtt object.
int	getAttCount (NcGroup::Location location=Current) const
	Gets the number of group attributes.
std::set< NcGroupAtt >	getAtts (const std::string &name, NcGroup::Location location=Current) const
	Gets all NcGroupAtt objects with a given name.
std::multimap< std::string, NcGroupAtt >	getAtts (NcGroup::Location location=Current) const
	Gets the collection of NcGroupAtt objects.
void	getCoordVar (const std::string &coordVarName, NcDim &ncDim, NcVar &ncVar, NcGroup::Location location=Current) const
	Gets the NcDim and NcVar object pair for a named coordinate variable.
std::map< std::string, NcGroup >	getCoordVars (NcGroup::Location location=Current) const
	Gets a collection of coordinate variables.
NcDim	getDim (const std::string &name, NcGroup::Location location=Current) const
	Gets the named NcDim object.
int	getDimCount (NcGroup::Location location=Current) const
	Gets the number of NcDim objects.
std::set< NcDim >	getDims (const std::string &name, NcGroup::Location location=Current) const
	Gets NcDim objects with a given name.
std::multimap< std::string, NcDim >	getDims (NcGroup::Location location=Current) const
	Gets the collection of NcDim objects.
NcGroup	getGroup (const std::string &name, NcGroup::GroupLocation location=ChildrenGrps) const
	Gets the named child NcGroup object.
int	getGroupCount (NcGroup::GroupLocation location=ChildrenGrps) const
	Gets the number of NcGroup objects.
std::set< NcGroup >	getGroups (const std::string &name, NcGroup::GroupLocation location=ChildrenGrps) const
	Gets NcGroup objects with a given name.
std::multimap< std::string, NcGroup >	getGroups (NcGroup::GroupLocation location=ChildrenGrps) const
	Gets the collection of NcGroup objects.
int	getId () const
	Gets the group id.
std::string	getName (bool fullName=false) const
	Gets the group name.
NcGroup	getParentGroup () const
	Gets the parent group.
std::string	getPath () const
NcType	getType (const std::string &name, NcGroup::Location location=Current) const
	Gets the NcType object with a given name.
int	getTypeCount (NcGroup::Location location=Current) const
	Gets the number of type objects.
int	getTypeCount (NcType::ncType enumType, NcGroup::Location location=Current) const
	Gets the number of type objects with a given enumeration type.
std::set< NcType >	getTypes (const std::string &name, NcGroup::Location location=Current) const
	Gets the collection of NcType objects with a given name.
std::set< NcType >	getTypes (const std::string &name, NcType::ncType enumType, NcGroup::Location location=Current) const
	Gets the collection of NcType objects with a given name and data type.
std::multimap< std::string, NcType >	getTypes (NcGroup::Location location=Current) const
	Gets the collection of NcType objects.
std::set< NcType >	getTypes (NcType::ncType enumType, NcGroup::Location location=Current) const
	Gets the collection of NcType objects with a given data type.
NcVar	getVar (const std::string &name, NcGroup::Location location=Current) const
	Gets the named NcVar object.
int	getVarCount (NcGroup::Location location=Current) const
	Gets the number of NcVar objects in this group.
std::set< NcVar >	getVars (const std::string &name, NcGroup::Location location=Current) const
	Gets all NcVar objects with a given name.
std::multimap< std::string, NcVar >	getVars (NcGroup::Location location=Current) const
	Get the collection of NcVar objects.
bool	isNull () const
	Returns true if this object is null (i.e.
bool	isRootGroup () const
	Returns true if this is the root group, otherwise returns false.
void	open (const std::string &filePath, const FileMode fMode)
	Opens a netCDF file.
void	open (const std::string &filePath, const FileMode fMode, const FileFormat fFormat)
	Creates a netCDF file of a specified format.
void	open (const std::string &filePath, int ncFileFlags)
	Opens a netCDF file.
bool	operator!= (const NcGroup &rhs) const
	!= operator
bool	operator== (const NcGroup &rhs) const
	equivalence operator
NcGroupAtt	putAtt (const std::string &name, const NcType &type, double datumValue) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcGroupAtt	putAtt (const std::string &name, const NcType &type, float datumValue) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcGroupAtt	putAtt (const std::string &name, const NcType &type, int datumValue) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcGroupAtt	putAtt (const std::string &name, const NcType &type, long datumValue) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcGroupAtt	putAtt (const std::string &name, const NcType &type, long long datumValue) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcGroupAtt	putAtt (const std::string &name, const NcType &type, short datumValue) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcGroupAtt	putAtt (const std::string &name, const NcType &type, size_t len, const double *dataValues) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcGroupAtt	putAtt (const std::string &name, const NcType &type, size_t len, const float *dataValues) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcGroupAtt	putAtt (const std::string &name, const NcType &type, size_t len, const int *dataValues) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcGroupAtt	putAtt (const std::string &name, const NcType &type, size_t len, const long *dataValues) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcGroupAtt	putAtt (const std::string &name, const NcType &type, size_t len, const long long *dataValues) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcGroupAtt	putAtt (const std::string &name, const NcType &type, size_t len, const short *dataValues) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcGroupAtt	putAtt (const std::string &name, const NcType &type, size_t len, const signed char *dataValues) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcGroupAtt	putAtt (const std::string &name, const NcType &type, size_t len, const unsigned char *dataValues) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcGroupAtt	putAtt (const std::string &name, const NcType &type, size_t len, const unsigned int *dataValues) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcGroupAtt	putAtt (const std::string &name, const NcType &type, size_t len, const unsigned long long *dataValues) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcGroupAtt	putAtt (const std::string &name, const NcType &type, size_t len, const unsigned short *dataValues) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcGroupAtt	putAtt (const std::string &name, const NcType &type, size_t len, const void *dataValues) const
	Creates a new NetCDF group attribute or if already exisiting replaces it.
NcGroupAtt	putAtt (const std::string &name, const NcType &type, unsigned int datumValue) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcGroupAtt	putAtt (const std::string &name, const NcType &type, unsigned long long datumValue) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcGroupAtt	putAtt (const std::string &name, const NcType &type, unsigned short datumValue) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcGroupAtt	putAtt (const std::string &name, const std::string &dataValues) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
NcGroupAtt	putAtt (const std::string &name, size_t len, const char **dataValues) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void	redef ()
	Redefine variable.
void	set_Fill (int fillmode, int *old_modep)
	Elect a fill parameter different that the one currently being used.
void	sync ()
	Synchronize an open netcdf dataset to disk.

Protected Attributes
int	myId
bool	nullObject
	assignment operator

Detailed Description

Class represents a netCDF root group.

The Ncfile class is the same as the NcGroup class with the additional functionality for opening and closing files.

Definition at line 18 of file ncFile.h.

Member Enumeration Documentation

◆ FileFormat

enum netCDF::NcFile::FileFormat

Enumerator
classic	Classic format, classic data model.
classic64	64-bit offset format, classic data model
nc4	(default) netCDF-4/HDF5 format, enhanced data model
nc4classic	netCDF-4/HDF5 format, classic data model

Definition at line 30 of file ncFile.h.

◆ FileMode

enum netCDF::NcFile::FileMode

Enumerator
read	File exists, open read-only.
write	File exists, open for writing.
replace	Create new file, even if already exists.
newFile	Create new file, fail if already exists.

Definition at line 22 of file ncFile.h.

◆ GroupLocation

enum netCDF::NcGroup::GroupLocation

inherited

The enumeration list contains the options for selecting groups (used for returned set of NcGroup objects).

Enumerator
ChildrenGrps	Select from the set of children in the current group.
ParentsGrps	Select from set of parent groups (excludes the current group).
ChildrenOfChildrenGrps	Select from set of all children of children in the current group.
AllChildrenGrps	Select from set of all children of the current group and beneath.
ParentsAndCurrentGrps	Select from set of parent groups(includes the current group).
AllGrps	Select from set of parent groups, current groups and all the children beneath.

Definition at line 33 of file ncGroup.h.

◆ Location

enum netCDF::NcGroup::Location

inherited

The enumeration list contains the options for selecting groups.

Enumerator
Current	Select from contents of current group.
Parents	Select from contents of parents groups.
Children	Select from contents of children groups.
ParentsAndCurrent	Select from contents of current and parents groups.
ChildrenAndCurrent	Select from contents of current and child groups.
All	Select from contents of current, parents and child groups.

Definition at line 46 of file ncGroup.h.

Constructor & Destructor Documentation

◆ NcFile() [1/4]

NcFile::NcFile ( )

Constructor generates a null object.

Definition at line 39 of file ncFile.cpp.

◆ NcFile() [2/4]

netCDF::NcFile::NcFile	(	const std::string &	filePath,
		const int	ncFileFlags )

Opens a netCDF file.

Parameters

filePath Name of netCDF optional path. \aram ncFileFlags File flags from netcdf.h

◆ NcFile() [3/4]

netCDF::NcFile::NcFile	(	const std::string &	filePath,
		const FileMode	fMode )

Opens a netCDF file.

Parameters

filePath	Name of netCDF optional path.
fMode	The file mode: 'read' File exists, open for read-only. 'write' File exists, open for writing. 'replace' Create new file, even it already exists. 'newFile' Create new file, fail it exists already.

◆ NcFile() [4/4]

netCDF::NcFile::NcFile	(	const std::string &	filePath,
		const FileMode	fMode,
		const FileFormat	fFormat )

Creates a netCDF file of a specified format.

Parameters

filePath	Name of netCDF optional path.
fMode	The file mode: 'replace' Create new file, even it already exists. 'newFile' Create new file, fail it exists already.

◆ ~NcFile()

NcFile::~NcFile ( )

virtual

destructor

Definition at line 14 of file ncFile.cpp.

Member Function Documentation

◆ addCompoundType()

NcCompoundType NcGroup::addCompoundType	(	const std::string &	name,
		size_t	size ) const

inherited

Adds a new netCDF UserDefined type.

Parameters

name	Name of type.
size	The size of the new type in bytes.

Returns: The new NcCompoundType object for this new netCDF userDefined type.

Definition at line 1275 of file ncGroup.cpp.

◆ addDim() [1/2]

NcDim netCDF::NcGroup::addDim ( const std::string & name ) const

inherited

Adds a new unlimited netCDF dimension.

Parameters

The	name of new dimension.

Returns: The NcDim object for this new netCDF dimension.

◆ addDim() [2/2]

NcDim netCDF::NcGroup::addDim	(	const std::string &	name,
		size_t	dimSize ) const

inherited

Adds a new netCDF dimension.

Parameters

The	name of new dimension.
Length	of dimension; that is, number of values for this dimension as an index to variables that use it.

Returns: The NcDim object for this new netCDF dimension.

◆ addEnumType()

NcEnumType NcGroup::addEnumType	(	const std::string &	name,
		NcEnumType::ncEnumType	basetype ) const

inherited

Adds a new netCDF enum type.

Parameters

name	Name of type. For atomic types, the CDL name is expected. This is consistent with the string returned from NcType::getName().
enumType	The enumeration value of the object type.

Returns: The NcEnumType object for this new netCDF enum type.

Definition at line 1246 of file ncGroup.cpp.

◆ addGroup()

NcGroup NcGroup::addGroup ( const std::string & name ) const

inherited

Adds a new child netCDF group object.

Method will throw an netCDF::exceptions::NcNullgrp exception if the group is null (ie NcGroup::isNull()=true).

Parameters

name	Variable name.

Returns: NcGroup The NcGroup object for this new netCDF group.

Definition at line 268 of file ncGroup.cpp.

◆ addOpaqueType()

NcOpaqueType NcGroup::addOpaqueType	(	const std::string &	name,
		size_t	size ) const

inherited

Adds a new netCDF Opaque type.

Parameters

name	Name of type.
size	The size of the new type in bytes.

Returns: The NcOpaqueType object for this new netCDF opaque type..

Definition at line 1266 of file ncGroup.cpp.

◆ addVar() [1/5]

NcVar NcGroup::addVar	(	const std::string &	name,
		const NcType &	ncType ) const

inherited

Adds a new netCDF scalar variable.

The NcType must be non-null, and be defined in either the current group or a parent group. An NcNullType exception is thrown if the NcType object is invalid.

Parameters

name	Variable name.
typeName	Type name.

Returns: The NcVar object for this new netCDF variable.

Definition at line 403 of file ncGroup.cpp.

◆ addVar() [2/5]

NcVar netCDF::NcGroup::addVar	(	const std::string &	name,
		const NcType &	ncType,
		const NcDim &	ncDim ) const

inherited

Adds a new netCDF variable.

The NcType and NcDim objects must be non-null, and be defined in either the current group or a parent group. An NcNullType exception is thrown if the NcType object is invalid. An NcNullDim exception is thrown if the NcDim object is invalid.

Parameters

name	Variable name.
ncType	NcType object.
ncDim	NcDim object.

Returns: The NcVar object for this new netCDF variable.

◆ addVar() [3/5]

NcVar netCDF::NcGroup::addVar	(	const std::string &	name,
		const NcType &	ncType,
		const std::vector< NcDim > &	ncDimVector ) const

inherited

Adds a new multi-dimensional netCDF variable.

The NcType and NcDim objects must be non-null, and be defined in either the current group or a parent group. An NcNullType exception is thrown if the NcType object is invalid. An NcNullDim exception is thrown if any of the the NcDim objects are invalid.

Parameters

name	Variable name.
ncType	NcType object.
ncDimvector	Vector of NcDim objects.

Returns: The NcVar object for this new netCDF variable.

◆ addVar() [4/5]

NcVar netCDF::NcGroup::addVar	(	const std::string &	name,
		const std::string &	typeName,
		const std::string &	dimName ) const

inherited

Adds a new netCDF variable.

The NcType and NcDim objects must be non-null, and be defined in either the current group or a parent group. An NcNullType exception is thrown if the NcType object is invalid. An NcNullDim exception is thrown if the NcDim object is invalid.

Parameters

name	Variable name.
typeName	Type name.
dimName	Dimension name.

Returns: The NcVar object for this new netCDF variable.

◆ addVar() [5/5]

NcVar netCDF::NcGroup::addVar	(	const std::string &	name,
		const std::string &	typeName,
		const std::vector< std::string > &	dimNames ) const

inherited

Adds a new netCDF multi-dimensional variable.

The NcType and NcDim objects must be non-null, and be defined in either the current group or a parent group. An NcNullType exception is thrown if the NcType object is invalid. An NcNullDim exception is thrown if the NcDim object is invalid.

Parameters

name	Variable name.
typeName	Type name.
dimNames	Vector of dimension names.

Returns: The NcVar object for this new netCDF variable.

◆ addVlenType()

NcVlenType NcGroup::addVlenType	(	const std::string &	name,
		NcType &	basetype ) const

inherited

Adds a new netCDF Vlen type.

Parameters

name	Name of type.
basetype	A NcType object to be used for the basetype.

Returns: The NcVlenType object for this new netCDF vlen type.

Definition at line 1256 of file ncGroup.cpp.

◆ close()

void NcFile::close ( )

Close a file before destructor call.

Definition at line 29 of file ncFile.cpp.

◆ create()

void NcFile::create	(	const std::string &	filePath,
		const int	ncFileFlags )

Create a netCDF file.

Allow for the explicit creation of a file using a path and NC_ file flags from netcdf.h.

Parameters

filePath	Name of netCDF optional path.
ncFileFlags	File flags from netcdf.h

Author: wfisher

Definition at line 110 of file ncFile.cpp.

◆ enddef()

void NcFile::enddef ( )

Leave define mode, used for classic model.

Definition at line 176 of file ncFile.cpp.

◆ getAtt()

NcGroupAtt NcGroup::getAtt	(	const std::string &	name,
		NcGroup::Location	location = Current ) const

inherited

Gets the named NcGroupAtt object.

Parameters

name	Name of attribute
location	Enumeration type controlling the groups to search.

Returns: A NcGroupAtt object. If there are multiple objects indentied with the same name, the object closest to the current group is returned. If no valid object is found , a null node is returned.

Definition at line 598 of file ncGroup.cpp.

◆ getAttCount()

int NcGroup::getAttCount ( NcGroup::Location location = Current ) const

inherited

Gets the number of group attributes.

Parameters

location Enumeration type controlling the groups to search.

Returns: Number of attributes.

Definition at line 510 of file ncGroup.cpp.

◆ getAtts() [1/2]

std::set< NcGroupAtt > netCDF::NcGroup::getAtts	(	const std::string &	name,
		NcGroup::Location	location = Current ) const

inherited

Gets all NcGroupAtt objects with a given name.

Parameters

name	Name of attribute
location	Enumeration type controlling the groups to search.

Returns: Set of NcGroupAtt objects.

◆ getAtts() [2/2]

multimap< std::string, NcGroupAtt > NcGroup::getAtts ( NcGroup::Location location = Current ) const

inherited

Gets the collection of NcGroupAtt objects.

Parameters

location Enumeration type controlling the groups to search.

Returns: A STL multimap object, containing pairs of <attribute name, NcGroupAtt object> entities.

Definition at line 545 of file ncGroup.cpp.

◆ getCoordVar()

void NcGroup::getCoordVar	(	const std::string &	coordVarName,
		NcDim &	ncDim,
		NcVar &	ncVar,
		NcGroup::Location	location = Current ) const

inherited

Gets the NcDim and NcVar object pair for a named coordinate variable.

Coordinate variable have an NcDim and NcVar object with the same name defined in the same group.

: The method returns two objects for the named coordinate variable. The method searches first in the current group and optionally in the parent and child group and returns the first instance found.

Parameters

location Enumeration type controlling the groups to search.

Returns: The set of names of dimension variables.

Definition at line 1333 of file ncGroup.cpp.

◆ getCoordVars()

map< string, NcGroup > NcGroup::getCoordVars ( NcGroup::Location location = Current ) const

inherited

Gets a collection of coordinate variables.

Coordinate variable have an NcDim and NcVar object with the same name defined in the same group.

: The method returns STL map object containing a coordinate variables in the current group and optionally in the parent and child groups. It is expected that within each group, the names of dimensions are unique and the the names of variables are unique. However, if this is not the case, this method will still work correctly.

Parameters

location Enumeration type controlling the groups to search.

Returns: The NcVar dimension variable. If no valid object is found , a null node is returned.

Definition at line 1285 of file ncGroup.cpp.

◆ getDim()

NcDim NcGroup::getDim	(	const std::string &	name,
		NcGroup::Location	location = Current ) const

inherited

Gets the named NcDim object.

Parameters

name	Name of dimension.
location	Enumeration type controlling the groups to search.

Returns: An NcDim object. If there are multiple objects indentied with the same name, the object closest to the current group is returned. If no valid object is found , a null node is returned.

Definition at line 969 of file ncGroup.cpp.

◆ getDimCount()

int NcGroup::getDimCount ( NcGroup::Location location = Current ) const

inherited

Gets the number of NcDim objects.

Parameters

location Enumeration type controlling the groups to search.

Returns: Number of dimensions.

Definition at line 889 of file ncGroup.cpp.

◆ getDims() [1/2]

std::set< NcDim > netCDF::NcGroup::getDims	(	const std::string &	name,
		NcGroup::Location	location = Current ) const

inherited

Gets NcDim objects with a given name.

Parameters

name	Name of dimension.
location	Enumeration type controlling the groups to search.

Returns: Set of NcDim objects with given name.

◆ getDims() [2/2]

multimap< string, NcDim > NcGroup::getDims ( NcGroup::Location location = Current ) const

inherited

Gets the collection of NcDim objects.

Parameters

location Enumeration type controlling the groups to search.

Returns: A STL multimap object, containing pairs of <attribute name, NcDim object> entities.

Definition at line 924 of file ncGroup.cpp.

◆ getGroup()

NcGroup NcGroup::getGroup	(	const std::string &	name,
		NcGroup::GroupLocation	location = ChildrenGrps ) const

inherited

Gets the named child NcGroup object.

Method will throw an netCDF::exceptions::NcNullgrp exception if the group is null (ie NcGroup::isNull()=true).

Parameters

name	Group name.
location	Enumeration type controlling the groups to search.

Returns: An NcGroup object. If there are multiple objects indentied with the same name, the object closest to the current group is returned. If no valid object is found , a null node is returned.

Definition at line 239 of file ncGroup.cpp.

◆ getGroupCount()

int NcGroup::getGroupCount ( NcGroup::GroupLocation location = ChildrenGrps ) const

inherited

Gets the number of NcGroup objects.

Method will throw an netCDF::exceptions::NcNullgrp exception if the group is null (ie NcGroup::isNull()=true).

Parameters

location Enumeration type controlling the groups to search.

Returns: Number of groups.

Definition at line 150 of file ncGroup.cpp.

◆ getGroups() [1/2]

set< NcGroup > NcGroup::getGroups	(	const std::string &	name,
		NcGroup::GroupLocation	location = ChildrenGrps ) const

inherited

Gets NcGroup objects with a given name.

Method will throw an netCDF::exceptions::NcNullgrp exception if the group is null (ie NcGroup::isNull()=true).

Parameters

name	Name of group.
location	Enumeration type controlling the groups to search.

Returns: Set of NcGroup objects with given name.

Definition at line 253 of file ncGroup.cpp.

◆ getGroups() [2/2]

multimap< std::string, NcGroup > NcGroup::getGroups ( NcGroup::GroupLocation location = ChildrenGrps ) const

inherited

Gets the collection of NcGroup objects.

Method will throw an netCDF::exceptions::NcNullgrp exception if the group is null (ie NcGroup::isNull()=true).

Parameters

location Enumeration type controlling the groups to search.

Returns: A STL multimap object, containing pairs of <attribute name, NcGroup object> entities.

Definition at line 186 of file ncGroup.cpp.

◆ getId()

int NcGroup::getId ( ) const

inherited

Gets the group id.

Method will throw an netCDF::exceptions::NcNullgrp exception if the group is null (ie NcGroup::isNull()=true).

Definition at line 144 of file ncGroup.cpp.

◆ getName()

string NcGroup::getName ( bool fullName = false ) const

inherited

Gets the group name.

Method will throw an netCDF::exceptions::NcNullgrp exception if the group is null (ie NcGroup::isNull()=true).

Parameters

fullName If true then the full name is returned with subgroups separated by a forward slash "/" (default is false)

Returns: The group name.

Definition at line 100 of file ncGroup.cpp.

◆ getParentGroup()

NcGroup NcGroup::getParentGroup ( ) const

inherited

Gets the parent group.

Method will throw an netCDF::exceptions::NcNullgrp exception if the group is null (ie NcGroup::isNull()=true). If the current root is the parent group, then return a null group.

Definition at line 128 of file ncGroup.cpp.

◆ getPath()

string NcFile::getPath ( ) const

Definition at line 180 of file ncFile.cpp.

◆ getType()

NcType NcGroup::getType	(	const std::string &	name,
		NcGroup::Location	location = Current ) const

inherited

Gets the NcType object with a given name.

Parameters

name	Name of type. For atomic types, the CDL name is expected. This is consistent with the string returned from NcType::getName().
location	Enumeration type controlling the groups to search.

Returns: NcType object. If there are multiple objects indentied with the same name, the object closest to the current group is returned. If no valid object is found , a null node is returned.

Definition at line 1212 of file ncGroup.cpp.

◆ getTypeCount() [1/2]

int NcGroup::getTypeCount ( NcGroup::Location location = Current ) const

inherited

Gets the number of type objects.

Parameters

location Enumeration type controlling the groups to search.

Returns: Number of types.

Definition at line 1025 of file ncGroup.cpp.

◆ getTypeCount() [2/2]

int NcGroup::getTypeCount	(	NcType::ncType	enumType,
		NcGroup::Location	location = Current ) const

inherited

Gets the number of type objects with a given enumeration type.

Parameters

enumType	The enumeration value of the object type.
location	Enumeration type controlling the groups to search.

Returns: Number of types of the given enumeration type.

Definition at line 1063 of file ncGroup.cpp.

◆ getTypes() [1/4]

std::set< NcType > netCDF::NcGroup::getTypes	(	const std::string &	name,
		NcGroup::Location	location = Current ) const

inherited

Gets the collection of NcType objects with a given name.

Parameters

name	Name of type. For atomic types, the CDL name is expected. This is consistent with the string returned from NcType::getName().
location	Enumeration type controlling the groups to search.

Returns: Set of NcType objects.

◆ getTypes() [2/4]

std::set< NcType > netCDF::NcGroup::getTypes	(	const std::string &	name,
		NcType::ncType	enumType,
		NcGroup::Location	location = Current ) const

inherited

Gets the collection of NcType objects with a given name and data type.

Parameters

name	Name of type. For atomic types, the CDL name is expected. This is consistent with the string returned from NcType::getName().
enumType	Enumeration type specifying the data type.
location	Enumeration type controlling the groups to search.

Returns: Set of Nctype objects.

◆ getTypes() [3/4]

multimap< string, NcType > NcGroup::getTypes ( NcGroup::Location location = Current ) const

inherited

Gets the collection of NcType objects.

Parameters

location Enumeration type controlling the groups to search.

Returns: A STL multimap object, on return contains pairs of <Type name, NcType object> entities. For atomic types, the type returned is the CDL name.

Definition at line 1107 of file ncGroup.cpp.

◆ getTypes() [4/4]

set< NcType > NcGroup::getTypes	(	NcType::ncType	enumType,
		NcGroup::Location	location = Current ) const

inherited

Gets the collection of NcType objects with a given data type.

Parameters

enumType	Enumeration type specifying the data type.
location	Enumeration type controlling the groups to search.

Returns: Set of Nctype objects.

Definition at line 1171 of file ncGroup.cpp.

◆ getVar()

NcVar NcGroup::getVar	(	const std::string &	name,
		NcGroup::Location	location = Current ) const

inherited

Gets the named NcVar object.

Parameters

name	Variable name.
location	Enumeration type controlling the groups to search.

Returns: A NcVar object. If there are multiple objects indentied with the same name, the object closest to the current group is returned. If no valid object is found , a null node is returned.

Definition at line 391 of file ncGroup.cpp.

◆ getVarCount()

int NcGroup::getVarCount ( NcGroup::Location location = Current ) const

inherited

Gets the number of NcVar objects in this group.

Parameters

location Enumeration type controlling the groups to search.

Returns: Number of variables.

Definition at line 282 of file ncGroup.cpp.

◆ getVars() [1/2]

std::set< NcVar > netCDF::NcGroup::getVars	(	const std::string &	name,
		NcGroup::Location	location = Current ) const

inherited

Gets all NcVar objects with a given name.

Parameters

name	Name of attribute
location	Enumeration type controlling the groups to search.

Returns: Set of NcVar objects.

◆ getVars() [2/2]

multimap< std::string, NcVar > NcGroup::getVars ( NcGroup::Location location = Current ) const

inherited

Get the collection of NcVar objects.

Parameters

location Enumeration type controlling the groups to search.

Returns: A STL multimap object, containing pairs of <attribute name, NcVar object> entities.

Definition at line 316 of file ncGroup.cpp.

◆ isNull()

bool netCDF::NcGroup::isNull ( ) const

inlineinherited

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

it has no contents); otherwise returns false.

Definition at line 156 of file ncGroup.h.

◆ isRootGroup()

bool NcGroup::isRootGroup ( ) const

inherited

Returns true if this is the root group, otherwise returns false.

Definition at line 122 of file ncGroup.cpp.

◆ open() [1/3]

void netCDF::NcFile::open	(	const std::string &	filePath,
		const FileMode	fMode )

Opens a netCDF file.

Parameters

filePath	Name of netCDF optional path.
fMode	The file mode: 'read' File exists, open for read-only. 'write' File exists, open for writing. 'replace' Create new file, even it already exists. 'newFile' Create new file, fail it exists already.

◆ open() [2/3]

void netCDF::NcFile::open	(	const std::string &	filePath,
		const FileMode	fMode,
		const FileFormat	fFormat )

Creates a netCDF file of a specified format.

Parameters

filePath	Name of netCDF optional path.
fMode	The file mode: 'replace' Create new file, even it already exists. 'newFile' Create new file, fail it exists already.

◆ open() [3/3]

void netCDF::NcFile::open	(	const std::string &	filePath,
		int	ncFileFlags )

Opens a netCDF file.

Parameters

filePath	Name of netCDF optional path.
ncFileFlags	File flags from netcdf.h

◆ operator!=()

bool NcGroup::operator!= ( const NcGroup & rhs ) const

inherited

!= operator

Definition at line 89 of file ncGroup.cpp.

◆ operator==()

bool NcGroup::operator== ( const NcGroup & rhs ) const

inherited

equivalence operator

Definition at line 80 of file ncGroup.cpp.

◆ putAtt() [1/23]

NcGroupAtt netCDF::NcGroup::putAtt	(	const std::string &	name,
		const NcType &	type,
		double	datumValue ) const

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ putAtt() [2/23]

NcGroupAtt netCDF::NcGroup::putAtt	(	const std::string &	name,
		const NcType &	type,
		float	datumValue ) const

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ putAtt() [3/23]

NcGroupAtt netCDF::NcGroup::putAtt	(	const std::string &	name,
		const NcType &	type,
		int	datumValue ) const

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ putAtt() [4/23]

NcGroupAtt netCDF::NcGroup::putAtt	(	const std::string &	name,
		const NcType &	type,
		long	datumValue ) const

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ putAtt() [5/23]

NcGroupAtt netCDF::NcGroup::putAtt	(	const std::string &	name,
		const NcType &	type,
		long long	datumValue ) const

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ putAtt() [6/23]

NcGroupAtt netCDF::NcGroup::putAtt	(	const std::string &	name,
		const NcType &	type,
		short	datumValue ) const

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ putAtt() [7/23]

NcGroupAtt netCDF::NcGroup::putAtt	(	const std::string &	name,
		const NcType &	type,
		size_t	len,
		const double *	dataValues ) const

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ putAtt() [8/23]

NcGroupAtt netCDF::NcGroup::putAtt	(	const std::string &	name,
		const NcType &	type,
		size_t	len,
		const float *	dataValues ) const

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ putAtt() [9/23]

NcGroupAtt netCDF::NcGroup::putAtt	(	const std::string &	name,
		const NcType &	type,
		size_t	len,
		const int *	dataValues ) const

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ putAtt() [10/23]

NcGroupAtt netCDF::NcGroup::putAtt	(	const std::string &	name,
		const NcType &	type,
		size_t	len,
		const long *	dataValues ) const

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ putAtt() [11/23]

NcGroupAtt netCDF::NcGroup::putAtt	(	const std::string &	name,
		const NcType &	type,
		size_t	len,
		const long long *	dataValues ) const

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ putAtt() [12/23]

NcGroupAtt netCDF::NcGroup::putAtt	(	const std::string &	name,
		const NcType &	type,
		size_t	len,
		const short *	dataValues ) const

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ putAtt() [13/23]

NcGroupAtt netCDF::NcGroup::putAtt	(	const std::string &	name,
		const NcType &	type,
		size_t	len,
		const signed char *	dataValues ) const

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ putAtt() [14/23]

NcGroupAtt netCDF::NcGroup::putAtt	(	const std::string &	name,
		const NcType &	type,
		size_t	len,
		const unsigned char *	dataValues ) const

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ putAtt() [15/23]

NcGroupAtt netCDF::NcGroup::putAtt	(	const std::string &	name,
		const NcType &	type,
		size_t	len,
		const unsigned int *	dataValues ) const

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ putAtt() [16/23]

NcGroupAtt netCDF::NcGroup::putAtt	(	const std::string &	name,
		const NcType &	type,
		size_t	len,
		const unsigned long long *	dataValues ) const

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ putAtt() [17/23]

NcGroupAtt netCDF::NcGroup::putAtt	(	const std::string &	name,
		const NcType &	type,
		size_t	len,
		const unsigned short *	dataValues ) const

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ putAtt() [18/23]

NcGroupAtt netCDF::NcGroup::putAtt	(	const std::string &	name,
		const NcType &	type,
		size_t	len,
		const void *	dataValues ) const

inherited

Creates a new NetCDF group attribute or if already exisiting replaces it.

If you are writing a Fill_Value attribute, and will tell the HDF5 layer to use the specified fill value for that variable.

: Although it's possible to create attributes of all types, text and double attributes are adequate for most purposes.

Parameters

name	Name of attribute.
type	The attribute type.
len	The length of the attribute (number of Nctype repeats).
dataValues	Data Values to put into the new attribute. If the type of data values differs from the netCDF variable type, type conversion will occur. (However, no type conversion is carried out for variables using the user-defined data types: nc_Vlen, nc_Opaque, nc_Compound and nc_Enum.)

Returns: The NcGroupAtt object for this new netCDF attribute.

◆ putAtt() [19/23]

NcGroupAtt netCDF::NcGroup::putAtt	(	const std::string &	name,
		const NcType &	type,
		unsigned int	datumValue ) const

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ putAtt() [20/23]

NcGroupAtt netCDF::NcGroup::putAtt	(	const std::string &	name,
		const NcType &	type,
		unsigned long long	datumValue ) const

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ putAtt() [21/23]

NcGroupAtt netCDF::NcGroup::putAtt	(	const std::string &	name,
		const NcType &	type,
		unsigned short	datumValue ) const

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ putAtt() [22/23]

NcGroupAtt netCDF::NcGroup::putAtt	(	const std::string &	name,
		const std::string &	dataValues ) const

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ putAtt() [23/23]

NcGroupAtt netCDF::NcGroup::putAtt	(	const std::string &	name,
		size_t	len,
		const char **	dataValues ) const

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ redef()

void NcFile::redef ( )

Redefine variable.

Definition at line 171 of file ncFile.cpp.

◆ set_Fill()

void NcFile::set_Fill	(	int	fillmode,
		int *	old_modep )

Elect a fill parameter different that the one currently being used.

Definition at line 165 of file ncFile.cpp.

◆ sync()

void NcFile::sync ( )

Synchronize an open netcdf dataset to disk.

Definition at line 161 of file ncFile.cpp.

Field Documentation

◆ myId

int netCDF::NcGroup::myId

protectedinherited

Definition at line 570 of file ncGroup.h.

◆ nullObject

bool netCDF::NcGroup::nullObject

protectedinherited

assignment operator

Definition at line 568 of file ncGroup.h.

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

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ FileFormat

◆ FileMode

◆ GroupLocation

◆ Location

Constructor & Destructor Documentation

◆ NcFile() [1/4]

◆ NcFile() [2/4]

◆ NcFile() [3/4]

◆ NcFile() [4/4]

◆ ~NcFile()

Member Function Documentation

◆ addCompoundType()

◆ addDim() [1/2]

◆ addDim() [2/2]

◆ addEnumType()

◆ addGroup()

◆ addOpaqueType()

◆ addVar() [1/5]

◆ addVar() [2/5]

◆ addVar() [3/5]

◆ addVar() [4/5]

◆ addVar() [5/5]

◆ addVlenType()

◆ close()

◆ create()

◆ enddef()

◆ getAtt()

◆ getAttCount()

◆ getAtts() [1/2]

◆ getAtts() [2/2]

◆ getCoordVar()

◆ getCoordVars()

◆ getDim()

◆ getDimCount()

◆ getDims() [1/2]

◆ getDims() [2/2]

◆ getGroup()

◆ getGroupCount()

◆ getGroups() [1/2]

◆ getGroups() [2/2]

◆ getId()

◆ getName()

◆ getParentGroup()

◆ getPath()

◆ getType()

◆ getTypeCount() [1/2]

◆ getTypeCount() [2/2]

◆ getTypes() [1/4]

◆ getTypes() [2/4]

◆ getTypes() [3/4]

◆ getTypes() [4/4]

◆ getVar()

◆ getVarCount()

◆ getVars() [1/2]

◆ getVars() [2/2]

◆ isNull()

◆ isRootGroup()

◆ open() [1/3]

◆ open() [2/3]

◆ open() [3/3]

◆ operator!=()

◆ operator==()

◆ putAtt() [1/23]

◆ putAtt() [2/23]

◆ putAtt() [3/23]

◆ putAtt() [4/23]

◆ putAtt() [5/23]

◆ putAtt() [6/23]

◆ putAtt() [7/23]

◆ putAtt() [8/23]

◆ putAtt() [9/23]

◆ putAtt() [10/23]

◆ putAtt() [11/23]

◆ putAtt() [12/23]

◆ putAtt() [13/23]