response handler that builds an OPeNDAP DAS response object More...
#include <BESDASResponseHandler.h>
Public Member Functions | |
BESDASResponseHandler (const string &name) | |
virtual void | dump (ostream &strm) const |
dumps information about this object | |
virtual void | execute (BESDataHandlerInterface &dhi) |
executes the command 'get das for <def_name>;' by executing the request for each container in the specified definition. | |
virtual string | get_name () const |
return the name of this response 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 void | transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi) |
transmit the response object built by the execute command using the specified transmitter object | |
virtual | ~BESDASResponseHandler (void) |
Static Public Member Functions | |
static BESResponseHandler * | DASResponseBuilder (const string &name) |
Protected Attributes | |
BESResponseObject * | _response |
string | _response_name |
response handler that builds an OPeNDAP DAS response object
A request 'get das 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 OPeNDAP DAS response object. It then transmits the DAS object using the method send_das on the speicifed transmitter object.
Definition at line 50 of file BESDASResponseHandler.h.
BESDASResponseHandler::BESDASResponseHandler | ( | const string & | name | ) |
Definition at line 39 of file BESDASResponseHandler.cc.
Referenced by DASResponseBuilder().
BESDASResponseHandler::~BESDASResponseHandler | ( | void | ) | [virtual] |
Definition at line 44 of file BESDASResponseHandler.cc.
BESResponseHandler * BESDASResponseHandler::DASResponseBuilder | ( | const string & | name | ) | [static] |
Definition at line 109 of file BESDASResponseHandler.cc.
References BESDASResponseHandler().
Referenced by BESDapModule::initialize().
void BESDASResponseHandler::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.
Definition at line 99 of file BESDASResponseHandler.cc.
References BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().
void BESDASResponseHandler::execute | ( | BESDataHandlerInterface & | dhi | ) | [virtual] |
executes the command 'get das for <def_name>;' by executing the request for each container in the specified definition.
For each container in the specified definition go to the request handler for that container and have it add to the OPeNDAP DAS response object. The DAS response object is built within this method and passed to the request handler list.
dhi | structure that holds request and response information |
Implements BESResponseHandler.
Definition at line 62 of file BESDASResponseHandler.cc.
References BESResponseHandler::_response, BESDataHandlerInterface::action_name, BESRequestHandlerList::execute_each(), and BESRequestHandlerList::TheList().
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...
Definition at line 156 of file BESResponseHandler.h.
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.
Definition at line 53 of file BESResponseHandler.cc.
References BESResponseHandler::_response.
Referenced by BESDapRequestHandler::dap_build_help(), BESDapRequestHandler::dap_build_version(), and BESDataHandlerInterface::get_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 |
Definition at line 59 of file BESResponseHandler.cc.
References BESResponseHandler::_response.
void BESDASResponseHandler::transmit | ( | BESTransmitter * | transmitter, | |
BESDataHandlerInterface & | dhi | |||
) | [virtual] |
transmit the response object built by the execute command using the specified transmitter object
If a response object was built then transmit it using the send_das method on the transmitter object.
transmitter | object that knows how to transmit specific basic types | |
dhi | structure that holds the request and response information |
Implements BESResponseHandler.
Definition at line 83 of file BESDASResponseHandler.cc.
References BESResponseHandler::_response, DAS_SERVICE, and BESTransmitter::send_response().
BESResponseObject* BESResponseHandler::_response [protected, inherited] |
Definition at line 85 of file BESResponseHandler.h.
Referenced by BESResponseHandler::dump(), BESVersionResponseHandler::execute(), BESStreamResponseHandler::execute(), BESStatusResponseHandler::execute(), BESShowDefsResponseHandler::execute(), BESShowContextResponseHandler::execute(), BESShowContainersResponseHandler::execute(), BESSetContextResponseHandler::execute(), BESSetContainerResponseHandler::execute(), BESServicesResponseHandler::execute(), BESProcIdResponseHandler::execute(), BESHelpResponseHandler::execute(), BESDelDefsResponseHandler::execute(), BESDelDefResponseHandler::execute(), BESDelContainersResponseHandler::execute(), BESDelContainerResponseHandler::execute(), BESDefineResponseHandler::execute(), BESDDXResponseHandler::execute(), BESDDSResponseHandler::execute(), BESDataResponseHandler::execute(), BESDataDDXResponseHandler::execute(), 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(), BESServicesResponseHandler::transmit(), BESProcIdResponseHandler::transmit(), BESHelpResponseHandler::transmit(), BESDelDefsResponseHandler::transmit(), BESDelDefResponseHandler::transmit(), BESDelContainersResponseHandler::transmit(), BESDelContainerResponseHandler::transmit(), BESDefineResponseHandler::transmit(), BESDDXResponseHandler::transmit(), BESDDSResponseHandler::transmit(), BESDataResponseHandler::transmit(), BESDataDDXResponseHandler::transmit(), transmit(), BESConfigResponseHandler::transmit(), BESCatalogResponseHandler::transmit(), and BESResponseHandler::~BESResponseHandler().
string BESResponseHandler::_response_name [protected, inherited] |
Definition at line 84 of file BESResponseHandler.h.
Referenced by BESResponseHandler::dump(), BESDDXResponseHandler::execute(), BESDataDDXResponseHandler::execute(), and BESResponseHandler::get_name().