BESUsageResponseHandler Class Reference

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

#include <BESUsageResponseHandler.h>

Inheritance diagram for BESUsageResponseHandler:

Collaboration diagram for BESUsageResponseHandler:

Public Member Functions
	BESUsageResponseHandler (const string &name)
virtual void	dump (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 string	get_name () const
	return the name of this response object More...
virtual BESResponseObject *	get_response_object ()
	return the current response object More...
virtual BESResponseObject *	set_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...
virtual	~BESUsageResponseHandler (void)

Static Public Member Functions
static BESResponseHandler *	UsageResponseBuilder (const string &name)

Protected Attributes
BESResponseObject *	_response
string	_response_name

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.

Constructor & Destructor Documentation

BESUsageResponseHandler::BESUsageResponseHandler

(

const string &

name

)

Definition at line 42 of file BESUsageResponseHandler.cc.

Referenced by UsageResponseBuilder().

BESUsageResponseHandler::~BESUsageResponseHandler ( void  )

virtual

Definition at line 47 of file BESUsageResponseHandler.cc.

Member Function Documentation

void BESResponseHandler::dump ( ostream &  strm ) const

virtualinherited

dumps information about this object

Displays the pointer value of this instance along with the name of this response handler and, if present, dumps the response object itself.

Parameters

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

Implements BESObj.

Reimplemented in BESDefineResponseHandler, ncml_module::NCMLCacheAggResponseHandler, BESSetContainerResponseHandler, BESDDXResponseHandler, BESDelDefResponseHandler, BESDelDefsResponseHandler, BESSetContextResponseHandler, BESDataDDXResponseHandler, BESCatalogResponseHandler, BESDelContainersResponseHandler, BESHelpResponseHandler, BESShowContainersResponseHandler, BESDelContainerResponseHandler, BESShowContextResponseHandler, BESDASResponseHandler, BESDataResponseHandler, BESShowErrorResponseHandler, BESVersionResponseHandler, BESDDSResponseHandler, BESConfigResponseHandler, BESShowDefsResponseHandler, BESStatusResponseHandler, BESDMRResponseHandler, BESProcIdResponseHandler, BESServicesResponseHandler, ShowPathInfoResponseHandler, BESStreamResponseHandler, and BESDap4ResponseHandler.

Definition at line 74 of file BESResponseHandler.cc.

References BESResponseHandler::_response, BESResponseHandler::_response_name, BESResponseObject::dump(), BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().

Referenced by BESDap4ResponseHandler::dump(), BESStreamResponseHandler::dump(), ShowPathInfoResponseHandler::dump(), BESProcIdResponseHandler::dump(), BESServicesResponseHandler::dump(), BESDMRResponseHandler::dump(), BESShowDefsResponseHandler::dump(), BESStatusResponseHandler::dump(), BESConfigResponseHandler::dump(), BESDDSResponseHandler::dump(), BESDASResponseHandler::dump(), BESShowErrorResponseHandler::dump(), BESVersionResponseHandler::dump(), BESDataResponseHandler::dump(), BESDelContainerResponseHandler::dump(), BESShowContextResponseHandler::dump(), BESShowContainersResponseHandler::dump(), BESDataDDXResponseHandler::dump(), BESDelContainersResponseHandler::dump(), BESCatalogResponseHandler::dump(), BESHelpResponseHandler::dump(), BESDelDefsResponseHandler::dump(), BESDelDefResponseHandler::dump(), BESSetContextResponseHandler::dump(), BESDDXResponseHandler::dump(), BESSetContainerResponseHandler::dump(), BESDefineResponseHandler::dump(), and BESDataHandlerInterface::dump().

Here is the call graph for this function:

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

dhi	structure that holds request and response information

See also

_BESDataHandlerInterface

DAS

BESRequestHandlerList

Implements BESResponseHandler.

Definition at line 68 of file BESUsageResponseHandler.cc.

References BESResponseHandler::_response, BESResponseHandler::_response_name, BESDataHandlerInterface::action, BESDataHandlerInterface::action_name, DAS_RESPONSE, DDS_RESPONSE, BESRequestHandlerList::execute_each(), NULL, BESRequestHandlerList::TheList(), Usage_RESPONSE, and Usage_RESPONSE_STR.

Here is the call graph for this function:

virtual string BESResponseHandler::get_name ( ) const

inlinevirtualinherited

return the name of this response object

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.

References BESResponseHandler::_response_name.

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 53 of file BESResponseHandler.cc.

References BESResponseHandler::_response.

Referenced by FONgRequestHandler::build_help(), FoJsonRequestHandler::build_help(), W10nJsonRequestHandler::build_help(), FONcRequestHandler::build_help(), FONgRequestHandler::build_version(), FoJsonRequestHandler::build_version(), W10nJsonRequestHandler::build_version(), FONcRequestHandler::build_version(), CSVRequestHandler::csv_build_das(), CSVRequestHandler::csv_build_data(), CSVRequestHandler::csv_build_dds(), CSVRequestHandler::csv_build_dmr(), CSVRequestHandler::csv_build_help(), CSVRequestHandler::csv_build_vers(), DapRequestHandler::dap_build_dap4data(), DapRequestHandler::dap_build_das(), DapRequestHandler::dap_build_data(), DapRequestHandler::dap_build_dds(), DapRequestHandler::dap_build_dmr(), BESXDRequestHandler::dap_build_help(), BESUsageRequestHandler::dap_build_help(), BESDapRequestHandler::dap_build_help(), DapRequestHandler::dap_build_help(), DapRequestHandler::dap_build_vers(), BESXDRequestHandler::dap_build_version(), BESAsciiRequestHandler::dap_build_version(), BESUsageRequestHandler::dap_build_version(), BESDapRequestHandler::dap_build_version(), BESWWWRequestHandler::dap_build_version(), FFRequestHandler::ff_build_das(), FFRequestHandler::ff_build_data(), FFRequestHandler::ff_build_dds(), FFRequestHandler::ff_build_dmr(), FFRequestHandler::ff_build_help(), FFRequestHandler::ff_build_version(), FitsRequestHandler::fits_build_das(), FitsRequestHandler::fits_build_data(), FitsRequestHandler::fits_build_dds(), FitsRequestHandler::fits_build_dmr(), FitsRequestHandler::fits_build_help(), FitsRequestHandler::fits_build_vers(), GatewayRequestHandler::gateway_build_help(), GatewayRequestHandler::gateway_build_vers(), GDALRequestHandler::gdal_build_das(), GDALRequestHandler::gdal_build_data(), GDALRequestHandler::gdal_build_dds(), GDALRequestHandler::gdal_build_dmr(), GDALRequestHandler::gdal_build_help(), GDALRequestHandler::gdal_build_version(), BESDataHandlerInterface::get_response_object(), HDF4RequestHandler::hdf4_build_das(), HDF4RequestHandler::hdf4_build_data(), HDF4RequestHandler::hdf4_build_data_with_IDs(), HDF4RequestHandler::hdf4_build_dds(), HDF4RequestHandler::hdf4_build_help(), HDF4RequestHandler::hdf4_build_version(), HDF5RequestHandler::hdf5_build_das(), HDF5RequestHandler::hdf5_build_data(), HDF5RequestHandler::hdf5_build_data_with_IDs(), HDF5RequestHandler::hdf5_build_dds(), HDF5RequestHandler::hdf5_build_help(), HDF5RequestHandler::hdf5_build_version(), NCRequestHandler::nc_build_das(), NCRequestHandler::nc_build_data(), NCRequestHandler::nc_build_dds(), NCRequestHandler::nc_build_dmr(), NCRequestHandler::nc_build_help(), NCRequestHandler::nc_build_version(), ncml_module::NCMLRequestHandler::ncml_build_das(), ncml_module::NCMLRequestHandler::ncml_build_data(), ncml_module::NCMLRequestHandler::ncml_build_dds(), ncml_module::NCMLRequestHandler::ncml_build_dmr(), ncml_module::NCMLRequestHandler::ncml_build_help(), and ncml_module::NCMLRequestHandler::ncml_build_vers().

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

o	new 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.

References BESResponseHandler::_response.

Referenced by agg_util::DDSLoader::loadInto().

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

transmitter	object that knows how to transmit specific basic types
dhi	structure that holds the request and response information

See also

DAS

BESTransmitter

_BESDataHandlerInterface

Implements BESResponseHandler.

Definition at line 108 of file BESUsageResponseHandler.cc.

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

Here is the call graph for this function:

BESResponseHandler * BESUsageResponseHandler::UsageResponseBuilder ( const string &  name )

static

Definition at line 118 of file BESUsageResponseHandler.cc.

References BESUsageResponseHandler().

Referenced by BESUsageModule::initialize().

Here is the call graph for this function:

Member Data Documentation

BESResponseObject* BESResponseHandler::_response

protectedinherited

Definition at line 85 of file BESResponseHandler.h.

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

string BESResponseHandler::_response_name

protectedinherited

Definition at line 84 of file BESResponseHandler.h.

Referenced by BESResponseHandler::dump(), BESXDResponseHandler::execute(), execute(), BESWWWResponseHandler::execute(), BESDataDDXResponseHandler::execute(), BESDDXResponseHandler::execute(), and BESResponseHandler::get_name().

---

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

• BESUsageResponseHandler.h
• BESUsageResponseHandler.cc