bes  Updated for version 3.20.8
FONcUInt Class Referenceabstract

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

#include <FONcUInt.h>

Collaboration diagram for FONcUInt:
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, bool is_dap4_group=false)
 
virtual void define (int ncid)
 define the DAP UInt32 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...
 
 FONcUInt (BaseType *b)
 Constructor for FOncUInt that takes a DAP UInt32. More...
 
virtual bool isNetCDF4 ()
 Returns true if NetCDF4 features will be required. More...
 
virtual bool isNetCDF4_ENHANCED ()
 
virtual string name ()
 returns the name of the DAP UInt32 More...
 
virtual void set_is_dap4 (bool set_dap4)
 
virtual void setNC4DataModel (std::string nc4_datamodel)
 Identifies the netCDF4 data model (CLASSIC or ENHANCED) 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 object More...
 
virtual int varid () const
 
virtual void write (int ncid)
 Write the unsigned int out to the netcdf file. More...
 
virtual ~FONcUInt ()
 Destructor that cleans up the instance. More...
 

Protected Attributes

bool _defined
 
std::vector< std::string > _embed
 
std::string _nc4_datamodel
 
std::string _ncVersion
 
std::string _orig_varname
 
int _varid
 
std::string _varname
 
bool is_dap4
 
bool is_dap4_group
 

Detailed Description

A DAP UInt32 with file out netcdf information included.

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

Definition at line 42 of file FONcUInt.h.

Constructor & Destructor Documentation

◆ FONcUInt()

FONcUInt::FONcUInt ( BaseType *  b)

Constructor for FOncUInt that takes a DAP UInt32.

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

Parameters
bA DAP BaseType that should be an uint32
Exceptions
BESInternalErrorif the BaseType is not an UInt32

Definition at line 49 of file FONcUInt.cc.

◆ ~FONcUInt()

FONcUInt::~FONcUInt ( )
virtual

Destructor that cleans up the instance.

The DAP UInt32 instance does not belong to the FONcInt instance, so it is not deleted.

Definition at line 66 of file FONcUInt.cc.

Member Function Documentation

◆ clear_embedded()

void FONcBaseType::clear_embedded ( )
virtualinherited

Clears the list of embedded variable names.

Definition at line 82 of file FONcBaseType.cc.

◆ define()

void FONcUInt::define ( int  ncid)
virtual

define the DAP UInt32 in the netcdf file

The definition actually takes place in FONcBaseType. This function adds the attributes for the instance as well as an attribute if the name of the variable had to be modified.

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

Reimplemented from FONcBaseType.

Definition at line 81 of file FONcUInt.cc.

◆ dump() [1/2]

void FONcUInt::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 148 of file FONcUInt.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 106 of file FONcBaseType.cc.

◆ name()

string FONcUInt::name ( )
virtual

returns the name of the DAP UInt32

Returns
The name of the DAP UInt32

Implements FONcBaseType.

Definition at line 126 of file FONcUInt.cc.

◆ setNC4DataModel()

void FONcBaseType::setNC4DataModel ( std::string  nc4_datamodel)
virtualinherited

Identifies the netCDF4 data model (CLASSIC or ENHANCED)

Definition at line 98 of file FONcBaseType.cc.

◆ setVersion()

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

Identifies variable with use of NetCDF4 features.

Definition at line 89 of file FONcBaseType.cc.

◆ type()

nc_type FONcUInt::type ( )
virtual

returns the netcdf type of the DAP object

Returns
The nc_type of NC_UINT

Reimplemented from FONcBaseType.

Definition at line 136 of file FONcUInt.cc.

◆ write()

void FONcUInt::write ( int  ncid)
virtual

Write the unsigned int out to the netcdf file.

Once the unsigned int is defined, the value of the unsigned int 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 103 of file FONcUInt.cc.


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