bes  Updated for version 3.20.10
FONcInt64 Class Referenceabstract

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

#include <FONcInt64.h>

Collaboration diagram for FONcInt64:
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=false, bool is_dap4_group=false)
 
virtual void define (int ncid)
 define the DAP Int64 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...
 
 FONcInt64 (libdap::BaseType *b)
 Constructor for FOncInt64 that takes a DAP Int64. More...
 
libdap::DDS * get_dds () const
 
libdap::ConstraintEvaluator * get_eval () const
 
virtual libdap::AttrType getAttrType (nc_type t)
 
virtual D4AttributeType getD4AttrType (nc_type t)
 
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 Int64 More...
 
void set_dds (libdap::DDS *dds)
 
void set_eval (libdap::ConstraintEvaluator *eval)
 
virtual void set_is_dap4 (bool set_dap4)
 
virtual void setNC4DataModel (const string &nc4_datamodel)
 Identifies the netCDF4 data model (CLASSIC or ENHANCED) More...
 
virtual void setVersion (const 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 void updateAttrType (libdap::AttrTable &attrs, nc_type t)
 
virtual void updateD4AttrType (libdap::D4Attributes *d4_attrs, nc_type t)
 
virtual int varid () const
 
virtual void write (int ncid)
 Write the unsigned int out to the netcdf file. More...
 
virtual ~FONcInt64 ()
 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
 
libdap::DDS * d_dds
 
libdap::ConstraintEvaluator * d_eval
 
bool is_dap4
 
bool is_dap4_group
 

Detailed Description

A DAP Int64 with file out netcdf information included.

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

Definition at line 44 of file FONcInt64.h.

Constructor & Destructor Documentation

◆ FONcInt64()

FONcInt64::FONcInt64 ( libdap::BaseType *  b)

Constructor for FOncInt64 that takes a DAP Int64.

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

Parameters
bA DAP BaseType that should be an uint64
Exceptions
BESInternalErrorif the BaseType is not an Int64

Definition at line 49 of file FONcInt64.cc.

◆ ~FONcInt64()

FONcInt64::~FONcInt64 ( )
virtual

Destructor that cleans up the instance.

The DAP Int64 instance does not belong to the FONcInt64 instance, so it is not deleted.

Definition at line 66 of file FONcInt64.cc.

Member Function Documentation

◆ clear_embedded()

void FONcBaseType::clear_embedded ( )
virtualinherited

Clears the list of embedded variable names.

Definition at line 93 of file FONcBaseType.cc.

◆ define()

void FONcInt64::define ( int  ncid)
virtual

define the DAP Int64 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 Int64

Reimplemented from FONcBaseType.

Definition at line 81 of file FONcInt64.cc.

◆ dump() [1/2]

void FONcInt64::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 165 of file FONcInt64.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 118 of file FONcBaseType.cc.

◆ name()

string FONcInt64::name ( )
virtual

returns the name of the DAP Int64

Returns
The name of the DAP Int64

Implements FONcBaseType.

Definition at line 143 of file FONcInt64.cc.

◆ setNC4DataModel()

void FONcBaseType::setNC4DataModel ( const string &  nc4_datamodel)
virtualinherited

Identifies the netCDF4 data model (CLASSIC or ENHANCED)

Definition at line 109 of file FONcBaseType.cc.

◆ setVersion()

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

Identifies variable with use of NetCDF4 features.

Definition at line 100 of file FONcBaseType.cc.

◆ type()

nc_type FONcInt64::type ( )
virtual

returns the netcdf type of the DAP object

Returns
The nc_type of NC_UINT

Reimplemented from FONcBaseType.

Definition at line 153 of file FONcInt64.cc.

◆ write()

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

Implements FONcBaseType.

Definition at line 112 of file FONcInt64.cc.


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