netcdf::NcChar Class Reference

Represents a netCDF atomic Char type. More...

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

Inheritance diagram for netcdf::NcChar:

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

Examples:

Test_NcChar.cpp.

Public Types
typedef char	value_type
typedef std::vector< value_type >	vector_type
Public Types inherited from netcdf::NcType
enum	ncType {   nc_NAT = NC_NAT, nc_BYTE = NC_BYTE, nc_CHAR = NC_CHAR, nc_SHORT = NC_SHORT,   nc_INT = NC_INT, nc_FLOAT = NC_FLOAT, nc_DOUBLE = NC_DOUBLE, nc_UBYTE = NC_UBYTE,   nc_USHORT = NC_USHORT, nc_UINT = NC_UINT, nc_INT64 = NC_INT64, nc_UINT64 = NC_UINT64,   nc_STRING = NC_STRING, nc_VLEN = NC_VLEN, nc_OPAQUE = NC_OPAQUE, nc_ENUM = NC_ENUM,   nc_COMPOUND = NC_COMPOUND, nc_Unknown }

Public Member Functions
	NcChar ()
void	Get (int const groupID, int const varID, char **&data)
	receives data; free with FreeCStringArray More...
void	Get (int const groupID, int const varID, std::vector< std::string > &data)
	receives data More...
void	Get (int const groupID, int const varID, vector_type &data)
	receives data More...
void	Get (int const groupID, int const varID, TVecIndex const &indices, std::string &data)
	receives value More...
void	Get (int const groupID, int const varID, std::size_t const start, std::size_t const count, char **&data)
	receives data; free with FreeCStringArray More...
void	Get (int const groupID, int const varID, std::size_t const start, std::size_t const count, std::vector< std::string > &data)
	receives data More...
void	Get (int const groupID, int const varID, TVecIndex const &start, TVecIndex const &count, vector_type &data)
	vector to receive data values More...
void	Put (int const groupID, int const varID, vector_type const &data)
	data to write More...
void	Put (int const groupID, int const varID, TVecIndex const &start, TVecIndex const &count, vector_type const &data)
	vector of values to write More...
Public Member Functions inherited from netcdf::NcType
	NcType ()
	NcType (std::string const myClassName, ncType const id)
	enumerated type value More...
	NcType (NcType const &rhs)
virtual	~NcType ()
NcType &	operator= (NcType const &rhs)
bool	operator== (NcType const &rhs) const
bool	operator!= (NcType const &rhs) const
bool	operator< (NcType const &rhs) const
ncType	GetID () const
virtual std::string	GetName () const
virtual size_t	Size () const
virtual ncType	getTypeClass () const
virtual ncType	GetTypeClass () const
std::string const &	getTypeClassName () const
std::string const &	GetTypeClassName () const
bool	IsNull () const

Static Public Member Functions
static value_type	FillValue ()
static value_type	MinValue ()
static value_type	MaxValue ()
static std::size_t	SizeOf ()

Additional Inherited Members
Protected Member Functions inherited from netcdf::NcType
void	ErrorDimsAreZero (std::string const &className)
void	ErrorArrayNcSizeMismatch (std::string const &className)
Protected Attributes inherited from netcdf::NcType
bool	nullObject
std::string	myName
	enumerated type name More...
ncType	myID
	enumerated type value More...
Static Protected Attributes inherited from netcdf::NcType
static ncType const	nullID = nc_NAT

Member Typedef Documentation

typedef char netcdf::NcChar::value_type

typedef std::vector<value_type> netcdf::NcChar::vector_type

Constructor & Destructor Documentation

netcdf::NcChar::NcChar

(

)

Member Function Documentation

static value_type netcdf::NcChar::FillValue ( )

inlinestatic

void netcdf::NcChar::Get	(	int const	groupID,
		int const	varID,
		char **&	data
	)

Parameters

groupID	read all values from an array of char* group ID
varID	variable ID

void netcdf::NcChar::Get	(	int const	groupID,
		int const	varID,
		std::vector< std::string > &	data
	)

Parameters

groupID	read all values from an array of char* group ID
varID	variable ID

void netcdf::NcChar::Get	(	int const	groupID,
		int const	varID,
		vector_type &	data
	)

Parameters

groupID	read all values from an array of char group ID
varID	variable ID

void netcdf::NcChar::Get	(	int const	groupID,
		int const	varID,
		TVecIndex const &	indices,
		std::string &	data
	)

Parameters

groupID	read a single value at indices group ID
varID	variable ID
indices	indices at which to read

void netcdf::NcChar::Get	(	int const	groupID,
		int const	varID,
		std::size_t const	start,
		std::size_t const	count,
		char **&	data
	)

Parameters

groupID	read all values from an array of char* group ID
varID	variable ID
start	zero-based index to start reading
count	number of strings to read

void netcdf::NcChar::Get	(	int const	groupID,
		int const	varID,
		std::size_t const	start,
		std::size_t const	count,
		std::vector< std::string > &	data
	)

Parameters

groupID	read all values from an array of char* group ID
varID	variable ID
start	zero-based index to start reading
count	number of strings to read

void netcdf::NcChar::Get	(	int const	groupID,
		int const	varID,
		TVecIndex const &	start,
		TVecIndex const &	count,
		vector_type &	data
	)

Parameters

groupID	read an array of values group ID
varID	variable ID
start	zero-based indices to start reading
count	count along each edge (>= 1)

static value_type netcdf::NcChar::MaxValue ( )

inlinestatic

static value_type netcdf::NcChar::MinValue ( )

inlinestatic

void netcdf::NcChar::Put	(	int const	groupID,
		int const	varID,
		vector_type const &	data
	)

Parameters

groupID	write all values group ID
varID	variable ID

void netcdf::NcChar::Put	(	int const	groupID,
		int const	varID,
		TVecIndex const &	start,
		TVecIndex const &	count,
		vector_type const &	data
	)

Parameters

groupID	write an array of values group ID
varID	variable ID
start	zero-based indices to start write
count	count along each edge (>= 1)

static std::size_t netcdf::NcChar::SizeOf ( )

inlinestatic

---

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

• NcChar.h
• NcChar.cpp