bes  Updated for version 3.17.4
BESDap4ResponseHandler Class Reference

response handler that builds an OPeNDAP Dap4 data response More...

#include <BESDap4ResponseHandler.h>

Inheritance diagram for BESDap4ResponseHandler:
Inheritance graph

Public Member Functions

 BESDap4ResponseHandler (const string &name)
 
virtual void dump (ostream &strm) const
 dumps information about this object More...
 
virtual void execute (BESDataHandlerInterface &dhi)
 executes the command 'get dap for def_name;' More...
 
virtual string get_name () const
 return the name of this response object More...
 
virtual BESResponseObjectget_response_object ()
 return the current response object More...
 
virtual BESResponseObjectset_response_object (BESResponseObject *o)
 replaces the current response object with the specified one, returning the current response object More...
 
virtual void transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
 transmit the response object built by the execute command using the specified transmitter object More...
 

Static Public Member Functions

static BESResponseHandlerDap4ResponseBuilder (const string &name)
 

Protected Attributes

BESResponseObject_response
 
string _response_name
 

Detailed Description

See also
DMR
BESContainer
BESTransmitter

Definition at line 37 of file BESDap4ResponseHandler.h.

Member Function Documentation

◆ dump()

void BESDap4ResponseHandler::dump ( ostream &  strm) const
virtual

Displays the pointer value of this instance

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

Reimplemented from BESResponseHandler.

Definition at line 108 of file BESDap4ResponseHandler.cc.

References BESResponseHandler::dump().

◆ execute()

void BESDap4ResponseHandler::execute ( BESDataHandlerInterface dhi)
virtual
Parameters
dhistructure that holds request and response information
See also
BESDataHandlerInterface
BESDMRResponse
BESRequestHandlerList

Implements BESResponseHandler.

Definition at line 51 of file BESDap4ResponseHandler.cc.

References BESRequestHandlerList::execute_each(), and BESContextManager::get_context().

◆ get_name()

virtual string BESResponseHandler::get_name ( ) const
inlinevirtualinherited

This name is used to determine which response handler can handle a requested response, such as das, dds, ddx, tab, info, version, help, etc...

Returns
response name

Definition at line 156 of file BESResponseHandler.h.

◆ get_response_object()

BESResponseObject * BESResponseHandler::get_response_object ( )
virtualinherited

Returns the current response object, null if one has not yet been created. The response handler maintains ownership of the response object.

Returns
current response object
See also
BESResponseObject

Definition at line 53 of file BESResponseHandler.cc.

◆ set_response_object()

BESResponseObject * BESResponseHandler::set_response_object ( BESResponseObject o)
virtualinherited

This method is used to replace the response object with a new one, for example if during aggregation a new response object is built from the current response object.

The caller of set_response_object now owns the returned response object. The new response object is now owned by the response object.

Parameters
onew response object used to replace the current one
Returns
the response object being replaced
See also
BESResponseObject

Definition at line 59 of file BESResponseHandler.cc.

◆ transmit()

void BESDap4ResponseHandler::transmit ( BESTransmitter transmitter,
BESDataHandlerInterface dhi 
)
virtual

If a response object was built then transmit it using the send_dmr method on the transmitter object.

Parameters
transmitterobject that knows how to transmit specific basic types
dhistructure that holds the request and response information
See also
BESDMRResponse
BESTransmitter
BESDataHandlerInterface

Implements BESResponseHandler.

Definition at line 95 of file BESDap4ResponseHandler.cc.


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