OPeNDAP Hyrax Back End Server (BES)  Updated for version 3.8.3
Public Member Functions | Protected Attributes | List of all members
FONcByte Class Reference

A class representing the DAP Byte class for file out netcdf. More...

#include <FONcByte.h>

Inheritance diagram for FONcByte:
Inheritance graph
Collaboration diagram for FONcByte:
Collaboration graph

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 Byte in the netcdf file More...
 
virtual void dump (ostream &strm) const
 dumps information about this object for debugging purposes More...
 
 FONcByte (BaseType *b)
 Constructor for FONcByte that takes a DAP Byte. More...
 
virtual bool isNetCDF4 ()
 Returns true if NetCDF4 features will be required. More...
 
virtual string name ()
 returns the name of the DAP Byte 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 Byte More...
 
virtual int varid ()
 
virtual void write (int ncid)
 Write the byte out to the netcdf file. More...
 
virtual ~FONcByte ()
 Destructor that cleans up the byte. More...
 

Protected Attributes

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

Detailed Description

A class representing the DAP Byte class for file out netcdf.

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

Definition at line 48 of file FONcByte.h.

Constructor & Destructor Documentation

FONcByte::FONcByte ( BaseType *  b)

Constructor for FONcByte that takes a DAP Byte.

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

Parameters
bA DAP BaseType that should be a byte
Exceptions
BESInternalErrorif the BaseType is not a Byte

Definition at line 47 of file FONcByte.cc.

FONcByte::~FONcByte ( )
virtual

Destructor that cleans up the byte.

The DAP Byte instance does not belong to the FONcByte instance, so it is not deleted.

Definition at line 64 of file FONcByte.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 FONcByte::define ( int  ncid)
virtual

define the DAP Byte in the netcdf file

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

Parameters
ncidThe id of the NetCDF file
Exceptions
BESInternalErrorif there is a problem defining the Byte

Reimplemented from FONcBaseType.

Definition at line 79 of file FONcByte.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 FONcByte::dump ( ostream &  strm) const
virtual

dumps information about this object for debugging purposes

Displays the pointer value of this instance plus instance data

Parameters
strmC++ i/o stream to dump the information to

Implements FONcBaseType.

Definition at line 147 of file FONcByte.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 FONcByte::name ( )
virtual

returns the name of the DAP Byte

Returns
The name of the DAP Byte

Implements FONcBaseType.

Definition at line 125 of file FONcByte.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 FONcByte::type ( )
virtual

returns the netcdf type of the DAP Byte

Returns
The nc_type of NC_BYTE

Reimplemented from FONcBaseType.

Definition at line 135 of file FONcByte.cc.

virtual int FONcBaseType::varid ( )
inlinevirtualinherited

Definition at line 70 of file FONcBaseType.h.

void FONcByte::write ( int  ncid)
virtual

Write the byte out to the netcdf file.

Once the byte is defined, the value of the byte can be written out as well.

Parameters
ncidThe id of the netcdf file
Exceptions
BESInternalErrorif there is a problem writing the value out to the netcdf file

Reimplemented from FONcBaseType.

Definition at line 103 of file FONcByte.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(), FONcShort::define(), 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(), FONcShort::define(), FONcFloat::define(), 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(), FONcShort::define(), define(), FONcStr::define(), FONcBaseType::define(), FONcArray::define(), FONcDouble::write(), FONcFloat::write(), FONcInt::write(), FONcShort::write(), 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(), FONcShort::define(), FONcFloat::define(), FONcInt::define(), FONcDouble::define(), define(), FONcSequence::define(), FONcStr::define(), FONcStructure::define(), FONcBaseType::define(), FONcGrid::define(), FONcArray::define(), FONcArray::dump(), FONcBaseType::isNetCDF4(), FONcFloat::write(), FONcDouble::write(), FONcInt::write(), FONcShort::write(), write(), FONcStr::write(), FONcStructure::write(), FONcGrid::write(), and FONcArray::write().

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