bes  Updated for version 3.20.6
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. More...
 
virtual void convert (std::vector< std::string > embed)
 
virtual void convert (vector< string > embed)
 convert the Sequence to something that can be stored in a netcdf file More...
 
virtual void define (int ncid)
 define the DAP Sequence 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...
 
 FONcSequence (BaseType *b)
 Constructor for FONcSequence that takes a DAP Sequence. More...
 
virtual bool isNetCDF4 ()
 Returns true if NetCDF4 features will be required. More...
 
virtual string name ()
 
virtual void setVersion (std::string version)
 Identifies variable with use of NetCDF4 features. More...
 
virtual nc_type type ()
 Returns the type of data of this variable. More...
 
virtual int varid () const
 
virtual void write (int ncid)
 Write the sequence data out to the netcdf file. More...
 
virtual ~FONcSequence ()
 Destructor that cleans up the sequence. 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 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 47 of file FONcSequence.h.

Constructor & Destructor Documentation

◆ FONcSequence()

FONcSequence::FONcSequence ( 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 81 of file FONcBaseType.cc.

◆ convert()

void FONcSequence::convert ( vector< string >  embed)
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 125 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 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 97 of file FONcBaseType.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 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 FONcStr, FONcByte, FONcDouble, FONcFloat, FONcInt, and FONcShort.

Definition at line 74 of file FONcBaseType.cc.

◆ 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

Reimplemented from FONcBaseType.

Definition at line 110 of file FONcSequence.cc.


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