BESDMRResponseHandler Class Reference

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

#include <BESDMRResponseHandler.h>

Inheritance diagram for BESDMRResponseHandler:

Collaboration diagram for BESDMRResponseHandler:

Public Member Functions
	BESDMRResponseHandler (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 type-"dmr" 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 using the specified transmitter object

Static Public Member Functions
static BESResponseHandler *	DMRResponseBuilder (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 DMR response object

A request 'get dmr 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 DMR response object. It then transmits the DMR object using the method send_das on the specified transmitter object.

See also

DMR

BESContainer

BESTransmitter

Definition at line 50 of file BESDMRResponseHandler.h.

Constructor & Destructor Documentation

BESDMRResponseHandler()

BESDMRResponseHandler::BESDMRResponseHandler

(

const std::string &

name

)

Definition at line 52 of file BESDMRResponseHandler.cc.

~BESDMRResponseHandler()

BESDMRResponseHandler::~BESDMRResponseHandler ( )

virtual

Definition at line 57 of file BESDMRResponseHandler.cc.

Member Function Documentation

DMRResponseBuilder()

BESResponseHandler * BESDMRResponseHandler::DMRResponseBuilder ( const std::string & name )

static

Definition at line 204 of file BESDMRResponseHandler.cc.

dump()

void BESDMRResponseHandler::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 195 of file BESDMRResponseHandler.cc.

execute()

void BESDMRResponseHandler::execute ( BESDataHandlerInterface & dhi )

virtual

executes the command <get type-"dmr" definition="..">

For each container in the specified definition go to the request handler for that container and have it add to the OPeNDAP DMR response object. The DMR response object is built within this method and passed to the request handler list.

Note

This ResponseHandler does not work for multiple containers when using the Global Metadata Store.

Parameters

dhi	structure that holds request and response information

See also

BESDataHandlerInterface

BESDMRResponse

BESRequestHandlerList

Implements BESResponseHandler.

Definition at line 78 of file BESDMRResponseHandler.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 BESDMRResponseHandler::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_dmr 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

BESDMRResponse

BESTransmitter

BESDataHandlerInterface

Implements BESResponseHandler.

Definition at line 182 of file BESDMRResponseHandler.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:

• BESDMRResponseHandler.h
• BESDMRResponseHandler.cc