BESDataResponseHandler Class Reference

response handler that builds an OPeNDAP Data DDS object More...

#include <BESDataResponseHandler.h>

Inheritance diagram for BESDataResponseHandler:

Collaboration diagram for BESDataResponseHandler:

Public Member Functions
	BESDataResponseHandler (const std::string &name)
virtual void	dump (std::ostream &strm) const
	dumps information about this object
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 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

Static Public Member Functions
static BESResponseHandler *	DataResponseBuilder (const std::string &name)

Protected Attributes
std::string	d_annotation_service_url
std::string	d_response_name
BESResponseObject *	d_response_object = nullptr

Detailed Description

response handler that builds an OPeNDAP Data DDS object

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.

As for BESDap4ResponseHandler, this redirects accesses to the DMR++ handler when DMR++ responses exist in the MDS for the given item in the container. Control this using BES.Use.Dmrpp and BES.Dmrpp.Name as for BESDap4ResponseHandler.

See also

DDS

BESContainer

BESTransmitter

BESDefine

BESDap4ResponseHandler

Definition at line 56 of file BESDataResponseHandler.h.

Constructor & Destructor Documentation

BESDataResponseHandler()

BESDataResponseHandler::BESDataResponseHandler

(

const std::string &

name

)

Definition at line 55 of file BESDataResponseHandler.cc.

~BESDataResponseHandler()

BESDataResponseHandler::~BESDataResponseHandler ( void )

virtual

Definition at line 62 of file BESDataResponseHandler.cc.

Member Function Documentation

DataResponseBuilder()

BESResponseHandler * BESDataResponseHandler::DataResponseBuilder ( const std::string & name )

static

Definition at line 184 of file BESDataResponseHandler.cc.

dump()

void BESDataResponseHandler::dump ( std::ostream & strm ) const

virtual

dumps information about this object

Displays the pointer value of this instance

Parameters

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

Implements BESObj.

Definition at line 175 of file BESDataResponseHandler.cc.

execute()

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.

Parameters

dhi	structure that holds request and response information

See also

BESDataHandlerInterface

BESDataDDSResponse

BESRequestHandlerList

BESDefine

Implements BESResponseHandler.

Definition at line 80 of file BESDataResponseHandler.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 62 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

o	new response object used to replace the current one

Returns

the response object being replaced

See also

BESResponseObject

Definition at line 68 of file BESResponseHandler.cc.

transmit()

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.

Parameters

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

See also

BESDataDDSResponse

BESTransmitter

BESDataHandlerInterface

Implements BESResponseHandler.

Definition at line 162 of file BESDataResponseHandler.cc.

Member Data Documentation

d_annotation_service_url

std::string BESResponseHandler::d_annotation_service_url

protectedinherited

Definition at line 82 of file BESResponseHandler.h.

d_response_name

std::string BESResponseHandler::d_response_name

protectedinherited

Definition at line 79 of file BESResponseHandler.h.

d_response_object

BESResponseObject* BESResponseHandler::d_response_object = nullptr

protectedinherited

Definition at line 80 of file BESResponseHandler.h.

---

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

• BESDataResponseHandler.h
• BESDataResponseHandler.cc