bes
Updated for version 3.20.6
|
A DAP Grid with file out netcdf information included. More...
#include <FONcGrid.h>
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 | convert (vector< string > embed) |
convert the DAP Grid to a set of embedded variables More... | |
virtual void | define (int ncid) |
define the DAP Grid 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... | |
FONcGrid (BaseType *b) | |
Constructor for FONcGrid that takes a DAP Grid. More... | |
virtual bool | isNetCDF4 () |
Returns true if NetCDF4 features will be required. More... | |
virtual string | name () |
returns the name of the DAP Grid More... | |
virtual void | setVersion (std::string version) |
Identifies variable with use of NetCDF4 features. More... | |
virtual nc_type | type () |
Returns the type of data of this variable. More... | |
virtual int | varid () const |
virtual void | write (int ncid) |
Write the maps and array for the grid. More... | |
virtual | ~FONcGrid () |
Destructor that cleans up the grid. More... | |
Static Public Member Functions | |
static FONcMap * | InMaps (Array *array) |
Static Public Attributes | |
static bool | InGrid = false |
tells whether we are converting or defining a grid. More... | |
static vector< FONcMap * > | Maps |
global list of maps that could be shared amongst the different grids More... | |
Protected Attributes | |
bool | _defined |
std::vector< std::string > | _embed |
std::string | _ncVersion |
std::string | _orig_varname |
int | _varid |
std::string | _varname |
A DAP Grid with file out netcdf information included.
This class represents a DAP Grid with additional information needed to write it out to a netcdf file and includes a reference to the actual DAP Grid being converted, the maps of the grid stored as FONcMap instances, and the array of the grid stored as a FONcArray.
NetCDF does not have a grid representation, per se. For this reason, we flatten the DAP grid into different arrays (maps) as well as the grid's actual array.
It is possible to share maps among grids, so a global map list is kept as well.
Definition at line 57 of file FONcGrid.h.
FONcGrid::FONcGrid | ( | BaseType * | b | ) |
Constructor for FONcGrid that takes a DAP Grid.
This constructor takes a DAP BaseType and makes sure that it is a DAP Grid instance. If not, it throws an exception
b | A DAP BaseType that should be a grid |
BESInternalError | if the BaseType is not a Grid |
Definition at line 60 of file FONcGrid.cc.
|
virtual |
Destructor that cleans up the grid.
The DAP Grid instance does not belong to the FONcGrid instance, so it is not deleted.
Since maps can be shared by grids, FONcMap uses reference counting. So instead of deleting the FONcMap instance, its reference count is decremented.
Definition at line 78 of file FONcGrid.cc.
|
virtualinherited |
Clears the list of embedded variable names.
Definition at line 81 of file FONcBaseType.cc.
|
virtual |
convert the DAP Grid to a set of embedded variables
A DAP Grid contains one or more maps (arrays) and an array of values. The convert method creates a FONcMap for each of the grid's maps, and a FONcArray for the grid's array.
A map can be shared by other grids if the name of the map is the same, the size of the map is the same, the type of the map is the same, and the values of the map are the same. If they are the same, then it references that shared map instead of creating a new one.
embed | The list of parent names for this grid |
BESInternalError | if there is a problem defining the Byte |
Definition at line 142 of file FONcGrid.cc.
|
virtual |
define the DAP Grid in the netcdf file
Iterates through the maps for this grid and defines each of those, if they haven't already been defined by a grid that shares the map. Then it defines the grid's array in the netcdf file.
Any attributes for the grid will be written out for each of the maps and the array.
ncid | The id of the NetCDF file |
BESInternalError | if there is a problem defining the Byte |
Reimplemented from FONcBaseType.
Definition at line 104 of file FONcGrid.cc.
|
virtual |
dumps information about this object for debugging purposes
Displays the pointer value of this instance plus instance data. Included is each FONcMap instance as well as the FONcArray representing the grid's array.
strm | C++ i/o stream to dump the information to |
Definition at line 251 of file FONcGrid.cc.
|
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...
strm | C++ i/o stream to dump the object to |
Implements BESObj.
Implemented in FONcArray.
|
virtualinherited |
Returns true if NetCDF4 features will be required.
Definition at line 97 of file FONcBaseType.cc.
|
virtual |
returns the name of the DAP Grid
Implements FONcBaseType.
Definition at line 238 of file FONcGrid.cc.
|
virtualinherited |
Identifies variable with use of NetCDF4 features.
Definition at line 88 of file FONcBaseType.cc.
|
virtualinherited |
Returns the type of data of this variable.
This implementation of the method returns the default type of data. Subclasses of FONcBaseType will return the specific type of data for simple types
Reimplemented in FONcStr, FONcByte, FONcDouble, FONcFloat, FONcInt, and FONcShort.
Definition at line 74 of file FONcBaseType.cc.
|
virtual |
Write the maps and array for the grid.
Once defined, the values of the maps and the values of the grid's array can be written out to the netcdf file.
ncid | The id of the netcdf file |
BESInternalError | if there is a problem writing the grid out to the netcdf file |
Reimplemented from FONcBaseType.
Definition at line 212 of file FONcGrid.cc.
|
static |
tells whether we are converting or defining a grid.
This is used by FONcArray to tell if any single dimension arrays where the name of the array and the name of the dimension are the same. If they are, then that array is saved as a possible shared map
Definition at line 76 of file FONcGrid.h.
|
static |
global list of maps that could be shared amongst the different grids
Definition at line 74 of file FONcGrid.h.