bes
Updated for version 3.20.6
|
A class representing the DAP Str class for file out netcdf. More...
#include <FONcStr.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 | define (int ncid) |
Define the string variable 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... | |
FONcStr (libdap::BaseType *b) | |
Constructor for FONcStr that takes a DAP Str. More... | |
virtual bool | isNetCDF4 () |
Returns true if NetCDF4 features will be required. More... | |
virtual string | name () |
returns the name of the DAP Str 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 Str More... | |
virtual int | varid () const |
virtual void | write (int ncid) |
Write the str out to the netcdf file. More... | |
virtual | ~FONcStr () |
Destructor that cleans up the str. More... | |
Protected Attributes | |
bool | _defined |
std::vector< std::string > | _embed |
std::string | _ncVersion |
std::string | _orig_varname |
int | _varid |
std::string | _varname |
A class representing the DAP Str class for file out netcdf.
This class represents a DAP Str with additional information needed to write it out to a netcdf file. Includes a pointer to the actual DAP Str being converted.
FONcStr::FONcStr | ( | libdap::BaseType * | b | ) |
Constructor for FONcStr that takes a DAP Str.
This constructor takes a DAP BaseType and makes sure that it is a DAP Str instance. If not, it throws an exception
b | A DAP BaseType that should be a Str |
BESInternalError | if the BaseType is not a Str |
Definition at line 51 of file FONcStr.cc.
|
virtual |
Destructor that cleans up the str.
The DAP Str instance does not belong to the FONcByte instance, so it is not cleaned up. During definition, though, the data needed to be extracted to calculate the length dimension. It is kept so that we don't have to get the data twice. The string data is deleted here.
Definition at line 66 of file FONcStr.cc.
|
virtualinherited |
Clears the list of embedded variable names.
Definition at line 81 of file FONcBaseType.cc.
|
virtual |
Define the string variable in the netcdf file.
This method creates this string variable in the netcdf file. To do this we define a dimension that specifies the length of the string.
ncid | Id of the NetCDF file |
BESInternalError | if defining the variable fails |
Reimplemented from FONcBaseType.
Definition at line 79 of file FONcStr.cc.
|
virtual |
dumps information about this object for debugging purposes
Displays the pointer value of this instance plus instance data
strm | C++ i/o stream to dump the information to |
Definition at line 168 of file FONcStr.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 Str
Implements FONcBaseType.
Definition at line 148 of file FONcStr.cc.
|
virtualinherited |
Identifies variable with use of NetCDF4 features.
Definition at line 88 of file FONcBaseType.cc.
|
virtual |
returns the netcdf type of the DAP Str
Reimplemented from FONcBaseType.
Definition at line 157 of file FONcStr.cc.
|
virtual |
Write the str out to the netcdf file.
Once the str is defined, the value of the str can be written out as well using nc_put_vara_text
ncid | The id of the netcdf file |
BESInternalError | if there is a problem writing the value out to the netcdf file |
Reimplemented from FONcBaseType.
Definition at line 122 of file FONcStr.cc.