bes  Updated for version 3.20.6
FONcFloat Class Referenceabstract

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

#include <FONcFloat.h>

Collaboration diagram for FONcFloat:
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 Float32 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...
 
 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 (std::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 () const
 
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
 
std::vector< std::string > _embed
 
std::string _ncVersion
 
std::string _orig_varname
 
int _varid
 
std::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::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::~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

◆ clear_embedded()

void FONcBaseType::clear_embedded ( )
virtualinherited

Clears the list of embedded variable names.

Definition at line 81 of file FONcBaseType.cc.

◆ define()

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.

◆ dump() [1/2]

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

Definition at line 150 of file FONcFloat.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 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.

◆ 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 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.

◆ write()

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.


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