bes Updated for version 3.20.13
FONcSequence Class Referenceabstract

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

#include <FONcSequence.h>

Collaboration diagram for FONcSequence:
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 convert (vector< string > embed, bool _dap4=false, bool is_dap4_group=false)
 convert the Sequence to something that can be stored in a netcdf file
 
virtual void define (int ncid)
 define the DAP Sequence in the netcdf file
 
virtual void dump (ostream &strm) const
 dumps information about this object for debugging purposes
 
virtual void dump (std::ostream &strm) const =0
 dump the contents of this object to the specified ostream
 
 FONcSequence (libdap::BaseType *b)
 Constructor for FONcSequence that takes a DAP Sequence.
 
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 string name ()
 
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)
 Write the sequence data out to the netcdf file.
 
virtual ~FONcSequence ()
 Destructor that cleans up the sequence.
 

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

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

Definition at line 50 of file FONcSequence.h.

Constructor & Destructor Documentation

◆ FONcSequence()

FONcSequence::FONcSequence ( libdap::BaseType *  b)

Constructor for FONcSequence that takes a DAP Sequence.

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

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

Definition at line 45 of file FONcSequence.cc.

◆ ~FONcSequence()

FONcSequence::~FONcSequence ( )
virtual

Destructor that cleans up the sequence.

The DAP Sequence instance does not belong to the FONcSequence instance, so it is not delete it.

Definition at line 59 of file FONcSequence.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.

◆ convert() [1/2]

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

Reimplemented in FONcArray.

Definition at line 42 of file FONcBaseType.cc.

◆ convert() [2/2]

void FONcSequence::convert ( vector< string >  embed,
bool  _dap4 = false,
bool  is_dap4_group = false 
)
virtual

convert the Sequence to something that can be stored in a netcdf file

Currently Sequences are not supported by FileOut NetCDF

Parameters
embedThe list of parent names for this sequence
Exceptions
BESInternalErrorif there is a problem converting the Byte

Definition at line 72 of file FONcSequence.cc.

◆ define()

void FONcSequence::define ( int  ncid)
virtual

define the DAP Sequence in the netcdf file

Currently, Sequences are not supported by FileOut NetCDF. For now, a global attribute is added to the netcdf file stating that the sequence is not written to the file.

Parameters
ncidThe id of the NetCDF file
Exceptions
BESInternalErrorif there is a problem writing out the attribute

Reimplemented from FONcBaseType.

Definition at line 88 of file FONcSequence.cc.

◆ dump() [1/2]

void FONcSequence::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 126 of file FONcSequence.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 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
inlineinherited

Definition at line 82 of file FONcBaseType.h.

◆ get_eval()

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

Definition at line 85 of file FONcBaseType.h.

◆ getAttrType()

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

Definition at line 163 of file FONcBaseType.cc.

◆ getD4AttrType()

D4AttributeType FONcBaseType::getD4AttrType ( nc_type  t)
virtualinherited

Definition at line 211 of file FONcBaseType.cc.

◆ isNetCDF4()

bool FONcBaseType::isNetCDF4 ( )
virtualinherited

Returns true if NetCDF4 features will be required.

Definition at line 118 of file FONcBaseType.cc.

◆ isNetCDF4_ENHANCED()

bool FONcBaseType::isNetCDF4_ENHANCED ( )
virtualinherited

Definition at line 123 of file FONcBaseType.cc.

◆ name()

string FONcSequence::name ( )
virtual

Implements FONcBaseType.

Definition at line 115 of file FONcSequence.cc.

◆ set_dds()

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

Definition at line 83 of file FONcBaseType.h.

◆ set_eval()

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

Definition at line 86 of file FONcBaseType.h.

◆ set_is_dap4()

virtual void FONcBaseType::set_is_dap4 ( bool  set_dap4)
inlinevirtualinherited

Definition at line 103 of file FONcBaseType.h.

◆ 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 FONcBaseType::type ( )
virtualinherited

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 
)
virtualinherited

Definition at line 144 of file FONcBaseType.cc.

◆ updateD4AttrType()

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

Definition at line 128 of file FONcBaseType.cc.

◆ varid()

virtual int FONcBaseType::varid ( ) const
inlinevirtualinherited

Definition at line 95 of file FONcBaseType.h.

◆ write()

void FONcSequence::write ( int  ncid)
virtual

Write the sequence data out to the netcdf file.

Currently, Sequences are not supported by FileOut NetCDF. Nothing is done in this method.

Parameters
ncidThe id of the netcdf file
Exceptions
BESInternalErrorif there is a problem writing the value out to the netcdf file

Implements FONcBaseType.

Definition at line 110 of file FONcSequence.cc.

Member Data Documentation

◆ _defined

bool FONcBaseType::_defined
protectedinherited

Definition at line 66 of file FONcBaseType.h.

◆ _embed

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

Definition at line 65 of file FONcBaseType.h.

◆ _nc4_datamodel

std::string FONcBaseType::_nc4_datamodel
protectedinherited

Definition at line 68 of file FONcBaseType.h.

◆ _ncVersion

std::string FONcBaseType::_ncVersion
protectedinherited

Definition at line 67 of file FONcBaseType.h.

◆ _orig_varname

std::string FONcBaseType::_orig_varname
protectedinherited

Definition at line 64 of file FONcBaseType.h.

◆ _varid

int FONcBaseType::_varid
protectedinherited

Definition at line 62 of file FONcBaseType.h.

◆ _varname

std::string FONcBaseType::_varname
protectedinherited

Definition at line 63 of file FONcBaseType.h.

◆ d_dds

libdap::DDS* FONcBaseType::d_dds
protectedinherited

Definition at line 74 of file FONcBaseType.h.

◆ d_eval

libdap::ConstraintEvaluator* FONcBaseType::d_eval
protectedinherited

Definition at line 75 of file FONcBaseType.h.

◆ is_dap4

bool FONcBaseType::is_dap4
protectedinherited

Definition at line 69 of file FONcBaseType.h.

◆ is_dap4_group

bool FONcBaseType::is_dap4_group
protectedinherited

Definition at line 72 of file FONcBaseType.h.


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