FONcModule Class Reference

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

#include <FONcModule.h>

Inheritance diagram for FONcModule:

Collaboration diagram for FONcModule:

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

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.

Constructor & Destructor Documentation

FONcModule()

FONcModule::FONcModule ( )

inline

Definition at line 54 of file FONcModule.h.

~FONcModule()

virtual FONcModule::~FONcModule ( )

inlinevirtual

Definition at line 57 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

strm	C++ i/o stream to dump the information to

Implements BESAbstractModule.

Definition at line 116 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

modname

The name of the module being loaded

Implements BESAbstractModule.

Definition at line 63 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

modname

The name of the module being removed

Implements BESAbstractModule.

Definition at line 96 of file FONcModule.cc.

---

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

• FONcModule.h
• FONcModule.cc