bes Updated for version 3.21.1
The Backend Server (BES) is the lower two tiers of the Hyrax data server
FONcBaseType Class Referenceabstract

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

#include <FONcBaseType.h>

Inheritance diagram for FONcBaseType:
Inheritance graph
Collaboration diagram for FONcBaseType:
Collaboration graph

Public Member Functions

virtual void clear_embedded ()
 Clears the list of embedded variable names.
 
void convert (std::vector< std::string > embed)
 
void convert (std::vector< std::string > embed, bool is_dap4)
 
virtual void convert (std::vector< std::string > embed, bool is_dap4, bool is_dap4_group)
 
virtual void define (int ncid)
 Define the variable in the netcdf file.
 
void dump (std::ostream &strm) const override=0
 dump the contents of this object to the specified ostream
 
libdap::DDS * get_dds () const
 
libdap::ConstraintEvaluator * get_eval () const
 
bool get_fdio_flag () 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.
 
bool isNetCDF4_ENHANCED ()
 
virtual std::string name ()=0
 
void set_dds (libdap::DDS *dds)
 
void set_eval (libdap::ConstraintEvaluator *eval)
 
void set_fdio_flag (bool dio_flag_value=true)
 
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

libdap::DDS * d_dds = nullptr
 
bool d_defined = false
 
std::vector< std::string > d_embed
 
libdap::ConstraintEvaluator * d_eval = nullptr
 
bool d_is_dap4 = false
 
bool d_is_dap4_group = false
 
std::string d_nc4_datamodel
 
std::string d_ncVersion
 
std::string d_orig_varname
 
int d_varid = 0
 
std::string d_varname
 
bool fdio_flag = false
 

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.

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() [1/3]

void FONcBaseType::convert ( std::vector< std::string > embed)
inline

Definition at line 97 of file FONcBaseType.h.

◆ convert() [2/3]

void FONcBaseType::convert ( std::vector< std::string > embed,
bool is_dap4 )
inline

Definition at line 100 of file FONcBaseType.h.

◆ convert() [3/3]

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

Reimplemented in FONcArray.

◆ 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 FONcArray, FONcArrayStructure, FONcArrayStructureField, FONcByte, FONcDouble, FONcFloat, FONcGrid, FONcInt64, FONcInt8, FONcInt, FONcSequence, FONcShort, FONcStr, FONcStructure, FONcUByte, FONcUInt64, FONcUInt, and FONcUShort.

Definition at line 60 of file FONcBaseType.cc.

◆ dump()

void FONcBaseType::dump ( std::ostream & strm) const
overridepure 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, and FONcArrayStructureField.

◆ get_dds()

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

Definition at line 89 of file FONcBaseType.h.

◆ get_eval()

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

Definition at line 92 of file FONcBaseType.h.

◆ get_fdio_flag()

bool FONcBaseType::get_fdio_flag ( ) const
inline

Definition at line 129 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 ( )

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 90 of file FONcBaseType.h.

◆ set_eval()

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

Definition at line 93 of file FONcBaseType.h.

◆ set_fdio_flag()

void FONcBaseType::set_fdio_flag ( bool dio_flag_value = true)
inline

Definition at line 130 of file FONcBaseType.h.

◆ set_is_dap4()

virtual void FONcBaseType::set_is_dap4 ( bool set_dap4)
inlinevirtual

Definition at line 121 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 FONcArrayStructureField, FONcByte, FONcDouble, FONcFloat, FONcInt64, FONcInt8, FONcInt, FONcShort, FONcStr, FONcUByte, FONcUInt64, FONcUInt, and FONcUShort.

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 113 of file FONcBaseType.h.

◆ write()

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

Member Data Documentation

◆ d_dds

libdap::DDS* FONcBaseType::d_dds = nullptr
protected

Definition at line 76 of file FONcBaseType.h.

◆ d_defined

bool FONcBaseType::d_defined = false
protected

Definition at line 66 of file FONcBaseType.h.

◆ d_embed

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

Definition at line 65 of file FONcBaseType.h.

◆ d_eval

libdap::ConstraintEvaluator* FONcBaseType::d_eval = nullptr
protected

Definition at line 77 of file FONcBaseType.h.

◆ d_is_dap4

bool FONcBaseType::d_is_dap4 = false
protected

Definition at line 71 of file FONcBaseType.h.

◆ d_is_dap4_group

bool FONcBaseType::d_is_dap4_group = false
protected

Definition at line 74 of file FONcBaseType.h.

◆ d_nc4_datamodel

std::string FONcBaseType::d_nc4_datamodel
protected

Definition at line 68 of file FONcBaseType.h.

◆ d_ncVersion

std::string FONcBaseType::d_ncVersion
protected

Definition at line 67 of file FONcBaseType.h.

◆ d_orig_varname

std::string FONcBaseType::d_orig_varname
protected

Definition at line 64 of file FONcBaseType.h.

◆ d_varid

int FONcBaseType::d_varid = 0
protected

Definition at line 62 of file FONcBaseType.h.

◆ d_varname

std::string FONcBaseType::d_varname
protected

Definition at line 63 of file FONcBaseType.h.

◆ fdio_flag

bool FONcBaseType::fdio_flag = false
protected

Definition at line 82 of file FONcBaseType.h.


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