bes  Updated for version 3.20.6
FONcModule Class Reference

Module that allows for OPeNDAP Data objects to be returned as netcdf files. More...

#include <FONcModule.h>

Collaboration diagram for FONcModule:
Collaboration graph

Public Member Functions

virtual void dump (std::ostream &strm) const
 dumps information about this object for debugging purposes More...
 
virtual void initialize (const std::string &modname)
 initialize the module by adding callbacks and registering objects with the framework More...
 
virtual void terminate (const std::string &modname)
 removes any registered callbacks or objects from the framework More...
 

Detailed Description

Module that allows for OPeNDAP Data objects to be returned as netcdf files.

The FONcModule (File Out Netcdf Module) is provided to allow for OPenDAP Data objects to be returned as netcdf files. The get request to the BES would be for the dods data product with the added element attribute of returnAs="netcdf".

This is accomplished by adding a BESTransmitter called "netcdf". When the BES sees the returnAs property of the get command it looks for a transmitter with that name. The FONcTransmitter is used to transmit the DAP DataDDS object by first writing it out as a netcdf data file and then transmitting it back to the caller.

See also
FONcTransmitter

Definition at line 52 of file FONcModule.h.

Member Function Documentation

◆ dump()

void FONcModule::dump ( std::ostream &  strm) const
virtual

dumps information about this object for debugging purposes

Displays the pointer value of this instance plus any instance data

Parameters
strmC++ i/o stream to dump the information to

Implements BESAbstractModule.

Definition at line 110 of file FONcModule.cc.

◆ initialize()

void FONcModule::initialize ( const std::string &  modname)
virtual

initialize the module by adding callbacks and registering objects with the framework

Registers the request handler to add to a version or help request, and adds the File Out transmitter for a "returnAs netcdf" request. Also adds netcdf as a return for the dap service dods request and registers the debug context.

Parameters
modnameThe name of the module being loaded

Implements BESAbstractModule.

Definition at line 62 of file FONcModule.cc.

◆ terminate()

void FONcModule::terminate ( const std::string &  modname)
virtual

removes any registered callbacks or objects from the framework

Any registered callbacks or objects, registered during initialization, are removed from the framework.

Parameters
modnameThe name of the module being removed

Implements BESAbstractModule.

Definition at line 90 of file FONcModule.cc.


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