bes  Updated for version 3.17.4
BESDataResponseHandler Class Reference

response handler that builds an OPeNDAP Data DDS object More...

#include <BESDataResponseHandler.h>

Inheritance diagram for BESDataResponseHandler:
Inheritance graph

Public Member Functions

 BESDataResponseHandler (const string &name)
 
virtual void dump (ostream &strm) const
 dumps information about this object More...
 
virtual void execute (BESDataHandlerInterface &dhi)
 executes the command 'get data for <def_name>' by executing the request for each container in the specified definition 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 More...
 

Static Public Member Functions

static BESResponseHandlerDataResponseBuilder (const string &name)
 

Protected Attributes

BESResponseObject_response
 
string _response_name
 

Detailed Description

A request 'get data for <def_name>' will be handled by this response handler. Given a definition name it determines what containers are to be used to build the response object. It then transmits the response object using the method send_data on the transmitter object.

See also
DDS
BESContainer
BESTransmitter
BESDefine

Definition at line 50 of file BESDataResponseHandler.h.

Member Function Documentation

◆ dump()

void BESDataResponseHandler::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 150 of file BESDataResponseHandler.cc.

References BESResponseHandler::dump().

◆ execute()

void BESDataResponseHandler::execute ( BESDataHandlerInterface dhi)
virtual

For each container in the specified defnition go to the request handler for that container and have it add to the OPeNDAP DataDDS data response object. The data response object is created within this method and passed to the request handler list.

Parameters
dhistructure that holds request and response information
See also
BESDataHandlerInterface
BESDataDDSResponse
BESRequestHandlerList
BESDefine

Implements BESResponseHandler.

Definition at line 75 of file BESDataResponseHandler.cc.

References BESDataHandlerInterface::container, BESRequestHandlerList::execute_each(), BESDataHandlerInterface::first_container(), BESContainer::get_constraint(), BESContextManager::get_context(), BESDapResponse::get_dap_client_protocol(), and BESContainer::set_constraint().

◆ 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 BESDataResponseHandler::transmit ( BESTransmitter transmitter,
BESDataHandlerInterface dhi 
)
virtual

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

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

Implements BESResponseHandler.

Definition at line 134 of file BESDataResponseHandler.cc.


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