OPeNDAP Hyrax Back End Server (BES)  Updated for version 3.8.3
FONcDouble Class Reference

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

#include <FONcDouble.h>

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

Protected Attributes

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

Detailed Description

A DAP Float64 with file out netcdf information included.

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

Definition at line 47 of file FONcDouble.h.

Constructor & Destructor Documentation

FONcDouble::FONcDouble ( BaseType *  b)

Constructor for FOncDouble that takes a DAP Float64.

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

Parameters
bA DAP BaseType that should be a float64
Exceptions
BESInternalErrorif the BaseType is not a Float64

Definition at line 48 of file FONcDouble.cc.

FONcDouble::~FONcDouble ( )
virtual

Destructor that cleans up the instance.

Since the DAP object is not owned by this instance, it is not deleted

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

define the DAP Float64 in the netcdf file

The parent class, FONcBaseType, actually defines the variable since it is a simple type. This method adds the attributes for the Float64 and an attribute if the name had to be modified in any way.

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

Reimplemented from FONcBaseType.

Definition at line 79 of file FONcDouble.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 FONcDouble::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 146 of file FONcDouble.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 FONcDouble::name ( )
virtual

returns the name of the DAP Float64

Returns
The name of the DAP Float64

Implements FONcBaseType.

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

returns the netcdf type of the DAP Float64

Returns
The nc_type of NC_DOUBLE

Reimplemented from FONcBaseType.

Definition at line 134 of file FONcDouble.cc.

virtual int FONcBaseType::varid ( )
inlinevirtualinherited

Definition at line 70 of file FONcBaseType.h.

void FONcDouble::write ( int  ncid)
virtual

Write the float64 out to the netcdf file.

Once the double is defined, the value can be written out

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

Reimplemented from FONcBaseType.

Definition at line 101 of file FONcDouble.cc.

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

Here is the call graph for this function:

Member Data Documentation

vector<string> FONcBaseType::_embed
protectedinherited
string FONcBaseType::_ncVersion
protectedinherited

Definition at line 56 of file FONcBaseType.h.

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


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