netcdf::NcAtt Class Reference

Represents a netCDF attribute. More...

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

Inheritance diagram for netcdf::NcAtt:

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

Public Types
typedef std::multimap < std::string, NcType >	NcTypeMap
Public Types inherited from netcdf::NcItem
enum	{ idGlobal = NC_GLOBAL }

Public Member Functions
virtual	~NcAtt ()
	NcAtt ()
	NcAtt (bool const isNullObject)
	NcAtt (int const useFileID, int const useID, std::string const attName, int const useGroupID=nullID, int const useVarID=NcItem::idGlobal)
	variable ID number More...
	NcAtt (NcAtt const &rhs)
	Simple copy of attribute; does not affect file. More...
	NcAtt (int const useID, NcAtt const &rhs)
	Copy attribute and its data to this variable. More...
NcAtt &	operator= (NcAtt const &rhs)
	Copy attribute to this variable. More...
int	Size () const
	number of elements More...
NcType	GetType () const
NcGroup	GetParentGroup () const
int const	GetVarID () const
bool	operator== (NcAtt const &rhs) const
bool	operator!= (NcAtt const &rhs) const
bool	operator< (NcAtt const &rhs) const
void	Get (TVecUbyte &data) const
	get NcUbyte vector More...
void	Get (TVecByte &data) const
	get NcByte vector More...
void	Get (TVecChar &data) const
	get NcChar vector More...
void	Get (TVecShort &data) const
	get NcShort vector More...
void	Get (TVecUshort &data) const
	get NcUshort vector More...
void	Get (TVecInt &data) const
	get NcInt vector More...
void	Get (TVecUint &data) const
	get NcUint vector More...
void	Get (TVecFloat &data) const
	get NcFloat vector More...
void	Get (TVecDouble &data) const
	get NcDouble vector More...
void	Get (TVecInt64 &data) const
	get NcInt64 vector More...
void	Get (TVecUint64 &data) const
	get NcUint64 vector More...
void	Get (TVecString &data) const
	get NcString vector More...
void	Get (unsigned char &data) const
	get NcUbyte More...
void	Get (signed char &data) const
	get NcByte More...
void	Get (char &data) const
	get NcChar More...
void	Get (short &data) const
	get NcShort More...
void	Get (unsigned short &data) const
	get NcUshort More...
void	Get (int &data) const
	get NcInt More...
void	Get (long &data) const
	get NcInt More...
void	Get (unsigned int &data) const
	get NcUint More...
void	Get (unsigned long &data) const
	get NcUint More...
void	Get (float &data) const
	get NcFloat More...
void	Get (double &data) const
	get NcDouble More...
void	Get (long long &data) const
	get NcInt64 More...
void	Get (unsigned long long &data) const
	get NcUint64 More...
void	Get (unsigned char *const data) const
	get NcUbyte More...
void	Get (signed char *const data) const
	get NcByte More...
void	Get (char *const data) const
	get NcChar More...
void	Get (short *const data) const
	get NcShort More...
void	Get (unsigned short *const data) const
	get NcUshort More...
void	Get (int *const data) const
	get NcInt More...
void	Get (long *const data) const
	get NcInt More...
void	Get (unsigned int *const data) const
	get NcUint More...
void	Get (float *const data) const
	get NcFloat More...
void	Get (double *const data) const
	get NcDouble More...
void	Get (long long *const data) const
	get NcInt64 More...
void	Get (unsigned long long *const data) const
	get NcUint64 More...
void	Get (char **const data) const
	get NcString More...
void	Get (std::string &data) const
	get NcString More...
void	Get (void *data) const
virtual void	Rename (std::string const &newname)
Public Member Functions inherited from netcdf::NcItem
virtual	~NcItem ()=0
bool	IsNull () const
std::string const &	GetName () const
int	GetID () const
int	GetGroupID () const
int	GetFileID () const
NcItem &	operator= (NcItem const &rhs)
bool	operator== (NcItem const &rhs) const
bool	operator!= (NcItem const &rhs) const
bool	operator< (NcItem const &rhs) const

Additional Inherited Members
Static Public Attributes inherited from netcdf::NcItem
static int const	nullID = -999
Protected Member Functions inherited from netcdf::NcItem
	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 inherited from netcdf::NcItem
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 Typedef Documentation

typedef std::multimap<std::string, NcType> netcdf::NcAtt::NcTypeMap

Constructor & Destructor Documentation

virtual netcdf::NcAtt::~NcAtt ( )

inlinevirtual

netcdf::NcAtt::NcAtt

(

)

Constructor generates a null object.

netcdf::NcAtt::NcAtt

(

bool const

isNullObject

)

Constructor for non-null instances.

netcdf::NcAtt::NcAtt	(	int const	useFileID,
		int const	useID,
		std::string const	attName,
		int const	useGroupID = nullID,
		int const	useVarID = NcItem::idGlobal
	)

Parameters

useFileID	netCDF file ID number
useID	object ID number (unique)
attName	attribute name
useGroupID	group ID number

netcdf::NcAtt::NcAtt

(

NcAtt const &

rhs

)

netcdf::NcAtt::NcAtt	(	int const	useID,
		NcAtt const &	rhs
	)

attribute to copy

Parameters

useID

destination variable or group ID number

Member Function Documentation

void netcdf::NcAtt::Get

(

TVecUbyte &

data

)

const

void netcdf::NcAtt::Get

(

TVecByte &

data

)

const

void netcdf::NcAtt::Get

(

TVecChar &

data

)

const

void netcdf::NcAtt::Get

(

TVecShort &

data

)

const

void netcdf::NcAtt::Get

(

TVecUshort &

data

)

const

void netcdf::NcAtt::Get

(

TVecInt &

data

)

const

void netcdf::NcAtt::Get

(

TVecUint &

data

)

const

void netcdf::NcAtt::Get

(

TVecFloat &

data

)

const

void netcdf::NcAtt::Get

(

TVecDouble &

data

)

const

void netcdf::NcAtt::Get

(

TVecInt64 &

data

)

const

void netcdf::NcAtt::Get

(

TVecUint64 &

data

)

const

void netcdf::NcAtt::Get

(

TVecString &

data

)

const

void netcdf::NcAtt::Get

(

unsigned char &

data

)

const

void netcdf::NcAtt::Get

(

signed char &

data

)

const

void netcdf::NcAtt::Get

(

char &

data

)

const

void netcdf::NcAtt::Get

(

short &

data

)

const

void netcdf::NcAtt::Get

(

unsigned short &

data

)

const

void netcdf::NcAtt::Get

(

int &

data

)

const

void netcdf::NcAtt::Get

(

long &

data

)

const

void netcdf::NcAtt::Get

(

unsigned int &

data

)

const

void netcdf::NcAtt::Get

(

unsigned long &

data

)

const

void netcdf::NcAtt::Get

(

float &

data

)

const

void netcdf::NcAtt::Get

(

double &

data

)

const

void netcdf::NcAtt::Get

(

long long &

data

)

const

void netcdf::NcAtt::Get

(

unsigned long long &

data

)

const

void netcdf::NcAtt::Get

(

unsigned char *const

data

)

const

Deprecated:

void netcdf::NcAtt::Get

(

signed char *const

data

)

const

Deprecated:

void netcdf::NcAtt::Get

(

char *const

data

)

const

Deprecated:

void netcdf::NcAtt::Get

(

short *const

data

)

const

Deprecated:

void netcdf::NcAtt::Get

(

unsigned short *const

data

)

const

Deprecated:

void netcdf::NcAtt::Get

(

int *const

data

)

const

Deprecated:

void netcdf::NcAtt::Get

(

long *const

data

)

const

Deprecated:

void netcdf::NcAtt::Get

(

unsigned int *const

data

)

const

Deprecated:

void netcdf::NcAtt::Get

(

float *const

data

)

const

Deprecated:

void netcdf::NcAtt::Get

(

double *const

data

)

const

Deprecated:

void netcdf::NcAtt::Get

(

long long *const

data

)

const

Deprecated:

void netcdf::NcAtt::Get

(

unsigned long long *const

data

)

const

Deprecated:

void netcdf::NcAtt::Get

(

char **const

data

)

const

Deprecated:

void netcdf::NcAtt::Get

(

std::string &

data

)

const

Deprecated:

void netcdf::NcAtt::Get

(

void *

data

)

const

Gets a netCDF attribute. The user must ensure that the variable "dataValues" has sufficient space to hold the attribute.

Parameters

dataValues

On return contains the value of the 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.)

netcdf::NcGroup netcdf::NcAtt::GetParentGroup

(

)

const

netcdf::NcType netcdf::NcAtt::GetType

(

)

const

int const netcdf::NcAtt::GetVarID ( ) const

inline

bool netcdf::NcAtt::operator!= ( NcAtt const &  rhs ) const

inline

bool netcdf::NcAtt::operator<

(

NcAtt const &

rhs

)

const

NcAtt & netcdf::NcAtt::operator=

(

NcAtt const &

rhs

)

bool netcdf::NcAtt::operator==

(

NcAtt const &

rhs

)

const

void netcdf::NcAtt::Rename ( std::string const &  newname )

virtual

Implements netcdf::NcItem.

int netcdf::NcAtt::Size

(

)

const

---

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

• NcAtt.h
• NcAtt.cpp