FONcSequence Class Reference

A DAP Sequence with file out netcdf information included. More...

#include <FONcSequence.h>

Inheritance diagram for FONcSequence:

Collaboration diagram for FONcSequence:

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

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

Detailed Description

A DAP Sequence with file out netcdf information included.

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

Definition at line 47 of file FONcSequence.h.

Constructor & Destructor Documentation

FONcSequence::FONcSequence

(

BaseType *

b

)

Constructor for FONcSequence that takes a DAP Sequence.

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

Parameters

b	A DAP BaseType that should be a Sequence

Exceptions

BESInternalError

if the BaseType is not a Sequence

Definition at line 45 of file FONcSequence.cc.

FONcSequence::~FONcSequence ( )

virtual

Destructor that cleans up the sequence.

The DAP Sequence instance does not belong to the FONcSequence instance, so it is not delete it.

Definition at line 62 of file FONcSequence.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 FONcSequence::convert ( vector< string >  embed )

virtual

convert the Sequence to something that can be stored in a netcdf file

Currently Sequences are not supported by FileOut NetCDF

Parameters

embed

The list of parent names for this sequence

Exceptions

BESInternalError

if there is a problem converting the Byte

Reimplemented from FONcBaseType.

Definition at line 76 of file FONcSequence.cc.

References FONcBaseType::_orig_varname, FONcBaseType::_varname, FONcBaseType::convert(), and FONcUtils::gen_name().

Here is the call graph for this function:

void FONcSequence::define ( int  ncid )

virtual

define the DAP Sequence in the netcdf file

Currently, Sequences are not supported by FileOut NetCDF. For now, a global attribute is added to the netcdf file stating that the sequence is not written to the file.

Parameters

ncid	The id of the NetCDF file

Exceptions

BESInternalError

if there is a problem writing out the attribute

Reimplemented from FONcBaseType.

Definition at line 93 of file FONcSequence.cc.

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

Here is the call graph for this function:

void FONcSequence::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 138 of file FONcSequence.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 FONcSequence::name ( )

virtual

Implements FONcBaseType.

Definition at line 126 of file FONcSequence.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 FONcBaseType::type ( )

virtualinherited

Returns the type of data of this variable.

This implementation of the method returns the default type of data. Subclasses of FONcBaseType will return the specific type of data for simple types

Reimplemented in FONcStr, FONcByte, FONcDouble, FONcFloat, FONcInt, and FONcShort.

Definition at line 87 of file FONcBaseType.cc.

Referenced by FONcBaseType::define().

virtual int FONcBaseType::varid ( )

inlinevirtualinherited

Definition at line 70 of file FONcBaseType.h.

void FONcSequence::write ( int  ncid )

virtual

Write the sequence data out to the netcdf file.

Currently, Sequences are not supported by FileOut NetCDF. Nothing is done in this method.

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 121 of file FONcSequence.cc.

Member Data Documentation

bool FONcBaseType::_defined

protectedinherited

Definition at line 55 of file FONcBaseType.h.

Referenced by FONcDouble::define(), FONcFloat::define(), FONcShort::define(), FONcInt::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 convert(), FONcGrid::convert(), FONcArray::convert(), FONcDouble::define(), FONcInt::define(), FONcFloat::define(), FONcShort::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(), FONcShort::define(), FONcInt::define(), FONcByte::define(), FONcStr::define(), FONcBaseType::define(), FONcArray::define(), FONcDouble::write(), FONcInt::write(), FONcFloat::write(), FONcShort::write(), FONcByte::write(), FONcStr::write(), and FONcArray::write().

string FONcBaseType::_varname

protectedinherited

Definition at line 52 of file FONcBaseType.h.

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

---

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

• FONcSequence.h
• FONcSequence.cc