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

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

#include <FONcFloat.h>

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

Protected Attributes

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

Detailed Description

A DAP Float32 with file out netcdf information included.

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

Definition at line 47 of file FONcFloat.h.

Constructor & Destructor Documentation

FONcFloat::FONcFloat ( BaseType *  b)

Constructor for FONcFloat that takes a DAP Float32.

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

Parameters
bA DAP BaseType that should be a float32
Exceptions
BESInternalErrorif the BaseType is not a Float32

Definition at line 48 of file FONcFloat.cc.

FONcFloat::~FONcFloat ( )
virtual

Destructor that cleans up this instance.

The DAP Float32 instance does not belong to the FONcFloat instance, so it is not deleted up.

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

define the DAP Float32 in the netcdf file

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

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

Reimplemented from FONcBaseType.

Definition at line 80 of file FONcFloat.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 FONcFloat::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 150 of file FONcFloat.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 FONcFloat::name ( )
virtual

returns the name of the DAP Float32

Returns
The name of the DAP Float32

Implements FONcBaseType.

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

returns the netcdf type of the DAP Float32

Returns
The nc_type of NC_FLOAT

Reimplemented from FONcBaseType.

Definition at line 138 of file FONcFloat.cc.

virtual int FONcBaseType::varid ( )
inlinevirtualinherited

Definition at line 70 of file FONcBaseType.h.

void FONcFloat::write ( int  ncid)
virtual

Write the float out to the netcdf file.

Once the float is defined, the value of the float 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 104 of file FONcFloat.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(), define(), FONcInt::define(), FONcShort::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(), FONcShort::define(), 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(), define(), FONcInt::define(), FONcShort::define(), FONcByte::define(), FONcStr::define(), FONcBaseType::define(), FONcArray::define(), FONcDouble::write(), write(), FONcInt::write(), FONcShort::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(), FONcShort::define(), define(), FONcByte::define(), FONcSequence::define(), FONcStr::define(), FONcStructure::define(), FONcBaseType::define(), FONcGrid::define(), FONcArray::define(), FONcArray::dump(), FONcBaseType::isNetCDF4(), write(), FONcDouble::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: