BESDataResponseHandler Class Reference

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

#include <BESDataResponseHandler.h>

Inheritance diagram for BESDataResponseHandler:

Inheritance graph
[legend]
Collaboration diagram for BESDataResponseHandler:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 BESDataResponseHandler (const string &name)
virtual ~BESDataResponseHandler (void)
virtual void execute (BESDataHandlerInterface &dhi)
 executes the command 'get data for <def_name>' by executing the request for each container in the specified definition
virtual void transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
 transmit the response object built by the execute command
virtual void dump (ostream &strm) const
 dumps information about this object
virtual BESResponseObjectget_response_object ()
 return the current response object
virtual BESResponseObjectset_response_object (BESResponseObject *o)
 replaces the current response object with the specified one, returning the current response object
virtual string get_name () const
 return the name of this response object

Static Public Member Functions

static BESResponseHandlerDataResponseBuilder (const string &name)

Protected Attributes

string _response_name
BESResponseObject_response


Detailed Description

response handler that builds an OPeNDAP Data DDS object

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


Constructor & Destructor Documentation

BESDataResponseHandler::BESDataResponseHandler ( const string &  name  ) 

Referenced by DataResponseBuilder().

BESDataResponseHandler::~BESDataResponseHandler ( void   )  [virtual]


Member Function Documentation

BESResponseHandler * BESDataResponseHandler::DataResponseBuilder ( const string &  name  )  [static]

References BESDataResponseHandler().

Referenced by BESDapModule::initialize().

Here is the call graph for this function:

void BESDataResponseHandler::dump ( ostream &  strm  )  const [virtual]

dumps information about this object

Displays the pointer value of this instance

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

Reimplemented from BESResponseHandler.

References BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().

Here is the call graph for this function:

void BESDataResponseHandler::execute ( BESDataHandlerInterface dhi  )  [virtual]

executes the command 'get data for <def_name>' by executing the request for each container in the specified definition

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:
dhi structure that holds request and response information
See also:
_BESDataHandlerInterface

BESDataDDSResponse

BESRequestHandlerList

BESDefine

Implements BESResponseHandler.

References BESResponseHandler::_response, _BESDataHandlerInterface::action_name, DATA_RESPONSE_STR, BESRequestHandlerList::execute_each(), and BESRequestHandlerList::TheList().

Here is the call graph for this function:

virtual string BESResponseHandler::get_name (  )  const [inline, virtual, inherited]

return the name of this response object

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

Returns:
response name

References BESResponseHandler::_response_name.

BESResponseObject * BESResponseHandler::get_response_object (  )  [virtual, inherited]

return the current response object

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

References BESResponseHandler::_response.

Referenced by BESDapRequestHandler::dap_build_help(), and BESDapRequestHandler::dap_build_version().

BESResponseObject * BESResponseHandler::set_response_object ( BESResponseObject o  )  [virtual, inherited]

replaces the current response object with the specified one, returning the current response object

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:
o new response object used to replace the current one
Returns:
the response object being replaced
See also:
BESResponseObject

References BESResponseHandler::_response.

void BESDataResponseHandler::transmit ( BESTransmitter transmitter,
BESDataHandlerInterface dhi 
) [virtual]

transmit the response object built by the execute command

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

Parameters:
transmitter object that knows how to transmit specific basic types
dhi structure that holds the request and response information
See also:
BESDataDDSResponse

BESTransmitter

_BESDataHandlerInterface

Implements BESResponseHandler.

References BESResponseHandler::_response, DATA_TRANSMITTER, and BESTransmitter::send_response().

Here is the call graph for this function:


Member Data Documentation

Referenced by BESResponseHandler::dump(), BESVersionResponseHandler::execute(), BESStreamResponseHandler::execute(), BESStatusResponseHandler::execute(), BESShowDefsResponseHandler::execute(), BESShowContextResponseHandler::execute(), BESShowContainersResponseHandler::execute(), BESSetContextResponseHandler::execute(), BESSetContainerResponseHandler::execute(), BESProcIdResponseHandler::execute(), BESHelpResponseHandler::execute(), BESDelDefsResponseHandler::execute(), BESDelDefResponseHandler::execute(), BESDelContainersResponseHandler::execute(), BESDelContainerResponseHandler::execute(), BESDefineResponseHandler::execute(), BESDDXResponseHandler::execute(), BESDDSResponseHandler::execute(), execute(), BESDASResponseHandler::execute(), BESConfigResponseHandler::execute(), BESCatalogResponseHandler::execute(), BESResponseHandler::get_response_object(), BESResponseHandler::set_response_object(), BESVersionResponseHandler::transmit(), BESStatusResponseHandler::transmit(), BESShowDefsResponseHandler::transmit(), BESShowContextResponseHandler::transmit(), BESShowContainersResponseHandler::transmit(), BESSetContextResponseHandler::transmit(), BESSetContainerResponseHandler::transmit(), BESProcIdResponseHandler::transmit(), BESHelpResponseHandler::transmit(), BESDelDefsResponseHandler::transmit(), BESDelDefResponseHandler::transmit(), BESDelContainersResponseHandler::transmit(), BESDelContainerResponseHandler::transmit(), BESDefineResponseHandler::transmit(), BESDDXResponseHandler::transmit(), BESDDSResponseHandler::transmit(), transmit(), BESDASResponseHandler::transmit(), BESConfigResponseHandler::transmit(), BESCatalogResponseHandler::transmit(), and BESResponseHandler::~BESResponseHandler().

string BESResponseHandler::_response_name [protected, inherited]


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

Generated on Wed Mar 4 04:35:18 2009 for OPeNDAP Back End Server (BES) by  doxygen 1.5.8