#include <BESDataResponseHandler.h>
Inheritance diagram for BESDataResponseHandler:
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 BESResponseObject * | get_response_object () |
return the current response object | |
virtual BESResponseObject * | set_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 BESResponseHandler * | DataResponseBuilder (const string &name) |
Protected Attributes | |
string | _response_name |
BESResponseObject * | _response |
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.
BESDataResponseHandler::BESDataResponseHandler | ( | const string & | name | ) |
BESDataResponseHandler::~BESDataResponseHandler | ( | void | ) | [virtual] |
BESResponseHandler * BESDataResponseHandler::DataResponseBuilder | ( | const string & | name | ) | [static] |
void BESDataResponseHandler::dump | ( | ostream & | strm | ) | const [virtual] |
dumps information about this object
Displays the pointer value of this instance
strm | C++ i/o stream to dump the information to |
Reimplemented from BESResponseHandler.
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.
dhi | structure that holds request and response information |
BESHandlerException | if there is a problem building the response object | |
BESResponseException | upon fatal error building the response object |
Implements BESResponseHandler.
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...
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.
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.
o | new response object used to replace the current one |
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.
transmitter | object that knows how to transmit specific basic types | |
dhi | structure that holds the request and response information |
Implements BESResponseHandler.
BESResponseObject* BESResponseHandler::_response [protected, inherited] |
string BESResponseHandler::_response_name [protected, inherited] |