bes  Updated for version 3.20.6
FONcTransmitter Class Reference

BESTransmitter class named "netcdf" that transmits an OPeNDAP data object as a netcdf file. More...

#include <FONcTransmitter.h>

Collaboration diagram for FONcTransmitter:
Collaboration graph

Public Member Functions

virtual bool add_method (std::string method_name, p_transmitter trans_method)
 
virtual void dump (std::ostream &strm) const
 dumps information about this object More...
 
virtual p_transmitter find_method (std::string method_name)
 
 FONcTransmitter ()
 Construct the FONcTransmitter, adding it with name netcdf to be able to transmit a data response. More...
 
virtual bool remove_method (std::string method_name)
 
virtual void send_html (BESInfo &info, BESDataHandlerInterface &dhi)
 
virtual void send_response (const std::string &method, BESResponseObject *obj, BESDataHandlerInterface &dhi)
 
virtual void send_text (BESInfo &info, BESDataHandlerInterface &dhi)
 

Static Public Member Functions

static void send_data (BESResponseObject *obj, BESDataHandlerInterface &dhi)
 The static method registered to transmit OPeNDAP data objects as a netcdf file. More...
 

Detailed Description

BESTransmitter class named "netcdf" that transmits an OPeNDAP data object as a netcdf file.

The FONcTransmitter transforms an OPeNDAP DataDDS object into a netcdf file and streams the new (temporary) netcdf file back to the client.

See also
BESTransmitter

Definition at line 53 of file FONcTransmitter.h.

Constructor & Destructor Documentation

◆ FONcTransmitter()

FONcTransmitter::FONcTransmitter ( )

Construct the FONcTransmitter, adding it with name netcdf to be able to transmit a data response.

The transmitter is created to add the ability to return OPeNDAP data objects (DataDDS) as a netcdf file.

The OPeNDAP data object is written to a netcdf file locally in a temporary directory specified by the BES configuration parameter FONc.Tempdir. If this variable is not found or is not set then it defaults to the macro definition FONC_TEMP_DIR.

Definition at line 96 of file FONcTransmitter.cc.

Member Function Documentation

◆ dump()

void BESTransmitter::dump ( std::ostream &  strm) const
virtualinherited

dumps information about this object

Displays the pointer value of this instance along with the names of register transmit methods

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

Implements BESObj.

Definition at line 132 of file BESTransmitter.cc.

◆ send_data()

void FONcTransmitter::send_data ( BESResponseObject obj,
BESDataHandlerInterface dhi 
)
static

The static method registered to transmit OPeNDAP data objects as a netcdf file.

This function takes the OPeNDAP DataDDS object, reads in the data (can be used with any data handler), transforms the data into a netcdf file, and streams back that netcdf file back to the requester using the stream specified in the BESDataHandlerInterface.

Parameters
objThe BESResponseObject containing the OPeNDAP DataDDS object
dhiBESDataHandlerInterface containing information about the request and response
Exceptions
BESInternalErrorif the response is not an OPeNDAP DataDDS or if there are any problems reading the data, writing to a netcdf file, or streaming the netcdf file

Definition at line 235 of file FONcTransmitter.cc.


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