bes  Updated for version 3.20.6
FONcDouble Class Referenceabstract

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

#include <FONcDouble.h>

Collaboration diagram for FONcDouble:
Collaboration graph

Public Member Functions

virtual void clear_embedded ()
 Clears the list of embedded variable names. More...
 
virtual void convert (std::vector< std::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...
 
virtual void dump (std::ostream &strm) const =0
 dump the contents of this object to the specified ostream 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 (std::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 () const
 
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
 
std::vector< std::string > _embed
 
std::string _ncVersion
 
std::string _orig_varname
 
int _varid
 
std::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::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::~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

◆ clear_embedded()

void FONcBaseType::clear_embedded ( )
virtualinherited

Clears the list of embedded variable names.

Definition at line 81 of file FONcBaseType.cc.

◆ define()

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.

◆ dump() [1/2]

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

Definition at line 146 of file FONcDouble.cc.

◆ dump() [2/2]

virtual void FONcBaseType::dump ( std::ostream &  strm) const
pure virtualinherited

dump the contents of this object to the specified ostream

This method is implemented by all derived classes to dump their contents, in other words, any state they might have, private variables, etc...

The inline function below can be used to dump the contents of an OPeNDAOObj object. For example, the object Animal is derived from BESObj. A user could do the following:

Animal *a = new dog( "Sparky" ) ; cout << a << endl ;

And the dump method for dog could display the name passed into the constructor, the (this) pointer of the object, etc...

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

Implements BESObj.

Implemented in FONcArray.

◆ isNetCDF4()

bool FONcBaseType::isNetCDF4 ( )
virtualinherited

Returns true if NetCDF4 features will be required.

Definition at line 97 of file FONcBaseType.cc.

◆ name()

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.

◆ setVersion()

void FONcBaseType::setVersion ( std::string  version)
virtualinherited

Identifies variable with use of NetCDF4 features.

Definition at line 88 of file FONcBaseType.cc.

◆ type()

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.

◆ write()

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.


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