bes  Updated for version 3.20.6
FONcByte Class Referenceabstract

A class representing the DAP Byte class for file out netcdf. More...

#include <FONcByte.h>

Collaboration diagram for FONcByte:
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 Byte 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...
 
 FONcByte (BaseType *b)
 Constructor for FONcByte that takes a DAP Byte. More...
 
virtual bool isNetCDF4 ()
 Returns true if NetCDF4 features will be required. More...
 
virtual string name ()
 returns the name of the DAP Byte 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 Byte More...
 
virtual int varid () const
 
virtual void write (int ncid)
 Write the byte out to the netcdf file. More...
 
virtual ~FONcByte ()
 Destructor that cleans up the byte. 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 class representing the DAP Byte class for file out netcdf.

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

Definition at line 48 of file FONcByte.h.

Constructor & Destructor Documentation

◆ FONcByte()

FONcByte::FONcByte ( BaseType *  b)

Constructor for FONcByte that takes a DAP Byte.

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

Parameters
bA DAP BaseType that should be a byte
Exceptions
BESInternalErrorif the BaseType is not a Byte

Definition at line 47 of file FONcByte.cc.

◆ ~FONcByte()

FONcByte::~FONcByte ( )
virtual

Destructor that cleans up the byte.

The DAP Byte instance does not belong to the FONcByte instance, so it is not deleted.

Definition at line 64 of file FONcByte.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 FONcByte::define ( int  ncid)
virtual

define the DAP Byte in the netcdf file

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

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

Reimplemented from FONcBaseType.

Definition at line 79 of file FONcByte.cc.

◆ dump() [1/2]

void FONcByte::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 147 of file FONcByte.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 FONcByte::name ( )
virtual

returns the name of the DAP Byte

Returns
The name of the DAP Byte

Implements FONcBaseType.

Definition at line 125 of file FONcByte.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 FONcByte::type ( )
virtual

returns the netcdf type of the DAP Byte

Returns
The nc_type of NC_BYTE

Reimplemented from FONcBaseType.

Definition at line 135 of file FONcByte.cc.

◆ write()

void FONcByte::write ( int  ncid)
virtual

Write the byte out to the netcdf file.

Once the byte is defined, the value of the byte 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 103 of file FONcByte.cc.


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