FONcShort Class Reference

A DAP Int16 and UInt16 with file out netcdf information included. More...

#include <FONcShort.h>

Inheritance diagram for FONcShort:

Collaboration diagram for FONcShort:

Public Member Functions
virtual void	clear_embedded ()
	Clears the list of embedded variable names. More...
virtual void	convert (vector< string > embed)
virtual void	define (int ncid)
	define the DAP Int16 or UInt16 in the netcdf file More...
virtual void	dump (ostream &strm) const
	dumps information about this object for debugging purposes More...
	FONcShort (BaseType *b)
	Constructor for FOncShort that takes a DAP Int16 or UInt16. More...
virtual bool	isNetCDF4 ()
	Returns true if NetCDF4 features will be required. More...
virtual string	name ()
	returns the name of the DAP Int16 or UInt16 More...
virtual void	setVersion (string version)
	Identifies variable with use of NetCDF4 features. More...
virtual nc_type	type ()
	returns the netcdf type of the DAP object More...
virtual int	varid ()
virtual void	write (int ncid)
	Write the short out to the netcdf file. More...
virtual	~FONcShort ()
	Destructor that cleans up the short. More...

Protected Attributes
bool	_defined
vector< string >	_embed
string	_ncVersion
string	_orig_varname
int	_varid
string	_varname

Detailed Description

A DAP Int16 and UInt16 with file out netcdf information included.

This class represents a DAP Int16 and UInt16 with additional information needed to write it out to a netcdf file. Includes a reference to the actual DAP Int16 or UInt16 being converted

Definition at line 47 of file FONcShort.h.

Constructor & Destructor Documentation

FONcShort::FONcShort

(

BaseType *

b

)

Constructor for FOncShort that takes a DAP Int16 or UInt16.

This constructor takes a DAP BaseType and makes sure that it is a DAP Int16 or UInt16 instance. If not, it throws an exception

Parameters

b	A DAP BaseType that should be a byte

Exceptions

BESInternalError

if the BaseType is not a Int16 or UInt16

Definition at line 49 of file FONcShort.cc.

FONcShort::~FONcShort ( )

virtual

Destructor that cleans up the short.

The DAP Int16 or UInt16 instance does not belong to the FONcByte instance, so it is not deleted.

Definition at line 67 of file FONcShort.cc.

Member Function Documentation

void FONcBaseType::clear_embedded ( )

virtualinherited

Clears the list of embedded variable names.

Definition at line 95 of file FONcBaseType.cc.

References FONcBaseType::_embed.

Referenced by FONcMap::clear_embedded().

void FONcBaseType::convert ( vector< string >  embed )

virtualinherited

Reimplemented in FONcArray, FONcGrid, FONcStructure, and FONcSequence.

Definition at line 41 of file FONcBaseType.cc.

References FONcBaseType::_embed, FONcBaseType::_varname, and FONcBaseType::name().

Referenced by FONcSequence::convert(), FONcStructure::convert(), FONcGrid::convert(), and FONcArray::convert().

Here is the call graph for this function:

void FONcShort::define ( int  ncid )

virtual

define the DAP Int16 or UInt16 in the netcdf file

The definition actually takes place in FONcBaseType. This function adds the attributes for the variable instance as well as an attribute if the name had to be modified.

Parameters

ncid	The id of the NetCDF file

Exceptions

BESInternalError

if there is a problem defining the Byte

Reimplemented from FONcBaseType.

Definition at line 82 of file FONcShort.cc.

References FONcBaseType::_defined, FONcBaseType::_orig_varname, FONcBaseType::_varid, FONcBaseType::_varname, FONcAttributes::add_original_name(), and FONcBaseType::define().

Here is the call graph for this function:

void FONcShort::dump ( ostream &  strm ) const

virtual

dumps information about this object for debugging purposes

Displays the pointer value of this instance plus instance data

Parameters

strm	C++ i/o stream to dump the information to

Implements FONcBaseType.

Definition at line 151 of file FONcShort.cc.

References BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().

Here is the call graph for this function:

bool FONcBaseType::isNetCDF4 ( )

virtualinherited

Returns true if NetCDF4 features will be required.

Definition at line 112 of file FONcBaseType.cc.

References FONcBaseType::_ncVersion, FONcBaseType::_varname, FONcUtils::handle_error(), RETURNAS_NETCDF, and RETURNAS_NETCDF4.

Referenced by FONcArray::define().

Here is the call graph for this function:

string FONcShort::name ( )

virtual

returns the name of the DAP Int16 or UInt16

Returns

The name of the DAP Int16 or UInt16

Implements FONcBaseType.

Definition at line 129 of file FONcShort.cc.

void FONcBaseType::setVersion ( string  version )

virtualinherited

Identifies variable with use of NetCDF4 features.

Definition at line 102 of file FONcBaseType.cc.

References FONcBaseType::_ncVersion, and BESDEBUG.

nc_type FONcShort::type ( )

virtual

returns the netcdf type of the DAP object

Returns

The nc_type of NC_SHORT

Reimplemented from FONcBaseType.

Definition at line 139 of file FONcShort.cc.

virtual int FONcBaseType::varid ( )

inlinevirtualinherited

Definition at line 70 of file FONcBaseType.h.

void FONcShort::write ( int  ncid )

virtual

Write the short out to the netcdf file.

Once the short is defined, the value of the short can be written out as well using nc_put_var1_short

Parameters

ncid	The id of the netcdf file

Exceptions

BESInternalError

if there is a problem writing the value out to the netcdf file

Reimplemented from FONcBaseType.

Definition at line 106 of file FONcShort.cc.

References FONcBaseType::_varid, FONcBaseType::_varname, BESDEBUG, and FONcUtils::handle_error().

Here is the call graph for this function:

Member Data Documentation

bool FONcBaseType::_defined

protectedinherited

Definition at line 55 of file FONcBaseType.h.

Referenced by FONcDouble::define(), FONcFloat::define(), FONcInt::define(), define(), FONcByte::define(), FONcStr::define(), FONcStructure::define(), FONcBaseType::define(), FONcGrid::define(), FONcArray::define(), and FONcGrid::write().

vector<string> FONcBaseType::_embed

protectedinherited

Definition at line 54 of file FONcBaseType.h.

Referenced by FONcBaseType::clear_embedded(), FONcBaseType::convert(), FONcGrid::convert(), FONcStr::define(), and FONcBaseType::define().

string FONcBaseType::_ncVersion

protectedinherited

Definition at line 56 of file FONcBaseType.h.

Referenced by FONcBaseType::isNetCDF4(), and FONcBaseType::setVersion().

string FONcBaseType::_orig_varname

protectedinherited

Definition at line 53 of file FONcBaseType.h.

Referenced by FONcSequence::convert(), FONcGrid::convert(), FONcArray::convert(), FONcDouble::define(), FONcInt::define(), define(), FONcFloat::define(), FONcByte::define(), FONcStr::define(), FONcBaseType::define(), and FONcArray::define().

int FONcBaseType::_varid

protectedinherited

Definition at line 51 of file FONcBaseType.h.

Referenced by FONcDouble::define(), FONcFloat::define(), FONcInt::define(), define(), FONcByte::define(), FONcStr::define(), FONcBaseType::define(), FONcArray::define(), FONcDouble::write(), FONcFloat::write(), FONcInt::write(), write(), FONcByte::write(), FONcStr::write(), and FONcArray::write().

string FONcBaseType::_varname

protectedinherited

Definition at line 52 of file FONcBaseType.h.

Referenced by FONcSequence::convert(), FONcBaseType::convert(), FONcGrid::convert(), FONcArray::convert(), FONcInt::define(), FONcDouble::define(), define(), FONcFloat::define(), FONcByte::define(), FONcSequence::define(), FONcStr::define(), FONcStructure::define(), FONcBaseType::define(), FONcGrid::define(), FONcArray::define(), FONcArray::dump(), FONcBaseType::isNetCDF4(), FONcFloat::write(), FONcDouble::write(), FONcInt::write(), write(), FONcByte::write(), FONcStr::write(), FONcStructure::write(), FONcGrid::write(), and FONcArray::write().

---

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

• FONcShort.h
• FONcShort.cc