bes  Updated for version 3.17.4
BESDataDDXResponseHandler Class Reference

response handler that builds an OPeNDAP DDX object More...

#include <BESDataDDXResponseHandler.h>

Inheritance diagram for BESDataDDXResponseHandler:
Inheritance graph

Public Member Functions

 BESDataDDXResponseHandler (const string &name)
 
virtual void dump (ostream &strm) const
 dumps information about this object More...
 
virtual void execute (BESDataHandlerInterface &dhi)
 executes the command 'get ddx 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 More...
 

Static Public Member Functions

static BESResponseHandlerDataDDXResponseBuilder (const string &name)
 

Protected Attributes

BESResponseObject_response
 
string _response_name
 

Detailed Description

A request 'get dataddx 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 DDX response object that includes attribute information found in a DAS object and data definitions found in a DDS object. It also knows how to transmit the DDX response object using the specified transmitter object in the transmit method.

See also
DDX
BESContainer
BESDefine
BESTransmitter

Definition at line 52 of file BESDataDDXResponseHandler.h.

Member Function Documentation

◆ dump()

void BESDataDDXResponseHandler::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 148 of file BESDataDDXResponseHandler.cc.

References BESResponseHandler::dump().

◆ execute()

void BESDataDDXResponseHandler::execute ( BESDataHandlerInterface dhi)
virtual

For each container in the specified definition go to the request handler for that container and have it first add to the OPeNDAP DDS response object. Once the DDS object has been filled in, repeat the process but this time for the OPeNDAP DAS response object. Then add the attributes from the DAS object to the DDS object.

Parameters
dhistructure that holds request and response information
See also
BESDataHandlerInterface
BESDDSResponse
BESDASResponse
BESRequestHandlerList

Implements BESResponseHandler.

Definition at line 70 of file BESDataDDXResponseHandler.cc.

References BESDataHandlerInterface::action, BESDataHandlerInterface::container, BESDataHandlerInterface::data, BESRequestHandlerList::execute_each(), BESDataHandlerInterface::first_container(), BESContainer::get_constraint(), BESDapResponse::get_dap_client_protocol(), BESDapResponse::get_request_xml_base(), 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 BESDataDDXResponseHandler::transmit ( BESTransmitter transmitter,
BESDataHandlerInterface dhi 
)
virtual

If a response object was built then transmit it using the send_ddx 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
DDS
DAS
BESTransmitter
BESDataHandlerInterface

Implements BESResponseHandler.

Definition at line 132 of file BESDataDDXResponseHandler.cc.


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