bes  Updated for version 3.20.6
BESUsageResponseHandler Class Reference

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

#include <BESUsageResponseHandler.h>

Collaboration diagram for BESUsageResponseHandler:
Collaboration graph

Public Member Functions

 BESUsageResponseHandler (const std::string &name)
 
virtual void dump (std::ostream &strm) const
 dumps information about this object More...
 
virtual void execute (BESDataHandlerInterface &dhi)
 executes the command 'get Usage for <def_name>;' by executing the request for each container in the specified defnition. 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 using the specified transmitter object More...
 

Static Public Member Functions

static BESResponseHandlerUsageResponseBuilder (const std::string &name)
 

Protected Attributes

std::string d_annotation_service_url
 
std::string d_response_name
 
BESResponseObjectd_response_object
 

Detailed Description

response handler that builds an OPeNDAP Usage response object

A request 'get Usage 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 Usage response object. It then transmits the DataDDS object as Usage values.

See also
DataDDS
BESContainer
BESTransmitter

Definition at line 49 of file BESUsageResponseHandler.h.

Member Function Documentation

◆ dump()

◆ execute()

void BESUsageResponseHandler::execute ( BESDataHandlerInterface dhi)
virtual

executes the command 'get Usage for <def_name>;' by executing the request for each container in the specified defnition.

For each container in the specified defnition 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.

Once the DAS has been filled in do the same for a DDS. We only need the description of the data and not the data itself.

Parameters
dhistructure that holds request and response information
See also
_BESDataHandlerInterface
DAS
BESRequestHandlerList

Implements BESResponseHandler.

Definition at line 73 of file BESUsageResponseHandler.cc.

◆ get_response_object()

BESResponseObject * BESResponseHandler::get_response_object ( )
virtualinherited

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

Definition at line 82 of file BESResponseHandler.cc.

◆ set_response_object()

BESResponseObject * BESResponseHandler::set_response_object ( BESResponseObject o)
virtualinherited

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

Definition at line 88 of file BESResponseHandler.cc.

◆ transmit()

void BESUsageResponseHandler::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.

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

Implements BESResponseHandler.

Definition at line 113 of file BESUsageResponseHandler.cc.


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