bes  Updated for version 3.20.5
FONcShort Class Reference

A DAP Int16 and UInt16 with file out netcdf information included. More...

#include <FONcShort.h>

Collaboration diagram for FONcShort:
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 Int16 or UInt16 in the netcdf file More...
 
virtual void dump (ostream &strm) const
 dumps information about this object for debugging purposes More...
 
 FONcShort (BaseType *b)
 Constructor for FOncShort that takes a DAP Int16 or UInt16. More...
 
virtual bool isNetCDF4 ()
 Returns true if NetCDF4 features will be required. More...
 
virtual string name ()
 returns the name of the DAP Int16 or UInt16 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 short out to the netcdf file. More...
 
virtual ~FONcShort ()
 Destructor that cleans up the short. 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 Int16 and UInt16 with file out netcdf information included.

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

Definition at line 47 of file FONcShort.h.

Constructor & Destructor Documentation

◆ FONcShort()

FONcShort::FONcShort ( BaseType *  b)

Constructor for FOncShort that takes a DAP Int16 or UInt16.

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

Parameters
bA DAP BaseType that should be a byte
Exceptions
BESInternalErrorif the BaseType is not a Int16 or UInt16

Definition at line 49 of file FONcShort.cc.

◆ ~FONcShort()

FONcShort::~FONcShort ( )
virtual

Destructor that cleans up the short.

The DAP Int16 or UInt16 instance does not belong to the FONcByte instance, so it is not deleted.

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

define the DAP Int16 or UInt16 in the netcdf file

The definition actually takes place in FONcBaseType. This function adds the attributes for the variable instance as well as an attribute if the name 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 82 of file FONcShort.cc.

◆ dump()

void FONcShort::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

Implements FONcBaseType.

Definition at line 151 of file FONcShort.cc.

◆ isNetCDF4()

bool FONcBaseType::isNetCDF4 ( )
virtualinherited

Returns true if NetCDF4 features will be required.

Definition at line 97 of file FONcBaseType.cc.

◆ name()

string FONcShort::name ( )
virtual

returns the name of the DAP Int16 or UInt16

Returns
The name of the DAP Int16 or UInt16

Implements FONcBaseType.

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

returns the netcdf type of the DAP object

Returns
The nc_type of NC_SHORT

Reimplemented from FONcBaseType.

Definition at line 139 of file FONcShort.cc.

◆ write()

void FONcShort::write ( int  ncid)
virtual

Write the short out to the netcdf file.

Once the short is defined, the value of the short can be written out as well using nc_put_var1_short

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 106 of file FONcShort.cc.


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