netcdf::NcFileMetaCF Class Reference

Class for read/write CF-convention netCDF global metadata (aka attributes). A typical set of attributes are known. More...

#include <NetCDF/cpp4/src/metadata/NcFileMetaCF.h>

Detailed Description

Copyright:

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

2013Feb

Examples:

Test_NcFileMetaCF.cpp.

Public Types
enum	MetaItem {   Meta_title, Meta_institution, Meta_contact, Meta_copyright,   Meta_conventions, Meta_references, Meta_source, Meta_comment,   Meta_history, Meta_Unknown }

Public Member Functions
	NcFileMetaCF (netcdf::NcFile &useNcFile)
void	Set (MetaItem const which, std::string const &data)
void	Append (MetaItem const which, std::string const &data)
void	Get (MetaItem const which, std::string &data) const
void	Get (MetaItem const which, TStringArray &data) const
bool	Exists (MetaItem const which) const

Static Public Member Functions
static char const *const	GetAttName (MetaItem const which)

Member Enumeration Documentation

enum netcdf::NcFileMetaCF::MetaItem

Enumerator
Meta_title	title of dataset: string
Meta_institution	institution name: string
Meta_contact	contact info of data maintainer: string
Meta_copyright	copyright: string
Meta_conventions	conventions for netCDF file structure: string
Meta_references	URL or published information about this data: string.
Meta_source	source of data: string
Meta_comment	misc. comments about this file: string
Meta_history	history of this data and file: string array
Meta_Unknown

Constructor & Destructor Documentation

netcdf::NcFileMetaCF::NcFileMetaCF

(

netcdf::NcFile &

useNcFile

)

Member Function Documentation

void netcdf::NcFileMetaCF::Append	(	MetaItem const	which,
		std::string const &	data
	)

bool netcdf::NcFileMetaCF::Exists ( MetaItem const  which ) const

inline

void netcdf::NcFileMetaCF::Get	(	MetaItem const	which,
		std::string &	data
	)		const

void netcdf::NcFileMetaCF::Get	(	MetaItem const	which,
		TStringArray &	data
	)		const

static char const* const netcdf::NcFileMetaCF::GetAttName ( MetaItem const  which )

inlinestatic

void netcdf::NcFileMetaCF::Set	(	MetaItem const	which,
		std::string const &	data
	)

---

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

• NcFileMetaCF.h
• NcFileMetaCF.cpp