bes Updated for version 3.20.13
FONcBaseType Class Referenceabstract

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

#include <FONcBaseType.h>

Collaboration diagram for FONcBaseType:
Collaboration graph

Public Member Functions

virtual void clear_embedded ()
 Clears the list of embedded variable names.
 
virtual void convert (std::vector< std::string > embed, bool is_dap4=false, bool is_dap4_group=false)
 
virtual void define (int ncid)
 Define the variable in the netcdf file.
 
virtual void dump (std::ostream &strm) const =0
 dump the contents of this object to the specified ostream
 
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.
 
virtual bool isNetCDF4_ENHANCED ()
 
virtual std::string name ()=0
 
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)
 
virtual void setVersion (const std::string &version)
 Identifies variable with use of NetCDF4 features.
 
virtual nc_type type ()
 Returns the type of data of this variable.
 
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)=0
 

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 BaseType with file out netcdf information included.

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

Definition at line 60 of file FONcBaseType.h.

Constructor & Destructor Documentation

◆ FONcBaseType()

FONcBaseType::FONcBaseType ( )
inlineprotected

Definition at line 77 of file FONcBaseType.h.

Member Function Documentation

◆ clear_embedded()

void FONcBaseType::clear_embedded ( )
virtual

Clears the list of embedded variable names.

Definition at line 93 of file FONcBaseType.cc.

◆ convert()

void FONcBaseType::convert ( std::vector< std::string >  embed,
bool  is_dap4 = false,
bool  is_dap4_group = false 
)
virtual

Reimplemented in FONcArray.

Definition at line 42 of file FONcBaseType.cc.

◆ define()

void FONcBaseType::define ( int  ncid)
virtual

Define the variable in the netcdf file.

This method creates this variable in the netcdf file. This implementation is used for only simple types (byte, short, int, float, double), and not for the complex types (str, structure, array, grid, sequence)

Parameters
ncidId of the NetCDF file
Exceptions
BESInternalErrorif defining the variable fails

Reimplemented in FONcFloat, FONcInt, FONcInt64, FONcInt8, FONcSequence, FONcShort, FONcStr, FONcStructure, FONcUByte, FONcUInt, FONcUInt64, FONcUShort, FONcArray, FONcByte, FONcDouble, and FONcGrid.

Definition at line 60 of file FONcBaseType.cc.

◆ dump()

virtual void FONcBaseType::dump ( std::ostream &  strm) const
pure virtual

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 OPeNDAPObj 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.

◆ get_dds()

libdap::DDS * FONcBaseType::get_dds ( ) const
inline

Definition at line 82 of file FONcBaseType.h.

◆ get_eval()

libdap::ConstraintEvaluator * FONcBaseType::get_eval ( ) const
inline

Definition at line 85 of file FONcBaseType.h.

◆ getAttrType()

libdap::AttrType FONcBaseType::getAttrType ( nc_type  t)
virtual

Definition at line 163 of file FONcBaseType.cc.

◆ getD4AttrType()

D4AttributeType FONcBaseType::getD4AttrType ( nc_type  t)
virtual

Definition at line 211 of file FONcBaseType.cc.

◆ isNetCDF4()

bool FONcBaseType::isNetCDF4 ( )
virtual

Returns true if NetCDF4 features will be required.

Definition at line 118 of file FONcBaseType.cc.

◆ isNetCDF4_ENHANCED()

bool FONcBaseType::isNetCDF4_ENHANCED ( )
virtual

Definition at line 123 of file FONcBaseType.cc.

◆ name()

virtual std::string FONcBaseType::name ( )
pure virtual

◆ set_dds()

void FONcBaseType::set_dds ( libdap::DDS *  dds)
inline

Definition at line 83 of file FONcBaseType.h.

◆ set_eval()

void FONcBaseType::set_eval ( libdap::ConstraintEvaluator *  eval)
inline

Definition at line 86 of file FONcBaseType.h.

◆ set_is_dap4()

virtual void FONcBaseType::set_is_dap4 ( bool  set_dap4)
inlinevirtual

Definition at line 103 of file FONcBaseType.h.

◆ setNC4DataModel()

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

Identifies the netCDF4 data model (CLASSIC or ENHANCED)

Definition at line 109 of file FONcBaseType.cc.

◆ setVersion()

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

Identifies variable with use of NetCDF4 features.

Definition at line 100 of file FONcBaseType.cc.

◆ type()

nc_type FONcBaseType::type ( )
virtual

Returns the type of data of this variable.

This implementation of the method returns the default type of data. Subclasses of FONcBaseType will return the specific type of data for simple types

Reimplemented in FONcFloat, FONcInt, FONcInt64, FONcInt8, FONcShort, FONcStr, FONcUByte, FONcUInt, FONcUInt64, FONcUShort, FONcByte, and FONcDouble.

Definition at line 86 of file FONcBaseType.cc.

◆ updateAttrType()

void FONcBaseType::updateAttrType ( libdap::AttrTable &  attrs,
nc_type  t 
)
virtual

Definition at line 144 of file FONcBaseType.cc.

◆ updateD4AttrType()

void FONcBaseType::updateD4AttrType ( libdap::D4Attributes *  d4_attrs,
nc_type  t 
)
virtual

Definition at line 128 of file FONcBaseType.cc.

◆ varid()

virtual int FONcBaseType::varid ( ) const
inlinevirtual

Definition at line 95 of file FONcBaseType.h.

◆ write()

virtual void FONcBaseType::write ( int  ncid)
pure virtual

Member Data Documentation

◆ _defined

bool FONcBaseType::_defined
protected

Definition at line 66 of file FONcBaseType.h.

◆ _embed

std::vector<std::string> FONcBaseType::_embed
protected

Definition at line 65 of file FONcBaseType.h.

◆ _nc4_datamodel

std::string FONcBaseType::_nc4_datamodel
protected

Definition at line 68 of file FONcBaseType.h.

◆ _ncVersion

std::string FONcBaseType::_ncVersion
protected

Definition at line 67 of file FONcBaseType.h.

◆ _orig_varname

std::string FONcBaseType::_orig_varname
protected

Definition at line 64 of file FONcBaseType.h.

◆ _varid

int FONcBaseType::_varid
protected

Definition at line 62 of file FONcBaseType.h.

◆ _varname

std::string FONcBaseType::_varname
protected

Definition at line 63 of file FONcBaseType.h.

◆ d_dds

libdap::DDS* FONcBaseType::d_dds
protected

Definition at line 74 of file FONcBaseType.h.

◆ d_eval

libdap::ConstraintEvaluator* FONcBaseType::d_eval
protected

Definition at line 75 of file FONcBaseType.h.

◆ is_dap4

bool FONcBaseType::is_dap4
protected

Definition at line 69 of file FONcBaseType.h.

◆ is_dap4_group

bool FONcBaseType::is_dap4_group
protected

Definition at line 72 of file FONcBaseType.h.


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